Padronização de código, esse é um assunto que merece nossa atenção, afinal de contas, em um mundo onde o desenvolvimento colaborativo ganha cada vez mais força, temos desenvolvedores com paladares diferentes, ou seja, cada qual com seu leque de ferramentas favoritas. Essas ferramentas, em especial os editores de código, carregam seus conjuntos particulares de estilos, como indentar com Tab, 2 ou 4 espaços, incluir ou não linha em branco no final do arquivo ao salvar e assim por diante.
Esse comportamento imprevisível não é bom, isso quebra totalmente a padronização do código. Basicamente cada tecnologia (neste caso linguagem de programação) possui uma solução “particular” que resolve isso. Em um de meus posts anteriores apresentei o “Eslint com Prettier“, que na ocasião tinha como foco a linguagem JavaScript. Mas vós trago o EditorConfig um “plugin” independente da tecnologia utilizada.
Post citado acima: “Node.js + Express + ES6 + Eslint + Prettier + Sucrase de forma simples e rápida – https://link.medium.com/hXLRA1cRU1“
Obs: ao longo deste post utilizarei o termo “editor de código” para me referir também as IDEs (Integrated Development Environment).
O que é o EditorConfig
Nada mais é do que um plugin que obriga o editor de código a seguir de forma prescrita os padrões macro essenciais de formatação configurados pelo usuário.
Em outras palavras, o editorConfig ajuda a estabelecer um estilo de código entre diferentes editores, independente da tecnologia utilizada.
Veja uma descrição traduzida do site oficial do projeto:
O EditorConfig ajuda a manter estilos de codificação consistentes para vários desenvolvedores que trabalham no mesmo projeto em vários editores e IDEs. O projeto EditorConfig consiste em um formato de arquivo para definir estilos de codificação e uma coleção de plugins de editor de texto que permitem aos editores ler o formato do arquivo e aderir aos estilos definidos. Os arquivos EditorConfig são facilmente legíveis e funcionam bem com os sistemas de controle de versão.
Instalando
Seu editor de código pode ter suporte nativo ao EditorConfig ou via instalação de plugin. A lista de editores suportados pela ferramenta pode ser encontrada no site oficial do projeto em: https://editorconfig.org.
É correto afirmar que os editores mais famosos irão suportar essa ferramenta, seja de forma nativa ou via instalação de plugin. Caso seja necessário instalar o plugin, acesse a marketplace do seu editor, localize o plugin e instale (não requer configuração).
Exemplo utilizando o VSCode
Para instalar basta acessarmos a marketplace, pesquisar por editorconfig, clicar no resultado “EditorConfig for VS Code” e em seguida clicar em instalar, note que o meu já está instalado e ativo:
Continue lendo em: https://medium.com/@fabiojanio/editorconfig-padronizando-caracter%C3%ADsticas-essenciais-768a806ad33c