Os padrões de codificação (ou Coding Standards) são coleções de boas práticas para escrever códigos, 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, nós podemos encontrar através deste link uma coleção de regras e melhores práticas para desenvolver temas e plugins.

Neste post, quero te mostrar como configurar o Visual Studio Code para formatar seu código utilizando os padrões do WordPress

Pré-requisitos

Primeiro, tenha certeza de que já tem as seguintes instalações no seu computador:

  • Visual Studio Code (óbvio, dãã)
  • PHP
  • Composer

Vamos começar

Depois de ter todos os pré-requisitos necessários, vamos ao que interessa:

# Instale a versão requerida do PHP CodeSniffer, de acordo com os requerimentos do WPCS
$ composer global require squizlabs/php_codesniffer:3.4.*

# Deixe ele globalmente acessível na sua variável PATH
$ export PATH=~/.composer/vendor/bin:$PATH

# Verifique que está instalado corretamente rodando phpcbf --version
$ phpcbf --version

Se você receber uma mensagem de erro de permissão quando instalar a dependência, corrija as permissões do composer

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

# Clone o repositório de coding standards do WordPress
$ git clone -b master https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git wpcs

# Adicione seu path a configuração do PHP_CodeSniffer:
$ phpcbf --config-set installed_paths /path/to/wpcs

Se nós pararmos por aqui, já conseguimos formatar nosso código através da linha de comando:

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

Mas o que nós queremos, é com um simples atalho no teclado, fazer isso acontecer diretamente no nosso editor de código.

Para conseguir isso, nós precisamos instalar a extensão phpcbf no Visual Studio Code (disponível neste link), e adicionar o seguinte em sua configuração:

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

Agora, usando um atalho no teclado (ou menu de contexto), já conseguimos atender aos requisitos de padrão de código do WordPress:

Deixe uma resposta