Composer – Automatizando tarefas com Scripts

Olá, tudo bem!

Que o Composer é uma ferramenta sensacional isso nós já sabemos, porém o que poucos sabem é que ele dispõem de recursos de execução de scripts para nos auxiliar na automatização de tarefas.

Acredite, após conhecer esse recurso você vai adotá-lo em seu dia a dia, pois irá lhe economizar um bom tempo em seu dia a dia.

O que é um script?

Em uma tradução livre podemos encontrar a seguinte definição na documentação do composer.

Um script, nos termos do Compositor, pode ser um retorno de chamada do PHP (definido como um método estático) ou qualquer comando executável de linha de comando. Os scripts são úteis para executar o código personalizado do pacote ou comandos específicos do pacote durante o processo de execução do Composer.

E para definir os scripts eles devem ser declarados no arquivo composer.json.

Definindo nosso primeiro script.

Para demonstrar como definir os scripts dentro do arquivo composer.json irei utilizar como base o projeto Calculadora de IMC este é o projeto de nível iniciante do grupo de estudos que lidero de PHP/POO do Training Center, aqui vai um jaba, caso você tenha interesse em aprender/aperfeiçoar ou transmitir seu conhecimento, seja ele em PHP, Java, Cloujure, React, Ruby, Frontend e muito muitas, venha participar dos nosso projetos e grupos de estudos que são excelentes e dispõem de uma comunidade gigante com muita vontade de colaborar e ajudar a crescermos juntos.

Caso você não conheça nada sobre o composer, recomendo os seguintes materiais que disponho no meu blog, sendo:

Após criação do clone do projeto Calculadora de IMC, abra o mesmo em um editor de código de sua preferência. No meu caso será o VSCode.

Em seguida abra o arquivo composer.json que se encontra na raiz do diretório, onde podemos visualizar toda sua estrutura, veja o conteúdo abaixo.

As informações que iremos focar são os descritos na sessão scripts, sendo:

Como podemos observar, para que possamos definir scripts para execução do composer devemos declarar no arquivo composer.json uma sessão denominada ‘scripts’ sendo dentro desta onde devemos descrever todos os scripts que desejamos executar.

Cada script é definido e executado de forma individual, entretanto mais a frente veremos como referenciar scripts.

Executando nossos scripts

Script para executar o servidor embutido do PHP

Como primeiro exemplo de script, temos:

A estrutura do script é simples tendo chave  como nome do script e valor o script em si.

O script acima é responsável por executar o servidor embutido do PHP, e para executá-lo devemos executar o seguinte comando no terminal, sendo:

Após execução, seu terminal irá ficar semelhante o da imagem abaixo.

Com isso sabemos que o servidor embutido do PHP está em execução.

Script para executar os testes unitários.

O script acima é responsável por executar os testes unitários criados com o PHPUnit.

Para executá-lo, devemos rodar o seguinte comando no terminal, sendo:

Após execução do comando os testes serão executados.

Podemos observar que a criação de scripts para o composer é simples e nos auxilia muito na execução de tarefas repetitivas poupando muito tempo.

Esses dois exemplos são simples, porém muito úteis. Você pode criar o script que desejar e com isso dispor de um leque de recursos para o seu dia a dia.

Nos próximos passos irei detalhar um pouco mais dos recursos disponíveis para a criação de scripts mais avançados.

Eventos

Eventos são recursos poderosos que podem nos auxiliar a deixar nossos scripts muito mais robustos e completos, eles são disparados conforme processo executado.

Nota: Os textos dos eventos são traduções livres realizados com base na documentação oficial do composer.

Eventos de comando

  • pre-install-cmd: ocorre antes do comando  install ser executado com um arquivo de bloqueio presente.
  • post-install-cmd: ocorre após o comando  install ter sido executado com um arquivo de bloqueio presente.
  • pre-update-cmd: ocorre antes do comando update ser executado ou antes do comando install ser executado sem um arquivo de bloqueio presente.
  • post-update-cmd: ocorre após o comando  update ter sido executado ou após o comando install ter sido executado sem um arquivo de bloqueio presente.
  • post-status-cmd: ocorre após o comando status ser sido executado.
  • pre-archive-cmd: ocorre antes do comando archive ser executado.
  • post-archive-cmd: ocorre após o comando archive ter sido executado.
  • pre-autoload-dump: ocorre antes que o carregador automático seja despejado, durante installupdate, ou através do comando dump-autoload.
  • post-autoload-dump: ocorre após o carregador automático ter sido despejado, durante installupdate, ou através do comando dump-autoload.
  • ost-root-package-install: ocorre após o pacote raiz foi instalado, durante o comando create-project.
  • ppost-create-project-cmd: ocorre após o comando create-project ter sido executado.

Eventos de instalação

  • pre-dependencies-solving : ocorre antes que as dependências sejam resolvidas.
  • post-dependencies-solving: ocorre após as dependências terem sido resolvidas.

Eventos de pacotes

  • pre-package-install: ocorre antes que um pacote esteja instalado.
  • post-package-install: ocorre após o pacote ter sido instalado.
  • pre-package-update: ocorre antes que um pacote seja atualizado.
  • post-package-update: ocorre depois que um pacote foi atualizado.
  • pre-package-uninstall: ocorre antes que um pacote seja desinstalado.
  • post-package-uninstall: ocorre depois que um pacote foi desinstalado.

Plugins

  • init : ocorre depois que uma instância do Composer é feita inicializando.
  • comando : ocorre antes que qualquer comando Composer seja executado na CLI. Ele fornece acesso aos objetos de entrada e saída do programa.
  • pre-file-download: ocorre antes que os arquivos sejam baixados e permite que você manipule o RemoteFilesystemobjeto antes de baixar os arquivos com base no URL a ser baixado.

Referenciando scripts

Um recurso muito poderoso e que nos auxilia a não duplicar scripts é poder referenciar um script em outro.

Para referenciar um script basta chamá-lo inserindo um @ antes do seu nome, por exemplo:

No exemplo acima podemos visualizar dois scripts, sendo que no script de test temos a referência o script clearCache, como podemos observar foi declarado utilizando o @clearCache.

Quando o comando composer test for executado ele irá executar o clearCache em seguida o phpunit.

Com este recurso fica livre a criação de múltiplos scripts, onde somente sua imaginação e criatividade será limite.

 

Considerações finais

Como podemos observar neste post o composer é uma ferramenta que dispõem de recursos incríveis, convido que você leia a documentação pois neste post sintetizei os pontos que acredito serem os principais para iniciar no uso de scripts.

Toda ferramenta deve ser utilizada com parcimônia, obviamente incentivo que faça seus testes crie seus scripts, pois somente assim você encontrará os recursos que lhe auxiliam mais em seu dia a dia.

Espero que este post tenha agregado valor e conhecimento em seu dia.

Grande abraço e sucesso em seus projetos.

6 thoughts on “Composer – Automatizando tarefas com Scripts”

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *