Quer estejamos usando Vim, Sublime Text, Textmate, Emacs ou qualquer outro editor, uma coisa devemos tomar cuidado, convenção de codificação consistente. Se você está codificando Ruby, é melhor usar dois espaços e para javascripts é melhor usar quatro espaços.
Resumindo, siga as convenções de código padrão para cada idioma que você escrever. Seguir os padrões é melhor para você, para sua produtividade e para o desenvolvimento colaborativo.
Mas, como podemos tornar um grupo de editores consistente? Cada editor tem sua própria configuração e devo dizer às pessoas para seguir as convenções manualmente? ou alguma maneira melhor de fazer isso?
Sim, você está seguro agora. Obrigado pelo projeto editorconfig . Este projeto salva nossa vida. Por quê?
Em vez de dizer às pessoas para mudarem de configuração e bla bla bla. Você pode criar um .editorconfig
arquivo dentro do diretório do projeto. Aqui está o exemplo:
# .editorconfig
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
[*.markdown]
indent_size= 4
trim_trailing_whitespace = false
[*.{js,php}]
indent_size= 4
Com .editorconfig
acima, todos os arquivos dentro do diretório do projeto, será de dois espaços por padrão, exceto para .markdown
, .js
e .php
que use quatro espaços.
Coloque o .editorconfig
na raiz do diretório do projeto. Em seguida, instale o plugin editorconfig para o seu editor. Contanto que os editores tenham o plugin instalado, ele tornará seus códigos mais consistentes.