bemijonathan/code-critique-ai

AutoReviewer is an automated code review tool that helps developers to maintain code quality and consistency in their projects. It uses the OpenAI API to analyze code and provide feedback on coding standards, best practices, and potential issues.

Code Critique

Code Critique is an AI-powered command-line interface (CLI) tool that helps review code in projects before raising pull requests (PRs). It helps reduce the time spent on code reviews.

Features

• AI code reviews
• Version control integration
• Security reviews
• Architecture reviews

Introduction

Using OpenAI, Code Critique reviews changes in files, criticizes bad coding habits, and suggests improvements. This significantly reduces the number of required corrections.

Constraints and Limitations

• File size limitations
• Errors and timeouts
• Slower response time due to ChatGPT

Installation

npm install -g ai_code_review

Usage

code_review

all criticism is put in a file called feedback.md

Changing API keys

to change your API key use this command

code_review --clear_api_key

using github

if you want to review only your git changes add this configuration file to the root of your document.

// codereview.json
{
    "name": "",
    "description": "",
    "git": true,
    "defaultBranch": "master"
}

Roadmap

• AI code reviews
• Version control integration
• Security reviews
• Architecture reviews

Todo

• Git integration
• Retrieve files and send them to OpenAI
• Receive responses from OpenAI
• Send responses to the user
• Create an npm module
• Publish the module
• Set up continuous integration
• Add support for Vue.js
• Move reviewed code from feedback.txt to locally hosted html and css
• Bugs, context and file structure

Contributing

License