Kaip kaupiami TODO virsta technine skola (ir mano atvirojo kodo įrankiu jai valdyti)

Programinės įrangos kūrimo pasaulyje kiekvienas kūrėjas yra susipažinęs su patikimu TODO komentaru. Jis dažnai naudojamas kaip greitas priminimas, kad vėlesniame etape reikia pakartotinai peržiūrėti kodą, perdaryti arba atlikti užduotį. Tačiau laikui bėgant šie TODO komentarai gali kauptis ir tapti tyliomis techninių skolų sankaupomis – paslėpta našta, kuri gali turėti įtakos projekto sveikatai ir techninei priežiūrai.

Jei nepažymėti, šie išsibarstę priminimai gali apsunkinti kodų bazę, todėl kūrėjams bus sunkiau naršyti, derinti ir išplėsti. Savo darbe aš susidūriau su šia problema iš pirmų lūpų ir galiausiai nusprendžiau ją išspręsti naudodamas įrankį, kuris padaro techninę skolą matomą ir veiksmingą: Todoctor .

Paslėpta TODO komentarų problema

Iš pradžių TODO komentaras gali atrodyti nekenksmingas ar net naudingas. Tai signalas kūrėjams ką nors peržiūrėti – galbūt optimizuoti algoritmą, pertvarkyti sudėtingą skyrių, pakeisti pasenusią priklausomybę arba užbaigti vis dar vykdomą funkciją. Tačiau dėl įtempto grafiko, besikeičiančių prioritetų ir griežtų terminų šie TODO dažnai atidedami neribotam laikui. Užuot į juos kreiptasi, jie tampa neišspręstų dalykų artefaktais.

Laikui bėgant, TODO komentarai gali sukelti keletą problemų:

• Nematoma techninė skola : TODO komentarų sankaupa sukuria iliuziją, kad kodas yra gerai prižiūrimas, o iš tikrųjų jis slepia neužbaigtas užduotis ir neišspręstas problemas.
• Sumažėjusi kodo kokybė : Neatsižvelgus į šiuos komentarus gali atsirasti klaidų, sunkiai prižiūrimo kodo ir netikėto elgesio.
• Konteksto praradimas : Laikui bėgant kūrėjai gali pamiršti kiekvieno TODO tikslą, ypač kai komandos nariai ateina ir išeina. Tai veda prie didėjančio kodo ir komandos supratimo apie jį atotrūkio.

Didesniuose projektuose arba projektuose, kuriuose dalyvauja keli dalyviai, problema tik didėja. Be reguliaraus dėmesio TODO gali būti išsklaidyti visoje kodų bazėje, todėl sunku valdyti ir sekti technines skolas.

Sprendimas: padarykite techninę skolą matomą su Todoctor

Spręsdamas šią problemą supratau, kad reikia įrankio, leidžiančio TODO komentarus iš slėptuvės iškelti į veiksmingą erdvę, kurioje komandos galėtų lengvai juos įvertinti ir spręsti. Dėl to buvo sukurta „Todoctor“ – CLI priemonė, skirta analizuoti ir sekti TODO komentarus „JavaScript“ ir „TypeScript“ kodų bazėse.

Naudodami „Todoctor“ kūrėjai ir komandos gali vizualizuoti ir valdyti savo technines skolas laikui bėgant, padėdami jiems priimti pagrįstus sprendimus dėl valymo ir pertvarkymo prioritetų. Štai kaip tai veikia:

• Nustatykite TODO viešosios interneto prieigos taškus: Todoctor nuskaito kodų bazę, kad surastų kiekvieną TODO komentarą, renka informaciją apie kiekvieno komentaro amžių, autorių ir turinį.
• Vizualizuokite techninę skolą : tada sugeneruojama ataskaita su diagrama, iliustruojančia, kaip laikui bėgant keitėsi TODO skaičius, todėl komandoms pateikiamas aiškus jų techninės skolos vaizdas.
• Skatinkite atskaitomybę : naudodami Todoctor galite sekti kiekvieno TODO amžių, pamatyti, kas jį sukūrė, ir peržiūrėti rūšiuojamą visų laukiančių užduočių sąrašą kodų bazėje.

Per šiuos rodiklius Todoctor techninę skolą paverčia matomu, valdomu projekto elementu. Šis skaidrumas gali paskatinti komandas imtis veiksmų, susijusių su išskirtinėmis užduotimis, ir padeda puoselėti kodo nuosavybės ir kokybės kultūrą.

Žvilgsnis į Todoctor techninį įgyvendinimą

„Todoctor“ buvo sukurta atsižvelgiant į paprastumą ir patogumą naudoti, todėl jį galima sklandžiai integruoti į bet kokią kūrimo darbo eigą. Įrankis parašytas „JavaScript“ ir veikia kaip CLI įrankis, todėl jį lengva nustatyti ir paleisti naudojant vieną komandą.

Kiekvienam TODO komentarui Todoctor renka metaduomenis, tokius kaip:

• Komentarų amžius : kiek laiko TODO buvo kodų bazėje.

• Bendras TODO skaičius : paprastas skaičiavimas, leidžiantis stebėti skolos dydį.

• Vidutinis TODO amžius : momentinė užduočių atlikimo trukmė.

• Geriausi bendradarbiai : sąrašas, kuriame rodoma, kurie komandos nariai sukūrė daugiausiai TODO , todėl komandos gali tęsti konkrečias užduotis.

  
  

Naudodamas šiuos duomenis, Todoctor sukuria išsamią HTML ataskaitą, kurią galima įtraukti į kodų bazę arba bendrinti su komanda.

Norėdami pradėti naudoti „Todoctor“, tiesiog įdiekite jį ir projekto šaknyje paleiskite šią komandą:

 npx todoctor

Per kelias sekundes „Todoctor“ išanalizuos jūsų kodų bazę ir sugeneruos ataskaitą, kuri suteiks jums visą techninės skolos vaizdą ir įžvalgas, kurias galima įgyvendinti.

Kodėl svarbu vizualizuoti techninę skolą

Techninė skola gali atrodyti kaip nedidelė problema, kol ji nepradės sulėtinti kūrimo ir paveikti kodo kokybę. TODO komentarai, nors ir naudingi trumpuoju laikotarpiu, gali lengvai tapti pamirštais įsipareigojimais, kuriuos galiausiai reikia išspręsti. Padarydamas šiuos priminimus matomus ir išmatuojamus, „Todoctor“ suteikia komandoms galimybę susigrąžinti savo kodų bazės kontrolę, užtikrinant, kad ji išliktų prižiūrima ir paruošta tolesniam augimui.

Išbandykite Todoctor :