Laravel + Docker sem Sail: simplifique seus testes e muito mais com o Compass

Olá, amigos! 👋

Se você é um desenvolvedor Laravel que utiliza Docker sem o Sail, sabe que algumas tarefas podem ser um pouco mais trabalhosas. Mas não se preocupe, pois hoje trago uma solução completa que vai facilitar sua vida: o Compass, um script shell que criei para agilizar as operações no container e turbinar seu fluxo de trabalho.

O que é o Compass?

O Compass é uma ferramenta de linha de comando projetada para simplificar a interação com projetos Docker Compose, especialmente focado em projetos Laravel. Ele fornece uma interface conveniente para executar comandos comuns de desenvolvimento e manutenção diretamente através de um único ponto de entrada.

Por que criei se existe o Sail?

O Compass nasceu da minha experiência em um projeto Laravel que utilizava Docker, mas onde o Sail não era uma opção viável… digamos que o conhecimento sobre Docker do gerente de infraestrutura não era exatamente “notável” 😅 (quem nunca?). A constante necessidade de acessar o shell do Docker para executar comandos básicos me motivou a criar uma ferramenta mais ágil e eficiente.

Em outras palavras, o Compass é a prova de que a necessidade é a mãe da invenção… e às vezes, a falta de conhecimento alheia é a madrinha!

Se você também já se sentiu frustrado com a complexidade de gerenciar um ambiente Laravel com Docker sem o Sail, o Compass pode ser a solução que você procurava!

Com o Compass, você pode:

• Executar comandos Artisan e Composer.
• Rodar testes, inclusive em todas as branches do projeto.
• Gerenciar serviços Docker, como iniciar, parar e reiniciar containers.
• Executar tarefas de manutenção do projeto, como otimizar o desempenho ou atualizar dependências.

Como instalar o Compass

O processo de instalação é simples e direto:

1- Clone o Repositório:

Na raiz do seu projeto Laravel, execute:

git clone https://github.com/aeusteixeira/compass.git compass

Isso criará uma pasta chamada compass com o script.

2- Permissões de Execução:

Dê permissão de execução ao script:

chmod +x compass/compass

Para facilitar o uso, você pode criar um alias temporário:

alias compass='./compass/compass'

Para tornar o alias permanente, adicione a linha acima ao arquivo de configuração do seu shell (como ~/.bashrc ou ~/.zshrc).

Configuração Importante:

Abra o arquivo compass/compass e verifique se o nome do serviço PHP definido na variável SERVICE_NAME corresponde ao nome do serviço no seu docker-compose.yml. O padrão é “app“, mas pode ser necessário ajustar conforme seu projeto.

Usando o Compass

Com o Compass instalado, você pode executar uma variedade de comandos diretamente do terminal. Alguns dos comandos mais úteis incluem:

Docker:

• up – Inicia todos os serviços em modo detached.
• down – Para e remove todos os containers e redes.
• restart – Reinicia todos os serviços.
• logs – Exibe os logs dos serviços.

Laravel:

• artisan – Executa comandos Artisan.
• test – Executa os testes.
• test:all – Executa os testes em todas as branches.
• migrate – Executa as migrations.

Gerenciamento de Projeto:

• install – Instala as dependências do projeto.
• optimize – Otimiza o desempenho do aplicativo.
• analyze – Executa análise estática de código com Larastan.

Documentação

Pois bem, o projeto foi projetado para ser flexível, adaptando-se às suas necessidades específicas. Seja você um iniciante ou um desenvolvedor experiente, o Compass tem algo a oferecer. Para explorar todas as funcionalidades, comandos disponíveis e personalizações, confira a documentação completa no repositório.

Assim, você terá todas as informações de que precisa para aproveitar ao máximo essa ferramenta e simplificar sua experiência com Docker e Laravel.

Links importantes:

• aeusteixeira/compass: Ferramenta de linha de comando para simplificar o desenvolvimento Laravel com Docker Compose (github.com)