Reviwr CLI

Reviwr CLI é uma ferramenta de linha de comando que utiliza Inteligência Artificial para facilitar análises de código e geração de documentação com base em diretrizes configuráveis. Essa CLI foi desenvolvida para aumentar a produtividade e a padronização de práticas no desenvolvimento de software.

A documentação oficial está aqui

Instalação

Instalação Global com npm

Para instalar a CLI globalmente, use o seguinte comando no terminal:

npm install -g reviwr-cli

Pré-requisitos:

• Node.js (versão 20.17.0 ou superior) deve estar instalado na máquina

Execução Local

Passos para executar o projeto localmente:

1. Clonar o repositório:

   git clone https://github.com/reviwr/reviwr.git
   ou 
   git clone [email protected]:reviwr/reviwr.git
   cd reviwr-cli

2. Instalar dependências:

   npm install

3. Compilar o projeto:

   npm run build

4. Criar um link simbólico para executar a CLI localmente:

   npm link

5. Testar os comandos:

   rwr config

Configuração Inicial

Antes de utilizar a ferramenta, é necessário configurar uma chave API válida para acessar os serviços de IA. Por default a CLI utiliza o modelo gpt-4-mini.

Como Obter a Chave API

1. Acesse o site da OpenAI
2. Faça login ou crie uma conta
3. No painel principal, vá até a seção API Keys
4. Clique em Criar nova chave secreta
5. Copie a chave gerada e salve-a em um local seguro

Configuração da Chave API

Execute o comando:

rwr config

Este comando irá:

• Solicitar e armazenar a chave API
• Criar a estrutura inicial de diretórios e arquivos para personalização de diretrizes

Comandos Disponíveis

1. Configurar Chave API

rwr config

Ações:

• Solicita e armazena a chave API
• Cria estrutura inicial de personalização:
  • rwr/review-directives.md
  • rwr/docs-directives.md

2. Revisar Mudanças no Repositório Git

rwr review-changes

Ações:

• Analisa todas as modificações no repositório que estão modificadas atráves do git diff
• Gera relatório com:
  • Qualidade do código
  • Boas práticas de desenvolvimento
  • Possíveis vulnerabilidades
  • Baseado em diretrizes configuradas em rwr/review-directives.md

3. Revisar Arquivo Específico

rwr review-file <caminho-do-arquivo>

Ações:

• Analisa um arquivo específico
• Retorna relatório com:
  • Sugestões de melhoria
  • Débitos técnicos
  • Ajustes estruturais necessários
  • Baseado em diretrizes configuradas em rwr/review-directives.md

4. Gerar Documentação de Código

rwr gen-docs <caminho-do-arquivo>

Ações:

• Gera documentação do arquivo em Markdown
• Baseado em diretrizes configuradas em rwr/docs-directives.md

Customização

Arquivos de diretrizes permitem personalizar análises e mensagens:

• Diretrizes de Revisão: rwr/review-directives.md

  • Configura diretrizes para análise de código

• Diretrizes de Documentação: rwr/docs-directives.md

  • Especifica geração de documentações

Estrutura de Saída

Resultados são armazenados em rwr/results:

• file-review-<fileName>.md: Relatórios de análise de arquivos
• docs-<fileName>.md: Documentação gerada em Markdown

Testes

Utilizando Jest:

npm run test

npm run test:cov

Logs

Logs armazenados em rwr/logs usando a biblioteca Winston.

Publicação

Disponível no npm: https://www.npmjs.com/package/reviwr-cli

Licença

Licenciado sob MIT License. Consulte o arquivo LICENSE no repositório.