Symfony PHP Code Sniffer

Symfony PHP Code Sniffer ?! Mas e aí o que é primeiramente o PHP Code Sniffer ?

Vamos explicando aos poucos logo abaixo…

Sabemos que dificilmente um código será mantido pelo seu criador eternamente.

Por isso precisamos de padrões de código, para manter um código bem escrito e descrito, e as convenções de código padronizam de acordo com a experiência já testada na área.

O PHP Code Sniffer, visa validar um padrão de código.

Os Padrões de Código Definem:

Indentação do Código
Conveção de nomenclatura
Espaços em Branco
Padrão de Comentários
Etc…

Assim sendo, padrões de código definem um código com qualidade, legibilidade, assim como reduzem custo de manutenção.

O Php Code Sniffer é um módulo da biblioteca PEAR, que possui um “Script” que verifica violações no Standard ( Padrão ) definido.

Para inicio de conversa precisamos ter o PEAR instalado execute:

sudo apt-get install php-pear

Agora vamos para a parte do CodeSniffer propriamente dita.

Executaremos agora:

sudo pear install PHP_CodeSniffer

Após a instalação, verificaremos se está instalado, execute:

phpcs -i

Você será capaz de ver os Standards instalados que será algo parecido com isso:

Porém o nosso Querido SYMFONY 2 não aparecerá aí … Porque esse Standard ainda não está instalado.

Agora vamos encontrar qual o caminho está seu PEAR para instalarmos este Standard. Execute:

pear config-show | grep php_dir

Agora entre dentro do caminho acima + PHP/CodeSniffer/Standards, no meu caso assim:

Agora dentro da Pasta de Standards, vamos adicionar o nosso Symfony 2 como padrão reconhecido, clonando o projeto do Symfony Standards, para dentro desta pasta, com os seguinte comando:

sudo git clone https://github.com/leaphub/phpcs-symfony2-standard.git Symfony2

Logo configuraremos o nosso PHPCS para analisar como padrão os Standards do Symfony2…

phpcs --config-set default_standard Symfony2

Para utilizar, podemos ou via linha de comando chamar o PHPCS para analisar a pasta src/ do projeto ou integrar com a IDE. Para fazer a chamada via linha de comando utilize:

phpcs --standard=Symfony2 --extensions=php src/

Lembre-se que só irá funcionar desta forma se você estiver dentro da pasta do projeto, senão você terá que referenciar o caminho completo para a pasta src/` .

Aqui finalizamos a instalação do Symfony 2 Standard Php Code Sniffer !

Como utilizo o PhpStorm (recomendo demais esta IDE), vou ensinar como integrar com esta IDE.

Primeito entre em Settings em sua IDE, e na busca dos Settings digite Code Sniffer.

Onde se encontra Configuration Local clique nos três pontinhos … para validarmos nosso phpcs , conforme imagem abaixo:

Após esta mensagem voltaremos e clicaremos em Inspections lá nos Settings, logo a direita onde marquei de amarelo selecione Default.

Onde fiz um circulo vermelho, clique para atualizar, e na setinha selecione o nosso Padrão Symfony 2.

Provavelmente acenderá algumas luzes em sua IDE passe o mouse por cima, e comece a melhorar seu código…

Veja os exemplos abaixo:

Bom meus amigos, é isso, espero que tenham gostado, e que sigam no passo a passo de fazer um código, limpo, legivel e inteligivel ! Seja inteligente !

Um abraço.