Como configurar WordPress Coding Standards no Visual Studio Code

Coding Standards são padrões de melhores práticas para escrever código, provavelmente você os encontrará na documentação da sua linguagem de programação favorita.

No WordPress (neste caso um CMS, não uma linguagem de programação) não é diferente, podemos encontrar neste link uma coleção de regras e melhores práticas para desenvolver temas e plugins.

Neste artigo vou te mostrar como configurar o Visual Studio Code para formatar seu código e sempre mantê-lo “bonito” de acordo com o WordPress Coding Standards.

Pré-requisitos

Nós vamos precisar do seguinte instalado no computador:

• Visual Studio Code (obviamente)
• Pacotes do Aptitude
• Composer

Vamos começar

Passo 1 – Instalando as dependências

Primeiro, atualize o cache do package manager com o seguinte comando:

sudo apt update

Agora, vamos instalar as dependências. Elas podem ser instaladas com o seguinte comando:

sudo apt install curl php-cli php-mbstring php-xmlwriter git unzip

Passo 2 – Instalando o Composer

Para baixar e instalar o Composer, execute este comando:

cd ~ && curl -sS https://getcomposer.org/installer -o composer-setup.php && php composer-setup.php --install-dir=/usr/local/bin --filename=composer && rm composer-setup.php

Teste a instalação para ter certeza de que funcionou:

composer

Passo 3 – Instalando o PHP CodeSniffer

Depois de instalar todas as dependências, vamos iniciar o processo.

Primeiro, instale a versão necessária do PHP CodeSniffer de acordo com os requerimentos do WPCS:

composer global require squizlabs/php_codesniffer:3.4.*

Se você receber um erro de permissão quando estiver instalando alguma dependência, ajuste as permissões do composer:

sudo chown -R $USER ~/.config/composer/

Agora, torne o comando global no seu $PATH:

export PATH=~/.config/composer/vendor/bin:$PATH

E finalmente, verifique que está funcionando:

phpcbf --version

Passo 4 – Configurando o WordPress Coding Standards

Agora que nós podemos usar o phpcbf e phpcs, nós precisamos configurar qual Coding Standard nós queremos.

Clone o repositório do WordPress Coding Standards dentro da pasta do seu usuário:

cd ~ && git clone -b master https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs

Adicione o path do WPCS às configurações do PHP_CodeSniffer:

phpcbf --config-set installed_paths ~/wpcs/

Se nós pararmos por aqui, já podemos formatar os arquivos PHP através do seguinte comando:

phpcbf --standard=WordPress --extensions=php /path/to/php/files

Mas o que nós queremos, é com uma simples combinação de teclas, fazer isto acontecer direto do Visual Studio Code.

Passo 5 – Configurando o Visual Studio Code para utilizar o WPCS

Para isso, nós precisamos instalar a extensão phpcbf no Visual Studio Code (disponível neste link), e configurar o seguinte:

{
    "phpcbf.executablePath": "~/.config/composer/vendor/bin/phpcbf",
    "phpcbf.standard": "WordPress",
}

Agora, usando um atalho do Visual Studio Code (ou menu de contexto), podemos aplicar os padrões de código do WordPress nos nossos arquivos.