Skip to end of metadata
Go to start of metadata


Icon

Quando estamos desenvolvendo um projeto Drupal, contamos com diversas ferramentas. Nesta seção vamos conhecer algumas e configurá-las para nosso desenvolvimento.

Buscas na API do Drupal

Ao desenvolver sempre é bom contar com a documentação oficial. Com o Drupal e o PhpStorm não é diferente: para fazer uma busca por um termo em seu código diretamente na Documentação de API do Drupal (em https://api.drupal.org/api/drupal ). Basta selecionar o termo que deseja procurar, abrir o menu de contexto e selecionar Search in Drupal API.

O navegador padrão será aberto diretamente na busca do termo que você selecionou.

Issue Tracker do Drupal.org

A própria comunidade Drupal possui seu gerenciador de tarefas (https://www.drupal.org/project/issues). Ele pode ser integrado ao PhpStorm provendo mensagens de commit, mudanças de tarefas e contextos direto do IDE. Infelizmente a autenticação do Drupal.org ainda não é suportada - o que nos permite visualizar do IDE fica limitado ao que usuários anônimos conseguem ver.

Há algumas maneiras para configurar o Issue Tracker do Drupal.org diretamente no PhpStorm. Uma delas, descrita por Cameron Eagans em post no seu blog, Integrating PhpStorm and Drupal.org Issue Queue (em inglês) é uma das mais utilizadas. Vamos apresentar aqui uma maneira alternativa para o mesmo propósito. 

Abra as configurações de tarefas em Settings → Tasks → Servers. Adicione, clicando em {{ + }}, e selecionando Generic. Na aba General, insira https://drupal.org (https://drupal.org*) em Server URL e selecione a opção Login Anonymously.

Em Commit Message você pode customizar a mensagem de commit que será sugerida quando você o fizer pelo IDE.

Em Server Configuration vamos adicionar o seguinte em Tasks List URL: {serverUrl}/project/issues/rss/{project}?categories=All, deixamos Single Task URL em branco e selecionamos XML para Response Type. Na tabela logo abaixo completamos os campos com as pesquisas XPath correspondentes para cada informação, como na lista a seguir:

Name

Path

tasks

//item

id

substring-after(child::link/text(),'node/')

summary

child::title/text()

description

child::description/text()

created

child::pubDate/text()

issueUrl

child::link/text()

Clique em _Manage Template Variables..., _adicione a variável project e insira como valor o id de seu projeto.

Salve estas configurações clicando em OK. Agora vá para o menu Tools  Tasks & Contexts  Open Task e confira as tarefas de seu projeto diretamente do PhpStorm, contextualizando o IDE para aquela tarefa e até mesmo indo até a página da mesma através do menu de contexto.

Para saber mais sobre a integração de gerenciadores de tarefas no PhpStorm veja este artigo (em inglês). 

Coder e PHP Code Sniffer

É importante que mantenhamos o estilo de código padronizado enquanto desenvolvemos nossas soluções. Com Drupal não é diferente - a principal ferramenta de revisão de código da comunidade, o Coder, possui a definição do padrão de codificação da comunidade.

Podemos utilizar o PHP Code Sniffer, suportado pelo PhpStorm, para realizar a inspeção de nosso código baseando-se também no estilo de código no Coder. 

Se você não conhece, ou não tem instalado, o PHP Code Sniffer, recomendo que leia antes a ajuda do PhpStorm ou a página do PHP Code Sniffer.

Você deve baixar o módulo Coder sem, no entanto, instalá-lo - vamos usar somente a definição do estilo de código em seu fonte.

Rode o seguinte comando para adicionar o estilo de código Drupal:  phpcs --config-set installed_paths /diretorio/do/coder/coder_sniffer

Acesse Settings  PHP  Code Sniffer, configure e valide (clicando em Validate) sua instalação.

Ainda em Settings, vá para Inspections e selecione PHP  PHP Code Sniffer validation. Clique em atualizar e em seguida selecione Drupal em Coding Standard.

Agora temos as inspeções do padrão Drupal direto no código.

Drush

Drush é a interface de linha de comando do Drupal

O PhpStorm se integra com diversas ferramentas para shell, inclusive o Drush, a partir de sua versão 5.8.

Para adicionar o Drush como ferramenta de linha de comando no PhpStorm acesse Settings → Command Line Tool Support e adicione uma nova ferramenta clicando em {{ + }}.

Selecione Drush em Choose tool e escolha a visibilidade - se esta configuração vale somente para este projeto (project) ou para qualquer outro configurado no PhpStorm (global).

O próximo passo é indicar para o PhpStorm onde está a instalação do Drush.

Você pode acessar a ferramenta de linha de comando por CtrlShiftX (CmdShiftX no Mac) ou no menu Tools → Run Command.


  • No labels