O que brooks-lint faz?
Revisões de código com IA fundamentadas em 10 livros clássicos de engenharia — diagnósticos de risco de deterioração com citações de livros, etiquetas de gravidade e 4 modos de análise.
Visão Geral
O brooks-lint usa modelos de linguagem de IA (como Claude ou Codex) para analisar trechos de código e identificar riscos de deterioração com base em ensinamentos de 10 livros essenciais de engenharia de software:
- The Mythical Man-Month (Fred Brooks)
- The Pragmatic Programmer (Hunt & Thomas)
- Clean Code (Robert C. Martin)
- Design Patterns (GoF)
- Refactoring (Martin Fowler)
- Working Effectively with Legacy Code (Michael Feathers)
- Code Complete (Steve McConnell)
- The Art of Readable Code (Boswell & Foucher)
- Domain-Driven Design (Eric Evans)
- The Clean Coder (Robert C. Martin)
Modos de Análise
| Modo | Descrição | Uso recomendado |
|---|---|---|
| padrão | Análise completa com citações de livros e etiquetas de gravidade | Revisões regulares de código |
| rápido | Verificação superficial sem citações, apenas rótulos de risco | Revisões rápidas ou grandes PRs |
| completo | Análise detalhada com citações, gravidade e sugestões de refatoração | Código crítico ou complexo |
| personalizável | Permitir que o usuário escolha livros ou regras específicas | Revisões especializadas |
Etiquetas de Gravidade
- 🔴 Crítico — Risco iminente de falha ou violação grave de princípios
- 🟠 Alto — Deterioração significativa, recomendada ação imediata
- 🟡 Médio — Preocupação notável, planejar melhoria
- 🟢 Baixo — Sugestão menor, pode ser ignorada
Como Usar
- Execute o skill
hyhmrright/brooks-lintcom o código a ser analisado. - Escolha um modo de análise:
rápido,padrão,completooupersonalizável. - Receba o relatório com citações, gravidade e recomendações.
Exemplo de Uso
> hyhmrright/brooks-lint --mode completo --code "def foo(x): return x * 2"
Plataformas Suportadas
- Claude Code
- Cursor
- Codex
Limitações
- Depende da qualidade do modelo de IA subjacente.
- As citações são baseadas nos livros, mas podem não ser exatas em todos os casos.
- O modo rápido não fornece citações.
Contribuição
Veja CONTRIBUTING.md para detalhes sobre como contribuir.
Licença
MIT