Configurando PHP CodeSniffer por projeto

Alguns anos atrás, escrevi um post sobre como configurar o PHP CodeSniffer no Visual Studio Code (e também o atualizei recentemente).

Mas já se passaram quatro anos desde que esse post foi escrito originalmente e, nesse período, muita coisa pode mudar em termos de como escrevemos código.

Quatro anos é mais ou menos a Era da Internet, não é?

De qualquer forma, os pontos básicos desse artigo ainda estão de pé, mas se você estiver trabalhando em uma variedade de projetos e alguns deles exigirem configurações, configurações e padrões diferentes, então a maneira como você instala e configura o PHP CodeSniffer pode ser diferente do como você o configura em um nível de sistema.

Portanto, se você estiver nessa posição, veja como configurar o PHP CodeSniffer por projeto usando o Visual Studio Code.

PHP CodeSniffer por projeto

Este artigo faz algumas suposições:

• Você conhece o Composer ,
• Você sabe como lidar com espaços de trabalho no código,
• Você está familiarizado com PHP CodeSniffer (pelo menos em nível global),
• E você sabe como trabalhar com extensões de código .

Se você não tiver certeza sobre qualquer um deles, revise este artigo e depois volte. Vou orientá-lo através do resto.

1 Instale o PHP CodeSniffer localmente

Como projetos diferentes podem exigir um conjunto diferente de padrões, acho útil manter uma cópia composer.jsone, naturalmente, composer.lockpor projeto.

Isso significa que na raiz do meu projeto, tenho um composer.jsonarquivo com tudo que preciso para um determinado projeto. No caso deste artigo, preciso de uma cópia do PHP CodeSniffer.

Para instalar o PHP CodeSniffer e a versão mais recente do WordPress Coding Standards no nível do projeto, criarei o arquivo acima na raiz do meu projeto e incluirei o seguinte:

{
    "require": {
        "wp-coding-standards/wpcs": "2.3.0",
        "squizlabs/php_codesniffer": "3.*"
    }
}

Na maioria dos casos, esse arquivo será muito mais complexo, mas você terá uma ideia geral do que precisa incluir.

Em seguida, execute composer installe isso criará um vendordiretório em seu projeto que incluirá os padrões de codificação do WordPress e o PHP CodeSniffer.

2 Configure links simbólicos para os binários locais

Neste ponto, você pode achar útil criar um link simbólico para os binários para PHPCS e PHPCBF para não entrar em conflito com o que estiver executando em nível global.

Para fazer isso, na raiz do projeto, você pode inserir o seguinte no seu terminal:

$ ln -s /vendor/bin/phpcs phpcs
$ ln -s /vendor/bin/phpcbf phpcbf

Isso permitirá que você execute os binários do seu terminal. Para testar, tente o seguinte comando:

$ ./phpcs --version

E você deve ver uma saída como esta:

PHP_CodeSniffer version 3.5.5 (stable) by Squiz (http://www.squiz.net)

Se sim, você tem tudo configurado corretamente.

3 Instale a extensão PHP CodeSniffer

O próximo passo, sem dúvida o mais fácil, é configurar a extensão PHP CodeSniffer no Code. Existem várias opções que você tem, mas tive uma boa experiência com essa extensão específica.

Depois de instalado e você recarregar seu IDE, você deve estar pronto para instalar e configurar o PHP CodeSniffer por projeto.

4 Configure seu espaço de trabalho

No Code, a próxima coisa que você vai querer fazer é configurar o PHP Code Sniffer para seu projeto específico. Para fazer isso, é mais fácil configurar um espaço de trabalho para seu projeto.

Você pode fazer isso clicando no menu Arquivo e, em seguida, clicando no item de menu Salvar espaço de trabalho como… . Isso criará um project.code-workspacearquivo onde você optar por incluí-lo.

Se você estiver controlando a versão do seu projeto, recomendo mantê-lo na raiz do seu projeto para que você possa mantê-lo no controle de versão. Em seguida, se você abrir esse arquivo, notará que é JSON e inclui uma settingsdiretiva. Dentro dessa diretiva, adicione as seguintes configurações:

project.code-workspace

Observe acima que estamos dizendo explicitamente à extensão onde está o caminho executável – ou seja, no vendordiretório relativo ao workspacearquivo.

Depois de fazer isso, você deve ser capaz de começar a escrever código e fazer com que ele fareje ativamente seu código enquanto trabalha.

Quer mais?

Se você estiver interessado em sniffing e correção ainda mais agressivos de cheiros e problemas de código, recomendo verificar o artigo no GrumPHP.