PHP CS Fixer
v3.65.0 Persian Successor
A ferramenta PHP Coding Standards Fixer (PHP CS Fixer) corrige seu código para seguir os padrões; se você deseja seguir os padrões de codificação PHP definidos no PSR-1, PSR-2, etc., ou outros padrões da comunidade, como o Symfony. Você também pode definir o estilo da sua equipe por meio da configuração.
Ele pode modernizar seu código (como converter a função pow para o operador ** no PHP 5.6) e (micro) otimizá-lo.
Se você já usa um linter para identificar problemas de padrões de codificação em seu código, sabe que corrigi-los manualmente é entediante, especialmente em projetos grandes. Esta ferramenta não apenas os detecta, mas também os corrige para você.
Nota Cada nova versão do PHP requer um grande esforço para suportar a nova sintaxe. É por isso que a versão mais recente do PHP pode ainda não ser suportada. Se precisar, considere apoiar o projeto de qualquer maneira conveniente, por exemplo, com contribuição de código ou revisando PRs existentes. Para executar o PHP CS Fixer em versões ainda não suportadas "por sua conta e risco" - aproveite o PHP_CS_FIXER_IGNORE_ENV.
A maneira recomendada de instalar o PHP CS Fixer é usar o Composer em um arquivo composer.json dedicado em seu projeto, por exemplo, no diretório tools/php-cs-fixer :
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer Ou usando o composer.json principal:
composer require --dev friendsofphp/php-cs-fixerPara obter mais detalhes e outros métodos de instalação, consulte as instruções de instalação.
Você pode usar imagens Docker pré-construídas para executar php-cs-fixer .
docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src $FIXER_VERSION usado no exemplo acima é um identificador de uma versão que você deseja usar, que é baseado nas versões Fixer e PHP combinadas. Existem tags diferentes para cada nível SemVer do Fixer e versão PHP com sintaxe <php-cs-fixer-version>-php<php-version> . Por exemplo:
3.57.0-php7.43.57-php8.03-php8.3 Supondo que você instalou o PHP CS Fixer conforme as instruções acima, você pode executar o seguinte comando para corrigir os arquivos PHP no diretório src :
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix srcConsulte uso, lista de regras integradas, lista de conjuntos de regras e documentação do arquivo de configuração para obter mais detalhes.
Se precisar aplicar estilos de código que não são suportados pela ferramenta, você poderá criar regras personalizadas.
Existem plug-ins dedicados para:
O PHP CS Fixer é mantido no GitHub em https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Relatórios de bugs e ideias sobre novos recursos são bem-vindos.
Você pode entrar em contato conosco nas discussões do GitHub sobre o projeto, configuração, possíveis melhorias, ideias e dúvidas. Por favor, visite-nos lá!
A ferramenta vem com alguns fixadores integrados, mas todos são mais que bem-vindos para contribuir com mais deles.
