Guida allo stile di codifica per le app node.js? [chiuso]

Esiste una (o più) guida di stile di codifica per node.js? In caso contrario, quali sono gli stili emergenti utilizzati dai principali progetti di nodi open source?

Sto cercando una guida (o diverse guide) sulla falsariga di PEP 8 , la guida canonica di stile di codifica per Python. Ho visto varie guide JavaScript non degne di essere collegate qui (per lo più vecchie e mirate al JavaScript lato client). Ho trovato un interessante node.js guida di stile .

Una guida allo stile di codifica, o convenzioni di codifica, dovrebbe includere (ma non è limitato a):

• Layout del codice: rientro (2 spazi, 4 spazi, tabulazioni, ...), newline, interruzioni di riga, ecc.
• Spazio bianco, ad es. "Funzione (arg)" vs. "funzione (arg)"
• Punto e virgola o nessun punto e virgola, dichiarazione var, ...
• Denominazione, ad esempio, do_this () vs. doThis (), var_name vs. varName, ...
• idiomi node.js e JavaScript, ad esempio == vs. ===, il primo argomento di callback è un oggetto errore, ...
• Commenti e documentazione
• Strumenti di accompagnamento, come controllore lanugine, framework di test unitari, ...

Questo argomento ovviamente è altamente soggettivo, ma penso che sia un passo importante di una comunità stabilire uno stile di codifica comune e ampiamente accettato nel processo di maturazione. Inoltre, non si tratta solo di gusto. In particolare, regole come "use === anziché ==" hanno un'influenza diretta sulla qualità del codice.

Esaminerei gli standard di codifica controllati da JSLint o guarderei l'autore degli standard di codifica NPM (Isaac Shlueter) .

Potresti anche guardare lo stile usato dai notevoli programmatori Node.JS:

• TJ Holowaychuk
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendörfer
• Charlie Robbins
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + potresti vedere l'attuale base di codice Node.JS

Io butto il mio lì dentro per buona misura;)

Modifica: suggerimenti di @alienhard

• Guida di stile JavaScript di Google
• Guida allo stile Node.js di Felix

IMO ci sono alcune regole d'oro che dovresti seguire:

• Non usare mai withoeval
• Utilizzare ===oltre==
• Dichiarare sempre le variabili con varnell'ambito appropriato - non ricadere nell'ambito globale
• Avvolgi la tua app in una chiusura (function(){})()se prevedi di rilasciare il codice che viene eseguito sul lato server e nel browser
• I callback dovrebbero prendere errcome primo argomento e se essi stessi prendono un callback come argomento, dovrebbe essere l'ultimo, ad escallback(err, param1, param2, callback)

Rientro, spaziatura tra parentesi graffe e parole chiave e posizionamento punto e virgola sono tutti una questione di preferenza.

C'è un nuovo standard in città.

Usa lo stile standard .

Puoi imparare molte buone pratiche di stile di codifica dalle guide JavaScript orientate al lato client (la maggior parte si applica anche a node.js in generale poiché la differenza tra lato client e lato server è principalmente nelle librerie e non nel linguaggio stesso). Ad esempio il libro JavaScript Patterns dedica a questo argomento alcune parti del capitolo 2 . Anche il sito web , il libro e i video di Douglas Crockford sono assolutamente da vedere per poter adottare stili di codifica e best practice specifici di JavaScript, direi.

Quando si utilizza il nodo dal terminale, è utile che il codice sorgente utilizzi gli spazi per il rientro. In caso contrario, il cursore "Errore qui" non si allinea.

Con le schede:

        var preps = files.map(function(f) { 
            ^
TypeError: Cannot call method 'map' of null

Con spazi:

        var preps = files.map(function(f) { 
                          ^
TypeError: Cannot call method 'map' of null

Questo potrebbe essere un problema solo per Mac, ma sospetto di no.

È da un po 'che non faccio questa domanda ... e intanto ho trovato questa eccellente guida JavaScript:

Principi di scrittura coerente, JavaScript idiomatico

https://github.com/rwldrn/idiomatic.js/

Airbnb ha una guida di stile Javascript abbastanza buona https://github.com/airbnb/javascript

Per Coffee-Script, dove cattivi rientri significa errori di compilazione

uso

:set tabstop=2
:set shiftwidth=2
:set expandtab

popolari progetti di caffè zombie, brunchutilizza questa configurazione per i rientri.

Modificare:

In realtà, usa questo! https://github.com/paulmillr/code-style-guides (uno dei principali collaboratori di brunch)