Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0
Wiki Markup
{scrollbar}


Table of Contents


Introdução


Quando está desenvolvendo algo que outros desenvolvedores possam dar suporte, ou mesmo sobre código de outrem, faz-se essencial o uso de um padrão de codificação. Um padrão é uma definição sobre como o código deve ser escrito: endentação, posição de chaves, espaçamento entre tokens da linguagem, etc...

Projetos PHP não têm um padrão de codificação em específico a seguir. Alguns frameworks definiram os seus próprios padrões para o desenvolvimento; alguns inclusive compartilham o mesmo padrão de maneira mais comunitária. A comunidade WordPress também conta com um padrão específico para desenvolvimento e distribuição de código WordPress.

 Há uma ferramenta, desenvolvida em PHP, para verificação de aderência a um determinado padrão. O PHP Code Sniffer foi projetado para isso. Embora já conte com definições para os padrões mais comuns em projetos PHP, ele não tem o padrão do WordPress - que está em um Repositório no GitHub e é mantido pela comunidade. O PHP Code Sniffer é suportado nativamente pelo PhpStorm - o que te provê notificações de violações de estilo direto no Editor. Instalar o padrão do WordPress é bem fácil, basta acompanhar os seguintes passos:

Passo a passo


  1. Instale o PHP Code Sniffer via PEAR ou Composer. Instruções de Instalação estão disponíveis no Help do PhpStorm e na página do PHP Code Sniffer.
  2. Baixe as regras do Padrão deCódigo do WordPress para o PHP Code Sniffer e descompacte-o.
  3. Execute o seguinte: phpcs --config-set installed_paths /diretorio/onde/descompactou/o/arquivo/WordPress-Coding-Standards
  4. Configure o PHP Code Sniffer ajustando sua localização em SettingsPHPCode Sniffer. Clique em Validate para confirmar se o executável do Code Sniffer está correto.
  5. Habilite as inspeções para o PHP Code Sniffer em SettingsInspectionsPHPPHP Code Sniffer validation. Selecione WordPress em Coding standard. Clique no botão refresh ao lado da lista se necessário. Clique em OK.

  6. Agora seu código será inspecionado pelo PHP Code Sniffer com o padrão de código do WordPress, além das outras inspeções que o PhpStorm já faz. Você verá notificações marcadas com phpcs no Editor.

  7. Se você rodar inspeções em lote com CodeInpect Code... os resultados das inspeções do PHP Code Sniffer serão listados na seção PHPPHP Code Sniffer validation.

Wiki Markup
{scrollbar}