Guía de estilo de codificación para aplicaciones node.js [cerrado]

¿Hay una (o varias) guías de estilo de codificación para node.js? Si no, ¿cuáles son los estilos emergentes utilizados por los principales proyectos de nodo de código abierto?

Estoy buscando una guía (o varias guías) en la línea de PEP 8 , la Guía de estilo de codificación canónica para Python. He visto varias guías de JavaScript que no vale la pena vincular aquí (en su mayoría antiguas y dirigidas a JavaScript del lado del cliente). Me pareció interesante Node.js guía de estilo .

Una guía de estilo de codificación, o convenciones de codificación, debe incluir (pero no se limita a):

• Diseño de código: sangría (2 espacios, 4 espacios, pestañas, ...), nuevas líneas, saltos de línea, etc.
• Espacio en blanco, por ejemplo, "función (arg)" vs. "función (arg)"
• Punto y coma o sin punto y coma, declaración var, ...
• Nombramiento, por ejemplo, do_this () vs. doThis (), var_name vs. varName, ...
• modismos de node.js y JavaScript, por ejemplo, == vs. ===, el primer argumento de devolución de llamada es un objeto de error, ...
• Comentarios y documentación
• Herramientas de acompañamiento, como el comprobador de pelusas, el marco de prueba de la unidad, ...

Este tema obviamente es muy subjetivo, pero creo que es un paso importante de una comunidad para establecer un estilo de codificación común y ampliamente aceptado en el proceso de maduración. Además, no se trata solo de sabor. En particular, las reglas como "use === en lugar de ==" tienen una influencia directa en la calidad del código.

Revisaría los estándares de codificación verificados por JSLint o miraría al autor de los estándares de codificación de NPM (Isaac Shlueter) .

También puede ver el estilo utilizado por los codificadores notables de 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 + podría mirar la base de código real de Node.JS

Voy a tirar la mía allí por si acaso;)

Editar: Sugerencias de @alienhard

• Guía de estilo de JavaScript de Google
• Felix's Node.js Style Guide

En mi opinión, hay algunas reglas de oro que debes seguir:

• Nunca use withoeval
• Usar ===sobre==
• Siempre declare sus variables con varel alcance apropiado; no recurra al alcance global
• Envuelva su aplicación en un cierre (function(){})()si planea lanzar un código que se ejecute tanto en el lado del servidor como en el navegador
• Las devoluciones de llamada deben tomar errcomo primer argumento y si ellos mismos toman una devolución de llamada como argumento, debería ser el último, por ejemplocallback(err, param1, param2, callback)

La sangría, el espacio entre llaves y palabras clave y la colocación de punto y coma son cuestiones de preferencia.

Hay un nuevo estándar en la ciudad.

Usar estilo estándar .

Puede aprender muchas buenas prácticas de estilo de codificación de las guías JavaScript orientadas al lado del cliente (la mayoría de ellas se aplican también a node.js en general, ya que la diferencia entre el lado del cliente y el servidor está principalmente en las bibliotecas y no en el lenguaje en sí). Por ejemplo, el libro Patrones de JavaScript dedica a este tema algunas partes del Capítulo 2 . También diría que el sitio web , el libro y los videos de Douglas Crockford son materiales imprescindibles para adoptar estilos de codificación específicos de JavaScript y las mejores prácticas.

Al usar el nodo desde la terminal, es útil que su código fuente use espacios para la sangría. De lo contrario, el cursor "error here" no se alineará.

Con pestañas:

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

Con espacios:

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

Esto podría ser un problema exclusivo de Mac, pero sospecho que no.

Ha pasado un tiempo desde que hice esta pregunta ... y mientras tanto he encontrado esta excelente guía de JavaScript:

Principios de escritura JavaScript coherente e idiomático

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

Airbnb tiene una muy buena guía de estilo Javascript https://github.com/airbnb/javascript

Para Coffee-Script, donde las sangrías incorrectas significan errores de compilación

utilizar

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

proyectos populares de café zombie, brunchutiliza esta configuración para hendiduras.

Editar:

En realidad, ¡solo usa esto! https://github.com/paulmillr/code-style-guides (uno de los principales contribuyentes a brunch)