Guia de estilo de codificação para aplicativos node.js. [fechadas]

Existe um (ou vários) guia de estilo de codificação para node.js? Caso contrário, quais são os estilos emergentes usados ​​pelos principais projetos de nós de código aberto?

Estou procurando um guia (ou vários guias) ao longo das linhas do PEP 8 , o Guia de Estilo de Codificação canônico para Python. Vi vários guias JavaScript que não valem a pena vincular aqui (principalmente antigos e direcionados ao JavaScript do cliente). Encontrei um guia de estilo node.js interessante .

Um guia de estilo de codificação, ou convenções de codificação, deve incluir (mas não está limitado a):

• Layout do código: recuo (2 espaços, 4 espaços, guias, ...), novas linhas, quebras de linha, etc.
• Espaço em branco, por exemplo, "function (arg)" vs. "function (arg)"
• Ponto e vírgula ou nenhum ponto e vírgula, declaração var, ...
• Nomear, por exemplo, do_this () vs. doThis (), var_name vs. varName, ...
• node.js e idiomas JavaScript, por exemplo, == vs. ===, o primeiro argumento do retorno de chamada é um objeto de erro, ...
• Comentários e documentação
• Ferramentas de acompanhamento, como verificador de cotão, estrutura de teste de unidade, ...

Esse tópico obviamente é altamente subjetivo, mas acho que é uma etapa importante da comunidade estabelecer um estilo de codificação comum e amplamente aceito no processo de amadurecimento. Além disso, não se trata apenas de gosto. Em particular, regras como "use === em vez de ==" influenciam diretamente a qualidade do código.

Eu revisaria os padrões de codificação verificados pelo JSLint ou examinaria o autor dos padrões de codificação do NPM (Isaac Shlueter) .

Você também pode observar o estilo usado pelos notáveis ​​codificadores 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 + você pode olhar a base de código Node.JS real

Vou jogar o meu lá por uma boa medida;)

Edit: Sugestões de @alienhard

• Guia de estilo do Google JavaScript
• Guia de estilo do Node.js de Felix

Na IMO, existem algumas regras de ouro que você deve seguir:

• Nunca use withoueval
• Use ===sobre==
• Sempre declare suas variáveis varno escopo apropriado - não faça fallback no escopo global
• Encerre seu aplicativo em um encerramento (function(){})()se você planeja liberar código que é executado no servidor e no navegador
• Os errretornos de chamada devem ser usados como o primeiro argumento e, se eles mesmos receberem um retorno de chamada como argumento, deve ser o último, por exemplocallback(err, param1, param2, callback)

Recuo, espaçamento entre chaves e palavras-chave e posicionamento de ponto e vírgula são todos uma questão de preferência.

Há um novo padrão na cidade.

Use estilo padrão .

Você pode aprender muitas boas práticas de estilo de codificação nos guias JavaScript orientados para o cliente (a maioria se aplica também ao node.js em geral, pois a diferença entre o cliente e o servidor está principalmente nas bibliotecas e não na própria linguagem). Por exemplo, o livro JavaScript Patterns dedica a este tópico algumas partes do capítulo 2 . Também o site , livro e vídeos de Douglas Crockford são materiais obrigatórios para adotar estilos de codificação específicos do JavaScript e práticas recomendadas, eu diria.

Ao usar o nó do terminal, é útil para o seu código-fonte usar espaços para recuo. Caso contrário, o cursor de "erro aqui" não será alinhado.

Com guias:

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

Com espaços:

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

Esse pode ser um problema exclusivo do Mac, mas eu suspeitaria que não.

Já faz um tempo desde que fiz essa pergunta ... e, enquanto isso, encontrei este excelente guia JavaScript:

Princípios para escrever JavaScript consistente e linguístico

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

O Airbnb tem um bom guia de estilo Javascript https://github.com/airbnb/javascript

Para Coffee-Script, em que recuos incorretos significam erros de compilação

usar

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

projectos de café populares, zombie,brunch usa esta configuração para irregularidades.

Editar:

Na verdade, basta usar isso! https://github.com/paulmillr/code-style-guides (um dos principais colaboradores brunch)