Come evitare tipici "errori linguistici dinamici"?

Attualmente sto rifattendo diverse migliaia di righe di codice su un grande progetto AngularJS. Uno dei problemi più grandi è quello di capire il contratto esatto di una determinata funzione. A volte ho finito per leggere la documentazione dell'API perché elementi della risposta API grezza venivano assegnati a variabili passate attraverso 6 strati di codice prima di essere modificati e restituiti attraverso altri 6 livelli di codice.

Il mio primo consiglio è di design per contratto . Prendi input specifici, produci output specifici, evita gli effetti collaterali e documenta quelle aspettative usando TypeScript o almeno JSDoc.

Il mio secondo consiglio è di implementare quanti più controlli possibili. Seguiamo lo standard AirBnB e usiamo eslint sull'intera nostra base di codice. I ganci di commit verificano che seguiamo sempre lo standard. Abbiamo naturalmente una batteria di unità e test di accettazione, e tutti i commit devono essere esaminati da un pari.

Passare da un editor di testo (Sublime Text) a un IDE corretto (WebStorm) ha reso anche molto più semplice lavorare con il codice in generale. WebStorm utilizzerà JSDoc per fornire suggerimenti sui tipi di parametri previsti e generare un errore se si fornisce il tipo sbagliato o si utilizza il valore restituito nel modo sbagliato.

In JavaScript, le nuove funzionalità come simboli e getter / setter possono aiutare a rafforzare un certo livello di qualità aggiungendo asserzioni all'assegnazione delle variabili (ad esempio, assicurati che il numero intero sia compreso nell'intervallo o che l'oggetto dati abbia determinati attributi). / p>

Sfortunatamente, non penso che esista una vera soluzione per evitare errori di linguaggio dinamici, solo una serie di misure che possono aiutare a ridurre la loro frequenza.

La mia risposta alla domanda "Come ti avvicini a un progetto JavaScript (o qualsiasi altro linguaggio dinamico) con ~ 2000 LOC?"

Sviluppo applicazioni per moduli PDF. Mi avvicino al mio progetto di sviluppo di software JavaScript (indipendentemente dalle dimensioni del codice sorgente) utilizzando gli elementi e le annotazioni della rete di Petri. Il metodo non è legato ad alcuna particolare tecnologia del linguaggio di programmazione. Pertanto può essere utilizzato per altri "linguaggi di programmazione".

Creo un diagramma della logica dell'applicazione. Per mantenere il diagramma in ordine, aggiungo la maggior parte delle mie annotazioni a un modulo che uso con il diagramma. Le voci nel modulo includono riferimenti a proprietà o funzioni. Quindi scrivo il codice sorgente in base alle informazioni nel diagramma e alle voci nel modulo. Il metodo è sistematico perché ogni codice sorgente scritto è direttamente mappato dal diagramma e dalle voci nel modulo. Il codice sorgente può essere facilmente controllato perché seguo anche le convenzioni di denominazione e codifica quando scrivo il codice.

Ad esempio, ho scelto una convenzione per cui tutte le funzioni sono prototipi. Se le prestazioni diventano un problema, può essere migliorato dichiarando le funzioni nel costruttore. Per alcune proprietà uso array. Ancora una volta se le prestazioni diventano un problema, allora può essere migliorato usando i riferimenti diretti.

Uso anche eval. Questo può ridurre notevolmente la dimensione del codice sorgente. A causa di problemi di prestazioni, utilizzo eval nella parte iniziale o di inizializzazione della mia applicazione; Non lo uso mai nella "logica di runtime" - questa è un'altra convenzione di codifica che seguo.