Padronizando Código — EditorConfig
Usando o editorConfig para indentar melhor seu código.
Definir um padrão é muito difícil, e na maioria das vezes entramos em projetos legados que torna ainda mais difícil escrever em algum padrão, e depois vem questões como frameworks e linguagens de programação, mas não precisamos definir tudo de início, a padronização é algo que vamos construindo aos poucos e por isso hoje vou apresentar o editorConfig.
Com o editorConfig definimos as métricas independente da linguagem e com isso, mesmo que alguém da equipe use uma IDE diferente, o código terá a mesma indentação em outras IDE.
EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.
Instalação
Para instalar o .editorConfig basta acessar a página de download e escolher sua IDE, mas para alguns editores é ainda mais fácil, como no caso do vscode, basta acessar a página de plugins e digitar editorConfig e pronto a sua IDE já está compatível.
Modo de usar
Agora que sua IDE já está configurada, é só criar um arquivo na raiz do projeto com o nome de .editorconfig e adicionar suas configurações nele.
No vscode o plugin do EditorConfig oferecer uma opção de geração automática do arquivo. Basta clicar com o botão direito do mouse em um espaço vazio da área de arquivos e em Generate .editorConfig
- root: Definir o arquivo como padrão para todo o projeto;
- [*]: Cria um grupo, do qual todos terão o mesmo padrão (no lugar de * pode colocar a extensão de sua linguagem, ex.: *.php ou *.js e etc);
- indent_style: Indentação usando espaços ou tab;
- indent_size: define a quantidade de espaços;
- charset: charset padrão dos arquivos;
- trim_trailing_whitespace: Deve ou não apagar espaços em branco no final de cada linha;
- insert_final_newline: Deve ou não inserir uma linha em branco ao final de cada arquivo.
Mais informações
Para mais informações acesse o site oficial
Obrigado por ler!
Se você tiver alguma dúvida, reclamação ou dica, pode deixar aqui nos comentários. Vou ter o maior prazer em responder!
😊😊 Até mais! 😊😊
