AI Reviewer
AI Reviewer is a VS Code extension that provides AI-powered code reviews before pushing your diffs. This extension uses OpenAI's GPT-4-turbo model to analyze your code changes and provide feedback.
Features
- Analyze diffs using OpenAI's GPT-4-turbo model.
- Supports multiple languages for feedback.
- Customize the OpenAI model, max tokens, and other parameters through settings.
- Provides clear and concise feedback in the output channel.
- Displays changed file paths in the output channel.
Installation
- Install the extension from the Visual Studio Code Marketplace.
- Configure your OpenAI API key and other settings in the VS Code settings.
Usage
- Open your project in VS Code.
- Make some changes to your code.
- Stage your changes using the source control panel.
- Run the command
AI Review
from the command palette (Ctrl+Shift+P
or Cmd+Shift+P
).
- View the AI-generated review feedback in the
AI Reviewer
output channel.
Settings
You can customize the behavior of the AI Reviewer extension through the following settings:
aiReviewer.openaiApiKey
: The API key for OpenAI. This is required to use the extension.
aiReviewer.language
: The language for the feedback. Supported languages are Korean, English, Chinese, Japanese, Spanish, French, and German. Default is Korean.
aiReviewer.model
: The model to use for generating feedback. Supported models are gpt-4o
, gpt-4o-mini
, gpt-4-turbo
, gpt-4
, gpt-4-32k
, gpt-3.5-turbo-16k
, and gpt-3.5-turbo
. Default is gpt-4-turbo
.
aiReviewer.diffCount
: The maximum length of the diff to send to the OpenAI API. Default is 1000 words.
aiReviewer.excludeFileExtensions
: A list of file extensions to exclude from analysis.
aiReviewer.excludeFolders
: A list of folders to exclude from analysis.
Example Settings
{
"aiReviewer.openaiApiKey": "your-openai-api-key",
"aiReviewer.language": "Korean",
"aiReviewer.model": "gpt-4-turbo",
"aiReviewer.diffCount": 1000,
"aiReviewer.excludeFileExtensions": ["json"],
"aiReviewer.excludeFolders": ["node_modules", "build", "res"]
}
Contributing
Contributions are welcome! If you find a bug or have a feature request, please open an issue on the GitHub repository. If you would like to contribute code, please fork the repository and submit a pull request.
License
This project is licensed under the MIT License. See the LICENSE file for details.
For any inquiries, please contact us at jhchoi07.