O que code-review-skill faz?
Automatize revisões de código para projetos de código geral com verificações modulares paralelas, escopo orientado por configuração e relatórios claros.
Visão Geral
Esta skill automatiza revisões de código para projetos de software em geral. Ela realiza verificações modulares em paralelo, permitindo rápida identificação de problemas de qualidade de código, segurança e conformidade com boas práticas.
Como Funciona
- Configuração: Você define um arquivo de configuração (ex.:
review-config.json) no diretório raiz do seu projeto, especificando quais verificações executar e em quais pastas ou arquivos. - Execução: A skill executa cada verificação de forma paralela, utilizando ferramentas como linters, scanners de segurança, analisadores de complexidade, etc.
- Resultados: Um relatório claro é gerado, geralmente em formato Markdown ou JSON, listando problemas encontrados, sua severidade e sugestões de correção.
Configuração
Exemplo de arquivo review-config.json:
{
"checks": [
"lint",
"security",
"complexity",
"best-practices"
],
"scope": [
"src/**/*.js",
"!src/vendor/**"
],
"parallel": true
}
Plataformas Suportadas
- Claude Code
- Cursor
- Codex
- Qualquer ambiente com suporte a Node.js e CLI
Requisitos
- Node.js 16.x ou superior
- Permissões de leitura para os arquivos a serem revisados
Como Usar
- Certifique-se de que o arquivo de configuração está presente.
- Execute a skill através do comando:
npx code-review-skill run - Visualize o relatório gerado na pasta
./reports/.
Exemplo de Saída
# Relatório de Revisão de Código
## Verificação: Lint
- arquivo: src/app.js, linha 42: variável não utilizada `x` (severidade: baixa)
- arquivo: src/utils.js, linha 15: indentação inconsistente (severidade: baixa)
## Verificação: Segurança
- arquivo: src/auth.js, linha 23: uso de eval() (severidade: alta) - **Sugestão**: evitar eval() para prevenir injeção de código.
Contribuição
Contribuições são bem-vindas! Por favor, abra um pull request ou issue no repositório.
Licença
MIT