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

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

MySQL - Clonando tabelas na linha de comando

Clonar tabelas é fácil se você tiver a disposição um ' PHP MyAdmin ' ou uma aplicação gráfica instalada em sua máquina. Porém existem casos em que você só possui acesso a um shell (ou terminal) ou mesmo precisa criar uma aplicação que em algum momento seja necessária a clonagem de uma tabela. Os procedimento é muito simples: 1º Criar um clone da estrutura original (LIKE banco_de_dados.tabela) CREATE TABLE recipes_new LIKE production.recipes; 2º Inserir o conteúdo original dentro do clonado (FROM banco_de_dados.tabela) INSERT recipes_new SELECT * FROM production.recipes; É simples assim! Abraços
Leia mais

PHP - Gerando arquivo em UTF-8 com fwrite() e utf8_encode()

Encontrei uma dica muito interessante do "cutmaster at fearlesss dot com" que postou no site php.net. Ele mostrou como gerar um arquivo realmente no formato UTF-8. Segue a tradução de seu post. "Para aqueles que, como eu, gastaram muito tempo para entender porque fwrite() não criava arquivos utf-8 de verdade, aqui vai uma explicação que encontrei: Tentei fazer algo com:" <?php myString = utf8_encode("Test with accents éèàç"); fh=fopen('test.xml',"w"); write($fh,$myString); close($fh); "Por alguma razão misteriosa, o arquivo gerado traz os acentos sem o padrão utf-8. Tentei binário, etc. etc. e finalmente encontrei a solução. Parece que fwrite() PRECISA ter a função utf8_encode() DENTRO de seus parâmetros, como segue abaixo." <?php $myString = "Test with accents éèàç"; $fh=fopen('test.xml',"w"); fwrite($fh,utf8_encode($myString)); fclose($fh);
Leia mais