Back-End

6 mai, 2019

Padronizando seu código com PHP CS Fixer

100 visualizações
Publicidade

Olá, pessoal! Tudo certo?

Gostaria de escrever sobre uma ferramenta que considero super importante estar presente na sua stack de desenvolvimento PHP.

Estou falando do já conhecido PHP Coding Standard Fixer, o PHP CS Fixer.

Sobre a ferramenta:

O objetivo do PHP CS Fixer é aplicar os padrões básicos de codificação e estilo de código nos arquivos PHP do seu projeto.

Ele detecta o código fora dos padrões e aplica um “fix”, transformando essas ocorrências em um código que segue as recomendações atuais de codificação da linguagem definidas pelo PHP-FIG.

Instalação:

composer require --dev friendsofphp/php-cs-fixer

Uso da ferramenta

Considere o script abaixo:

Nele encontramos alguns trechos que não estão de acordo com os padrões definidos nas PSR 1 e PSR 2. Entre eles:

  • 1. Sempre incluir uma linha em branco entre a declaração do namespace e as declarações “use”
  • 2. Nunca utilizar a palavra “var”, e sempre declarar a visibilidade para propriedades
  • 3. Sempre declarar a visibilidade para métodos
  • 4. O “final” deve preceder a declaração de visibilidade. Não existe espaço entre o nome do método e o parêntese de abertura, e a chave de abertura deve estar posicionada na próxima linha com o recuo adequado

Estes são somente alguns exemplos de “infrações” das recomendações atuais que podem ser corrigidos pela ferramenta.

E agora, vamos resolver?

Para isso, basta rodar o comando abaixo, apontando para o arquivo/diretório que você deseja afetar:

php vendor/bin/php-cs-fixer fix PdfGenerator.php

Resultado:

Como podemos observar, todas as inconsistências de escrita foram detectadas e resolvidas de forma muito rápida e eficiente!

Observações:

Por default, o PHP CS Fixer aplica a PSR 1 e PSR 2 em suas detecções, mas podemos definir regras personalizadas, concatenando-as no próprio comando ou em um arquivo de configuração.

Para ver todos os detalhes, cobertura e possibilidades de uso da ferramenta, recomendo fortemente que visite a página do projeto através deste link.

Conclusão

Sem dúvidas o PHP Coding Standard Fixer é uma excelente ferramenta de auxílio para devs PHP, executando a detecção e correção de código fora dos padrões recomendados pela comunidade e, assim, contribuindo com o desenvolvimento de projetos manuteníveis.

Espero este artigo tenha sido útil pra vocês.

Forte abraço!