Skip to content

About

🚀 Boilerplate de Code Review automatizado com IA (Claude & OpenAI) via pre-commit. Focado no ecossistema React (Next.js, Vite, CRA) com validações de segurança, arquitetura, a11y e testes.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

AI Code Review Boilerplate 🤖

Sistema de revisão de código automatizado com IA (Claude + OpenAI) integrado ao pre-commit hook do Git. Totalmente tipado em TypeScript, com detecção automática e suporte completo para o ecossistema React.


⚡ Instalação & Setup Global

Para poder injetar e usar o code review em qualquer projeto do seu computador, você só precisa fazer o setup global uma vez:

# 1. Entre na pasta do boilerplate
cd /Users/marcustorres/Desktop/ia-code-review

# 2. (Opcional) Crie o arquivo .env para utilizar APIs de nuvem
cp .env.example .env # Opcional: configure ANTHROPIC_API_KEY ou OPENAI_API_KEY

# 3. Instale as dependências locais
npm install

# 4. Registre o comando globalmente no seu sistema
npm link

Pronto! Agora o comando ia-review está disponível em qualquer terminal do seu computador.


🚀 Como Injetar em Qualquer Projeto

Para ativar a revisão automática (pre-commit hook) no repositório de qualquer projeto React, Next.js, etc:

# 1. Vá até a pasta do seu projeto alvo
cd /caminho/do/seu/projeto-alvo

# 2. Rode o comando de setup
ia-review --setup

Isso criará o hook .git/hooks/pre-commit apontando para o seu CLI. A partir desse momento, cada git commit executará o code review automaticamente antes de efetivar o commit!


🛠️ Como Executar Manualmente

Você também pode rodar revisões sob demanda a qualquer momento na pasta de qualquer projeto:

# Executa a revisão padrão (segurança + geral + a11y) no git diff atual
ia-review

# Executa o review completo (segurança + geral + arquitetura + roda os testes do projeto)
ia-review --full

# Executa apenas o check de segurança
ia-review --security

# Executa apenas a análise de arquitetura
ia-review --arch

📦 Ecossistemas React Suportados

O revisor possui um detector inteligente (src/detector.ts) que identifica o framework do projeto alvo e adapta as instruções e prompts da IA dinamicamente:

  • Next.js (App Router): Valida Server vs Client Components, diretivas "use client"/"use server", Metadata API, Route Handlers, e performance de layouts.
  • Next.js (Pages Router): Valida getServerSideProps e tipos de rotas clássicas.
  • Vite + React: Valida HMR, variáveis de ambiente prefixadas com VITE_, import.meta.env, splitting com React.lazy.
  • React Router v6/v7: Valida loaders, actions, nested routes, layouts, e consumo correto de loaders com useLoaderData.
  • Create React App (CRA): Identifica e sugere melhorias específicas para builds legadas.

📋 O que é Revisado

1. 🏗️ Arquitetura & Clean Code

  • Separação de conceitos (Custom Hooks para lógica pesada de API/Estado, mantendo componentes visuais puros)
  • Evitar renders desnecessários (useMemo, useCallback)
  • Otimização de renderização e isolamento de efeitos colaterais usando useRef
  • Tipagem TypeScript estrita (sem any)

2. ♿ Acessibilidade (a11y)

  • Elementos customizados clicáveis (div, span) obrigatoriamente com role="button", tabIndex={0} e escuta de eventos onKeyDown (Enter/Espaço)
  • Atributos ARIA adequados e gerenciamento de foco para Modais, Dropdowns e Abas

3. 🔒 Segurança

  • Exposição acidental de tokens e chaves de API (process.env obrigatório)
  • Validação estrita de schemas em runtime usando TypeScript/Zod
  • Sanitização de dados injetados via dangerouslySetInnerHTML

4. 🧪 Testes Automatizados

  • Auto-detecção e execução da suíte de testes do projeto (Vitest, Jest, npm test). Em caso de falha de build/teste, a IA analisa a stack do erro e propõe a solução no relatório final.

⚙️ Configuração Centralizada

Toda a lógica e parametrização do review global está em review.config.ts. Você pode alterar:

  • Qualidade/Modelo da IA (AI_PROVIDER=claude ou openai)
  • Severidade mínima para travar commits (BLOCK_ON_SEVERITY=high)
  • Extensões e caminhos a serem ignorados

📄 Licença

MIT

About

🚀 Boilerplate de Code Review automatizado com IA (Claude & OpenAI) via pre-commit. Focado no ecossistema React (Next.js, Vite, CRA) com validações de segurança, arquitetura, a11y e testes.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages