Usando o EditorConfig para padronizar a formatação de seu projeto



Uma das coisas que mais incomodam desenvolvedores profissionais é a formatação e padronização de código, principalmente em situações que vários membros de um time trabalham em um mesmo código ou aplicação.

O EditorConfig ajuda a resolver uma parte deste problema mantendo a consistência na formatação do código, tanto entre diferentes desenvolvedores quanto entre os diversos IDEs. O projeto EditorConfig consiste em um arquivo contendo as definições de formatação que são aplicadas automaticamente na IDE que você está usando.

Para que o EditorConfig funcione você precisa criar um arquivo chamado .editorconfig com as definições de formatação apropriadas dentro da pasta de seu projeto (na raiz por exemplo). Ao abrir o projeto através de sua IDE preferida o PlugIn procurará nas pastas pelo arquivo até encontrá-lo.

Cada IDE tem um procedimento próprio de instalação do PlugIn. Como exemplo segue o passo a passo para instalar o EditorConfig no Sublime Text.
  • Vá no menu 'Preferences' > 'Package Control';
  • Selecione 'Install Package' no menu Drop Down;
  • Aguarde a lista de pacotes aparecer;
  • Digite 'EditorConfig' e selecione o pacote quando aparecer;
  • Para verificar se o pacote foi corretamente instalado basta ir em 'Preferences' > 'Browse Packages' e verificar se existe a pasta 'EditorConfig'.

Principais definições de formatação

Abaixo segue uma breve lista das principais definições de estilo. A lista completa pode ser consultada na documentação do PlugIn

  • indent_style: definir como "tab" ou "space"
  • indent_size: número de colunas usadas para indentar o código.
  • end_of_line: atribua "lf", "cr", ou "crlf" para controlar como as quebras de linha são representadas.
  • charset: "latin1", "utf-8", "utf-8-bom", "utf-16be" or "utf-16le"
  • trim_trailing_whitespace: atribua "true" para remover espaços em branco do final de uma linha.
  • insert_final_newline: atribua "true" para inserir uma quebra de linha automática.
  • root: se atribuído "true" o EditorConfig para sua busca ao encontrar o primeiro arquivo .editorconfig.

Modelo exemplo

Abaixo segue um modelo básico de formatação para o EditorConfig que será aplicado em todos os níveis da aplicação e em todos os arquivos:

 ; Pra todos os arquivos  
 [*]  
 charset = utf-8  
 end_of_line = lf  
 insert_final_newline = true

Comentários

Postar um comentário

Postagens mais visitadas deste blog

PHP - Utilizando proxy e CURL para acessar servidores ou sites

Imagem
Proxies são extremamente úteis, principalmente para usuários avançados, e se você não sabe exatamente o que são recomendo a leitura deste artigo da Wikipedia . Resumidamente um proxy é uma máquina que fica entre você e a Internet. Acessar a Web por um proxy fará com que os servidores que você acessa enxerguem não o seu endereço mas o endereço desta máquina intermediária. Você pode precisar utilizar um proxy caso a rede da sua empresa não permita acessar um Facebook, Twitter ou outro site qualquer, caso seu IP tenha sido bloqueado por algum administrador de site, queira testar o acesso de diferentes usuários em seu site e outros usos menos ortodoxos. Por suas características peculiares proxies devem ser usados com cuidado, principalmente se você pensa em acessar serviços utilizando alguma senha. Hoje vamos criar uma classe que utilizará um proxy para acessar qualquer URL com a ajuda do CURL do PHP. Vamos considerar que o proxy que você utiliza é aberto, ou seja, não necess...
Leia mais

MySQL - Cálculo de período de tempo entre duas datas com TIMESTAMPDIFF

Imagem
Muitas vezes precisamos saber quantos dias se passaram desde que um dado registro entrou no banco de dados ou outros cálculos com datas e horas que precisemos agrupar em dias, meses, horas e etc. Este tipo de informação geralmente é útil nos processos de limpeza e backup de dados mas também em outras situações como a exibição de dados para um usuário. Geralmente este procedimento é delegado ao software que lê o banco de dados e realiza as operações necessárias, seja para backup, limpeza ou exibição de dados. Porém o MySQL possui uma função interessante para efetuar este tipo de procedimento diretamente na query do banco de dados, o que é mais natural já que se trata de um dado. A função TIMESTAMPDIFF() do MySQL calcula o tempo decorrido entre duas datas que pode ser em dias, meses, minutos e etc. A lista completa segue abaixo: FRAC_SECOND (microsegundos), SECOND (segundos), MINUTE (minuto), HOUR (hora), DAY (dia), WEEK (semana), MONTH (mês), QUARTER (trimestre),...
Leia mais

MySQL - Completando quantidades fixas de caracteres com as funções LPAD() e RPAD()

Em PHP temos uma função não tão conhecida, str_pad() , que completa uma string com qualquer caractere até uma quantidade definida pelo programador. Esta função é extremamente útil no caso de codificações padronizadas onde a quantidade de caracteres deve ser sempre fixa. No MySQL temos uma função equivalente chamada LPAD() . A sintaxe desta função é LPAD(CAMPO,QUANTIDADE DE CARACTERES,CARACTERE PARA COMPLETAR) Vamos fazer uma query na tabela exemplo 'produtos' abaixo: cod | nome | valor 3 | Iphone | 3000.00 10 | Blue Ray | 1800.00 230| Book | 30.00 Vamos supor que o padrão de código exigido pelo sistema que lê o banco de dados seja de cinco (5) caracteres. Valores menores que este deverão ser preenchidos com zeros a esquerda SELECT LPAD(cod,5,'0') AS cod, nome,valor FROM produtos Teremos como resultado: cod | nome | valor 000003 | Iphone | 3000.00 000010 | Blue Ray | 1800.00 000230 | Book | 30.00 Assi...
Leia mais