Coding Style Guide für node.js Apps? [geschlossen]

Gibt es einen (oder mehrere) Codierungsstil-Leitfaden für node.js? Wenn nicht, welche neuen Stile werden von den Top-Open-Source-Knotenprojekten verwendet?

Ich suche einen Leitfaden (oder mehrere Anleitungen) nach dem Vorbild von PEP 8 , dem kanonischen Coding Style Guide für Python. Ich habe verschiedene JavaScript-Anleitungen gesehen, die es nicht wert sind, hier verlinkt zu werden (meistens alt und auf clientseitiges JavaScript ausgerichtet). Ich fand eine interessante node.js Style Guide .

Ein Coding Style Guide oder Codierungskonventionen sollte Folgendes enthalten (ist aber nicht darauf beschränkt):

• Codelayout: Einrückung (2 Leerzeichen, 4 Leerzeichen, Tabulatoren, ...), Zeilenumbrüche, Zeilenumbrüche usw.
• Leerzeichen, z. B. "Funktion (arg)" vs. "Funktion (arg)"
• Semikolon oder kein Semikolon, Var-Deklaration, ...
• Benennen, z. B. do_this () vs. doThis (), var_name vs. varName, ...
• node.js und JavaScript-Redewendungen, z. B. == vs. ===, das erste Argument des Rückrufs ist ein Fehlerobjekt, ...
• Kommentare und Dokumentation
• Begleitende Tools wie Flusenprüfer, Unit-Test-Framework, ...

Dieses Thema ist natürlich sehr subjektiv, aber ich denke, es ist ein wichtiger Schritt einer Community, einen gemeinsamen und allgemein akzeptierten Codierungsstil zu etablieren, um reifer zu werden. Es geht auch nicht nur um Geschmack. Insbesondere Regeln wie "use === anstelle von ==" haben direkten Einfluss auf die Codequalität.

Ich würde die von JSLint überprüften Codierungsstandards überprüfen oder mir den Autor der NPM - Codierungsstandards (Isaac Shlueter) ansehen .

Sie können sich auch den Stil ansehen, der von namhaften Node.JS-Codierern verwendet wird:

• TJ Holowaychuk
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendörfer
• Charlie Robbins
• Marak Knappen
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + Sie können sich die aktuelle Node.JS-Codebasis ansehen

Ich werfe meine für ein gutes Maß hinein;)

Edit: Vorschläge von @alienhard

• Google JavaScript Style Guide
• Felix's Node.js Style Guide

IMO gibt es ein paar goldene Regeln, denen Sie folgen sollten:

• Niemals benutzen withodereval
• Verwenden Sie ===über==
• Deklarieren Sie Ihre Variablen immer varim entsprechenden Bereich - greifen Sie nicht auf den globalen Bereich zurück
• Schließen (function(){})()Sie Ihre App in einen Abschluss ein, wenn Sie Code veröffentlichen möchten, der sowohl serverseitig als auch im Browser ausgeführt wird
• Rückrufe sollten errals erstes Argument verwendet werden, und wenn sie selbst einen Rückruf als Argument verwenden, sollte dies das letzte sein, zcallback(err, param1, param2, callback)

Einrückung, Abstand zwischen geschweiften Klammern und Schlüsselwörtern sowie Semikolonplatzierung sind bevorzugt.

Es gibt einen neuen Standard in der Stadt.

Verwenden Sie den Standardstil .

In clientseitig orientierten JavaScript-Handbüchern können Sie viele gute Methoden für den Codierungsstil lernen (die meisten davon gelten im Allgemeinen auch für node.js, da der Unterschied zwischen Client- und Serverseite hauptsächlich in Bibliotheken und nicht in der Sprache selbst liegt). Das JavaScript- Musterbuch widmet diesem Thema beispielsweise einige Teile des Kapitels 2 . Auch die Website , das Buch und die Videos von Douglas Crockford sind ein Muss, um JavaScript-spezifische Codierungsstile und Best Practices zu übernehmen, würde ich sagen.

Wenn Sie einen Knoten vom Terminal aus verwenden, ist es für Ihren Quellcode hilfreich, Leerzeichen zum Einrücken zu verwenden. Andernfalls wird das Caret "Fehler hier" nicht angezeigt.

Mit Registerkarten:

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

Mit Leerzeichen:

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

Dies könnte nur ein Mac-Problem sein, aber ich würde es nicht vermuten.

Es ist eine Weile her, seit ich diese Frage gestellt habe ... und in der Zwischenzeit habe ich diesen ausgezeichneten JavaScript-Leitfaden gefunden:

Prinzipien des Schreibens Konsistentes, idiomatisches JavaScript

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

Airbnb hat einen recht guten Javascript-Styleguide https://github.com/airbnb/javascript

Für Coffee-Script bedeutet ein schlechter Einzug Kompilierungsfehler

verwenden

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

beliebte Kaffeeprojekte zombie, brunchverwendet diese Einrichtung für Vertiefungen.

Bearbeiten:

Verwenden Sie dies einfach! https://github.com/paulmillr/code-style-guides (einer der Hauptverantwortlichen für brunch)