DEV Community

Paulo Guerra
Paulo Guerra

Posted on

9 3

Instalando e Configurando PHP CodeSniffer (PHPCS)

Repositório Oficial → https://github.com/squizlabs/PHP_CodeSniffer

O PHPCS, abreviação para PHP CodeSniffer é uma ferramenta que tem como objetivo detectar violações de padrões de código.

Esse tutorial busca auxiliar na instalação e configuração do phpcs nas duas principais ferramentas de desenvolvimento da atualidade para PHP (VSCode e PHPStorm) a fim de conseguir alcançar um bom nivelamento da PSR12 em todos nossos projetos.

Instalação

O PHPCS precisa de uma versão igual ou superior à 5.4.0.

Existem algumas maneiras de instalar o PHPCS, conforme indicado na documentação do repositório oficial, entretanto, vamos seguir a com a instalação via Composer Global, pois já foi testada e funciona em qualquer ambiente, Linux, MacOS e Windows (incluindo WSL).



composer global require "squizlabs/php_codesniffer=*"


Enter fullscreen mode Exit fullscreen mode

Após instalar, execute o comando abaixo caso precise saber qual o caminho padrão de instalação global do seu composer.



composer global config bin-dir --absolute


Enter fullscreen mode Exit fullscreen mode

Salve esse caminho.

Para verificar se o phpcs foi instalado corretamente, basta executar:



phpcs --version


Enter fullscreen mode Exit fullscreen mode

Visual Studio Code

Instale a extensão phpcs publicada pelo Ioannis Kappas.

A extensão é bastante configurável, mas a princípio recomendo apenas a seguinte configuração global, para garantir o mesmo padrão em todos os projetos.

Em settings.json do VSCode, adicione o seguinte:



"phpcs.enable": true,
"phpcs.standard": "PSR12",
"phpcs.ignorePatterns": ["*/vendor/*"]


Enter fullscreen mode Exit fullscreen mode

E é isso, divirtam-se :)

PHP Storm

Acesse as configurações Ctrl+Alt+S.

PHP > Quality Tools > PHP_CodeSniffer > Local

Usuários WSL: Caso não tenha PHP e Composer instalado no Windows e apenas no Linux, o interpretador Local não irá funcionar. Nesse caso, é necessário informar um novo interpretador, que será sua distro linux onde o PHP e Composer estão instalados, clicando no ícone + no canto superior esquerdo.

Em PHP_CodeSniffer path informe o caminho do phpcs instalado no composer global e clique em Validate.

Se ocorrer tudo bem você receberá um feedback positivo na parte inferior da aba, caso contrário, verifique o caminho informado.

Selecione Apply e em seguida PHP_CodeSniffer inspection.

Marque a caixinha para ativar a inspeção nesse projeto e ao lado direito, em Options, você pode selecionar os arquivos que gostaria que a inspeção ocorra (eu deixei apenas php). Agora o mais importante, no select de coding standard escolha PSR12!

E é isso, um pouco mais complicado do que VSCode, mas tudo certo :)

P.S: Ainda não descobri como deixar padrão para todos os projetos no PHPStorm, ainda é necessário configurar a inspeção para cada projeto individualmente. Caso tenham essa informação comentem e atualizo o tutorial.

Image of Timescale

🚀 pgai Vectorizer: SQLAlchemy and LiteLLM Make Vector Search Simple

We built pgai Vectorizer to simplify embedding management for AI applications—without needing a separate database or complex infrastructure. Since launch, developers have created over 3,000 vectorizers on Timescale Cloud, with many more self-hosted.

Read full post →

Top comments (0)

Eliminate Context Switching and Maximize Productivity

Pieces.app

Pieces Copilot is your personalized workflow assistant, working alongside your favorite apps. Ask questions about entire repositories, generate contextualized code, save and reuse useful snippets, and streamline your development process.

Learn more