Como melhorar seu código Magento com PHP Mess Detector

Existem muitas formas de melhorar a forma como escrevemos códigos.

Como desenvolvedor, sempre gosto de conhecer os recursos que minha IDE pode oferecer para me ajudar a melhorar.

Abrir chave na mesma linha ou na linha de baixo? Usar camelCase ou under_line? Limitar linhas em 80 ou 120 caracteres?

Independente do gosto pessoal, é importante mantermos um padrão de código. Seja para facilitar a manutenção ou simplesmente para melhorar a leitura da nossa arte final.

No Magento não é diferente. E por isso que a Magento preparou pra gente alguns padrões de código para serem usados nas nossas IDEs. Alguns deles dentro do próprio Magento e outros como CodeSniffer que podem ser usados por fora, como já vimos aqui.

• Code Sniffers para Magento 1 (usar pasta ECG) – não é mais atualizado
• Code Sniffers para Magento 2

Neste artigo veremos como configurar uma IDE como PhpStorm para fazer uso do PHP Mess Detector (PHPMD) e exibir alertas quando estivermos fazendo algo errado ou fora dos padrões recomendados.

PHPMD + Magento 2 + PhpStorm

1. Vá até as preferências do PhpStorm, e selecione Languages & Frameworks > PHP > Quality Tools > Mess Detector
2. Clique no botão … para trazer o modal de configuração, e clique no + para adicionar uma nova
3. Informe o path do PHP Mess Detector: [pasta_magento]/vendor/phpmd/phpmd/src/bin/phpmd
4. Vá até as preferências do PhpStorm em Editor > Inspections e na coluna do meio, selecione Quality Tools > PHP Mess Detector Validation
5. Adicione uma nova Custom ruleset clicando no sinal de +, e aponte para [pasta_magento]/dev/tests/static/testsuite/Magento/Test/Php/_files/phpmd/ruleset.xml
6. Marque todas as opções caso queira que ele realmente reclame de tudo. 🙂

Sua configuração ficará assim:

Uma forma rápida de testar e ver se está tudo funcionando é criar um novo método privado em alguma classe e observar a área de Problems da IDE.

Conclusão

O uso do PHP Mess Detector com Code Sniffer não lhe tornarão um desenvolvedor melhor. Mas certamente isso pode ajudar você e seu time a manter uma consistência no padrão de código a ser entregue, e a seguir os padrões de código recomendados pela Magento.

No Magento 2 existem várias ferramentas que lhe ajudam a ser um desenvolvedor(a) mais eficiente, e eu mostro pelo menos 10 delas no Magento 2: O Curso. Inclusive você ganha 6 meses de PhpStorm na faixa ao se inscrever.

Outra coisa que pode lhe ajudar a melhorar suas habilidades de programador é assistir vídeos e tutoriais sobre Magento ou outra linguagem. Mesmo quando se trata de um tópico que já conhecemos, uma ação ou outra do apresentador pode nos abrir a mente para melhorar algo que fazemos ou ao menos executar uma tarefa com mais agilidade da próxima vez.

E você? Como você melhora e valida seu código no dia a dia?

Conta pra gente nos comentários logo abaixo.

• Sobre
• Últimos Posts

Ricardo Martins

É desenvolvedor web há 16 anos e um dos primeiros certificados pela Magento no Brasil. Instrutor de mais de 11 cursos Magento (os principais no magenteiro.com/cursos) com mais de 14 mil alunos de 105 países, é também criador do módulo PagSeguro Transparente, usado em mais de 12 mil lojas.

Últimos posts por Ricardo Martins (exibir todos)

• PagSeguro (PagBank) para Magento 1 recebe a Nova Geração - 9 de abril de 2024
• Recorrência no WooCommerce Sem Plugins Pagos - 28 de janeiro de 2024
• Chargeback. O que é, e como se livrar deles. - 19 de dezembro de 2023