Tutorial para Contribuidores do Laravel Maestro

O Laravel usa o Maestro para construir Starter Kits. A documentação para contribuir com esses kits é escassa.

Se você deseja adicionar funcionalidades ou corrigir bugs em um Starter Kit, precisa entender o fluxo de trabalho. Este guia explica como usar o Maestro corretamente.

A Estrutura de Diretórios

O repositório possui três partes principais:

  • kits/: Contém os arquivos reais do Starter Kit. Este é o único diretório que você deve realizar o commit.
  • orchestrator/: Gerencia o processo de build e executa os kits.
  • build/: Este é um espaço de trabalho temporário. O Maestro o cria quando você executa um build.

O Fluxo de Trabalho de Desenvolvimento

Não trabalhe diretamente no diretório kits/ a menos que esteja atualizando muitos arquivos de uma só vez. Em vez disso, siga estes passos:

  1. Configure o ambiente Navegue até a pasta orchestrator/. Execute composer install e npm install.

  2. Realize o build do seu kit alvo Execute php artisan build. Escolha seu framework, variante e funcionalidades. Isso criará a pasta build/.

  3. Execute o kit Use composer kit:run a partir da pasta orchestrator/. Isso iniciará a aplicação na porta 8000.

  4. Faça suas alterações Abra o diretório build/. Encontre os arquivos que você precisa alterar e edite-os.

  5. Deixe o watcher trabalhar O Maestro utiliza um watcher. Quando você salva um arquivo em build/, ele atualiza automaticamente o arquivo correto no diretório kits/.

  6. Teste suas alterações Primeiro, pare o processo kit:run. Você não pode executar testes enquanto o kit estiver rodando. A partir da pasta orchestrator/, execute:

  • composer kits:pint (para formatação)
  • composer kits:check (para testes PHP)
  • composer kits:lint (para testes JavaScript)
  1. Realize o commit do seu trabalho Verifique o status do seu git. Você deve ver alterações na pasta kits/. Adicione apenas o diretório kits/ ao seu commit.

Exemplo: Alterando o texto de "Log in" para "Log on"

  • Edite o arquivo blade ou de componente dentro de build/.
  • Aguarde o watcher atualizar o kits/.
  • Execute os testes para garantir que você não quebrou outras variantes.
  • Faça o commit dos arquivos em kits/.

Este processo garante que sua contribuição permaneça limpa e siga a arquitetura do Maestro.

Fonte: https://dev.to/catatsumuri/laravel-maestro-contributor-tutorial-2p89