Guide de Style de codage node.js apps ?

Question

Est-il un (ou plusieurs) de codage guide de style pour node.js? Si non, quelles sont les émergents styles utilisés par les plus grands open-source nœud projets?

Je suis à la recherche d'un guide (ou plusieurs guides) le long de la lignes de la PEP 8, le Codage canonique Guide de Style pour Python. J'ai vu plusieurs JavaScript guides n'en vaut pas la liaison ici (surtout des vieux et ciblée à JavaScript côté client). Je l'ai trouvé intéressant node.js guide de style.

Un style de codage guide, ou des conventions de codage doit inclure (mais ne sont pas limités à):

• La disposition du Code: l'indentation (2 places, 4 places, onglets, ...), les retours à la ligne, saut de ligne, etc.
• Espaces, par exemple, "fonction (arg)" vs "fonction(arg)"
• Point-virgule ou pas de point-virgule, var déclaration, ...
• De nommage, par exemple, do_this() vs suivre(), var_name vs varName, ...
• node.js et JavaScript idiomes, par exemple, == vs ===, la fonction de rappel du premier argument est un objet d'erreur, ...
• Les commentaires et la documentation
• Accompagnement d'outils, comme les peluches checker, unit test framework, ...

Ce sujet est évidemment très subjectif, mais je pense que c'est une étape importante d'une communauté à établir d'un commun et largement acceptée style de codage dans le processus d'obtention de la maturité. Aussi, il n'est pas juste question de goût. En particulier, des règles comme "use === au lieu de==", ont une influence directe sur la qualité du code.

Answer 1

J'aimerais revoir les normes de codage vérifié par JSLint ou de regarder l'auteur de MNP (Isaac Shlueter) les normes de codage.

Vous pouvez consulter également le style utilisé par des notables Node.JS codeurs:

• TJ Holowaychuck
• Isaac Shlueter
• Tim Caswell
• Jeremy Ashkenas
• Felix Geisendörfer
• Charlie Robbins
• Marak Squires
• Aaron Heckmann
• Guillermo Rauch
• Mikeal Rogers
• Ryan Dahl + vous pouviez regarder le réel Node.JS la base de code

Je vais jeter la mienne là-bas pour faire bonne mesure ;)

Edit: Suggestions de @alienhard

• Google JavaScript Guide de style
• Felix Node.js Guide de Style

IMO il y a quelques règles d'or à suivre:

• N'utilisez jamais d' with ou eval
• Utiliser === sur ==
• Toujours déclarer vos variables avec var dans le champ d'application approprié - ne pas le secours de la portée mondiale
• Enveloppez votre application dans une closure (function(){})() si vous prévoyez sur la libération de code qui s'exécute côté serveur ainsi que dans le navigateur
• Les rappels doivent prendre en err comme premier argument et si elles prennent un rappel comme argument, elle devrait être la dernière, par exemple, callback(err, param1, param2, callback)

L'Indentation, l'espacement entre les accolades et les mots clés et le point-virgule de placement sont une question de préférence.

Answer 2

Vous pouvez apprendre beaucoup de bon style de codage des pratiques de côté client JavaScript orientée guides (la plupart s'appliquent également à node.js en général, puisque la différence entre le client et côté serveur est la plupart du temps dans les bibliothèques et non pas dans la langue elle-même). Par exemple JavaScript Modèles de livre consacre à ce sujet certaines parties du Chapitre 2. Aussi Douglas Crockford du site web, livre et vidéos sont un must matériaux afin d'adopter JavaScript codage spécifique des styles et des meilleures pratiques, je dirais.

Answer 3

Lorsque vous utilisez le nœud à partir du terminal, il est utile de votre code source à utiliser les espaces d’indentation. Dans le cas contraire, l’accent circonflexe « erreur ici » ne sera pas alignées.

Avec les onglets :

Avec des espaces :

C’est peut-être une question seulement de Mac, mais je pense pas.

Answer 4

Il a été un moment depuis que j’ai posé cette question... et en attendant, j’ai trouvé cet excellent guide JavaScript :

Principes d’écriture cohérente et idiomatique JavaScript

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

Answer 5

Pour café-Script, où tirets mal signifie que des erreurs de compilation

utilisation

projets de café populaire, , utilise cette configuration pour les empreintes.

Edit :

En fait, il suffit d’utiliser ceci ! https://github.com/paulmillr/code-style-guides (un des principaux contributeurs au `` )