Tipurile fișierelor importate ar trebui să reflecte atributele

Tipul unui fișier importat ar trebui să descrie valoarea pe care mediul de execuție o furnizează pentru atributele de import alese. Extensia numelui poate constitui un contract prea slab. Suportul pentru atribute în declarațiile ambientale din TypeScript 7.1 Beta justifică reanalizarea declarațiilor acolo unde atributele schimbă structura valorii. Suportul la execuție rămâne o responsabilitate separată.

Retrospectiva din noiembrie revine asupra discuției din jurul săptămânii de 21 octombrie. Anunțul beta este datat 20 octombrie. Descrie declarații care țin cont de atributele de import și avertizează că potrivirea cu o declarație ambientală nu verifică existența fișierului. Lipsa fișierului poate produce eroare la împachetare sau la execuție. Este o dovadă despre versiunea beta, nu despre o lansare stabilă.

Anunțul trimite la cererea de integrare a implementării. Reperul contemporan relevant este anunțul beta datat. Pentru articol nu a fost folosit un compilator sau un instrument de împachetare instalat și nicio declarație nu este prezentată drept configurație de proiect testată.

Valoarea definește contractul

O declarație de tip este utilă când îl ajută pe apelant să facă următoarea operație corectă. Dacă apelantul așteaptă un șir de caractere, descrierea unui alt obiect nu devine utilă doar pentru că se potrivește numelui de fișier. Raționamentul este valabil și invers. Declarația ar trebui să reflecte interpretarea aleasă pentru fișier, inclusiv condițiile care o selectează.

Anunțul beta ilustrează diferența prin CSS: comportamentul implicit CSS Modules al unui instrument de împachetare poate diferi de importul cu type: "css" care produce un CSSStyleSheet. Atributul participă la alegerea structurii valorii. Presupunerea bazată doar pe extensie poate ascunde diferența, deși ambele importuri privesc conținut CSS. Este descrierea exemplului din anunț, nu o promisiune despre toate instrumentele de împachetare.

Pentru mentenanță, unitatea utilă cuprinde fișierul, comportamentul de încărcare selectat și codul consumator. Dacă analiza se oprește la declarație, proiectul poate părea coerent fără să explice presupunerea despre încărcare. Dacă se oprește la încărcare, codul consumator poate rămâne cu o descriere înșelătoare. Acordul trebuie să traverseze această limită.

Declarațiile și livrarea dovedesc lucruri diferite

Declarațiile ambientale spun sistemului de tipuri ce poate presupune despre un modul. Ele nu includ fișierul în versiunea livrată și nu implementează componenta care îl interpretează. O analiză de mentenanță ar trebui să păstreze separarea, deoarece ea stabilește ce dovezi răspund fiecărei întrebări. Acceptarea tipului și livrarea reușită sunt obiective legate, cu cerințe de demonstrare diferite.

Începeți prin descrierea valorii de care are nevoie aplicația. Identificați apoi mediul acceptat care o produce și atributele care selectează comportamentul. Numai după aceea poate fi evaluată declarația față de contractul real. Inversarea ordinii încurajează tratarea unui tip convenabil drept permisiune de a presupune o capacitate a mediului de execuție.

Consecința de afaceri este o predare mai clară. Următorul responsabil ar trebui să poată stabili dacă problema fișierului ține de declarație, de împachetare sau de încărcarea la execuție. Dacă responsabilitățile sunt comprimate într-o afirmație că importul este acceptat, o schimbare mică poate cere redescoperirea întregului traseu înainte să se știe unde trebuie căutată problema.

Claritatea nu implică economii măsurate la livrare. Dovezile de aici stabilesc o capacitate a instrumentelor limbajului și limitele declarate. Nu stabilesc frecvența neconcordanțelor într-un produs, durata diagnosticării lor sau economia adusă de adoptare. Aceste concluzii ar cere dovezi din istoricul de mentenanță al produsului.

O extensie poate fi suficientă

Contraargumentul cel mai puternic este proiectul în care instrumentul de împachetare asociază consecvent fiecărei extensii o singură structură de valoare. În acel mediu, declarația bazată pe extensie poate descrie deja corect contractul. Introducerea unor declarații mai expresive doar fiindcă versiunea beta le permite poate adăuga muncă fără a rezolva o ambiguitate reală.

Limita este legitimă. Recomandarea se aplică acolo unde atributele influențează interpretarea sau declarația existentă nu descrie mediul acceptat. Nu cere înlocuirea tuturor declarațiilor bazate pe extensie. O propunere de mentenanță ar trebui să identifice neconcordanța rezolvată înainte să recomande o migrare mai amplă.

Chiar și o convenție consecventă are nevoie de un responsabil clar. Dacă proiectul se bazează doar pe extensie, explicați aceasta ca proprietate a configurației acceptate de împachetare. Dacă adaugă ulterior un mediu, reanalizați valabilitatea convenției. O simplificare locală rămâne utilă când condițiile sale rămân vizibile; devine înșelătoare când este promovată tacit la rang de regulă universală a limbajului.

Adoptați pentru un mediu explicit

Versiunea citată fiind beta, adoptarea ar trebui să fie o decizie separată a proiectului. Argumentul articolului poate îmbunătăți descrierea contractului actual fără a cere migrarea imediată a compilatorului. O descriere precisă a încărcării și valorilor așteptate este utilă indiferent dacă noua capacitate este adoptată acum sau analizată ulterior.

O verificare ulterioară a implementării ar avea nevoie de dovezi din combinația acceptată de compilator, instrument de împachetare și mediu de execuție. Ar trebui să separe prezența fișierului de potrivirea tipului și să descrie valoarea consumată efectiv de aplicație. Articolul nu oferă un exemplu TypeScript executabil, deoarece sintaxa netestată ar adăuga puțin argumentului despre responsabilități.

Mentenanța software ar trebui să facă importul inteligibil la utilizare. Aliniați valoarea declarată cu atributele selectate, păstrați convențiile simple bazate pe extensie când sunt corecte și cereți dovezi separate pentru existența fișierului și suportul încărcării. O verificare de tip reușită ar trebui să însemne exact cât permit dovezile sale.