eduardaleal/laravel-clean-flow

There is no license information available for the latest version (v2.2.0) of this package.

Biblioteca para geração de arquitetura limpa (Controller -> Service -> Repository) no Laravel.

v2.2.0 2026-03-11 21:59 UTC

Requires

• illuminate/console: ^10.0 || ^11.0 || ^12.0
• illuminate/support: ^10.0 || ^11.0 || ^12.0

Requires (Dev)

• orchestra/testbench: ^8.0 || ^9.0 || ^10.0
• pestphp/pest: ^2.0 || ^3.0 || ^4.0
• pestphp/pest-plugin-laravel: ^2.0 || ^3.0 || ^4.0

Unknown License

README

Esta ferramenta automatiza a criação de arquivos baseados no padrão Controller → Service → Repository, e também facilita a criação de Views (Blade e Vue), garantindo a aplicação de Clean Code, princípios SOLID e Injeção de Dependência logo no momento da geração do código.

🎯 Nossa Filosofia (Regras de Ouro)

Para manter nossos sistemas escaláveis e fáceis de dar manutenção, este pacote força as seguintes diretrizes:

1. Controllers Enxutos: O Controller serve apenas para receber a requisição HTTP e devolver a resposta. Nunca escreva regras de negócio aqui.
2. Services (Regras de Negócio): Toda lógica, cálculos, envio de e-mails e processos complexos moram na camada de Service.
3. Repositories (Banco de Dados): O acesso aos dados fica estritamente isolado nos Repositories. O Service pede os dados para o Repository.
4. Injeção de Dependência: As classes geradas interagem através de injeção no construtor, facilitando a criação de Mocks e testes unitários. Não utilizamos métodos estáticos para regras de negócio.
5. Padrão de Nomenclatura: Todos os métodos, funções e variáveis geradas utilizam o padrão snake_case.
6. Documentação Rigorosa: Todos os métodos gerados já incluem DocBlocks detalhados (@param, @return, @throws).

⚙️ Instalação

Como o pacote está publicado no Packagist, a instalação em qualquer projeto novo é feita com um único comando:

composer require eduardaleal/laravel-clean-flow

Nota para ambientes conteinerizados: Se o seu projeto estiver rodando com Docker (por exemplo, via Laravel Sail), lembre-se de rodar ./vendor/bin/sail composer require eduardaleal/laravel-clean-flow.

A biblioteca utiliza o recurso de Auto-Discovery do Laravel, portanto, nenhum Service Provider precisa ser registrado manualmente. Instalou, está pronto para usar!

📦 Comandos Disponíveis

1. O Comando Mestre: make:flow ⭐ Recomendado

Gera o ecossistema completo de uma nova funcionalidade de uma só vez, interligando todas as camadas corretamente.

php artisan make:flow Agendamento

O que ele cria:

Arquivo	Caminho
Model	app/Models/Agendamento.php
Repository	app/Repositories/AgendamentoRepository.php
Service	app/Services/AgendamentoService.php
Controller	app/Http/Controllers/AgendamentoController.php

• O Repository já vem com listagem paginada em snake_case plural: get_paginated_agendamentos
• O Service já vem com o método principal process_agendamento e injeção do Repository
• O Controller já vem com o Service injetado no construtor de forma limpa

2. Criando Apenas um Service: make:service

Gera uma camada de serviço isolada. A biblioteca adiciona o sufixo Service automaticamente caso você esqueça.

php artisan make:service RelatorioFinanceiro

O que ele gera: Um arquivo RelatorioFinanceiroService.php contendo:

• Estrutura base orientada a objetos (sem métodos estáticos)
• Método principal nomeado dinamicamente: process_relatorio_financeiro
• DocBlocks com lembretes arquiteturais para uso de Transactions (DB) em operações críticas e Queues/Jobs para envios demorados

3. Criando Apenas um Repository: make:repository

Gera uma classe isolada focada na camada de persistência.

php artisan make:repository Cliente

O que ele gera: Um arquivo ClienteRepository.php contendo:

• Importação automática do Model Cliente
• Método estruturado para paginação
• DocBlocks educativos alertando a equipe sobre o uso de Cache, Indexação nas tabelas e o perigo de não utilizar Paginação em tabelas extensas

4. Criando Arquivos de View: make:view 🎨 Novo

Gera arquivos de interface visual (.blade.php ou .vue) organizados na estrutura de pastas de recursos do seu projeto. Muito útil para quem trabalha com Inertia.js ou componentes Blade.

Exemplos de uso:

# Cria uma view Blade padrão (resources/views/profile.blade.php)
php artisan make:view profile

# Cria um componente Blade (resources/views/components/button.blade.php)
php artisan make:view button --component

# Cria uma página Vue/Inertia (resources/js/Pages/Dashboard.vue)
php artisan make:view Dashboard --vue

# Cria um componente Vue (resources/js/Components/Modal.vue)
php artisan make:view Modal --vue --component

Como funciona a estrutura de pastas gerada:

Opção	Caminho para Blade (Padrão)	Caminho para Vue (--vue)
(Nenhuma)	resources/views/NomeView.blade.php	resources/js/Pages/NomeView.vue
--component	resources/views/components/NomeView.blade.php	resources/js/Components/NomeView.vue
--template	resources/views/templates/NomeView.blade.php	resources/js/Templates/NomeView.vue

💡 Boas Práticas Pós-Geração

O código gerado é um molde perfeito, mas a responsabilidade de mantê-lo limpo é sua. Siga estas dicas ao preencher a lógica:

Respostas da API No Controller, ao devolver a resposta do Service, planeje sempre o uso de API Resources (php artisan make:resource) para padronizar o retorno JSON e pensar no versionamento da API.

Transações No Service, se for salvar múltiplos registros dependentes (ex: criar um usuário e gerar a fatura dele logo em seguida), descomente o bloco DB::beginTransaction() e DB::commit() fornecido no stub.