feature: Implement File Extension Exclusion and Individual File Reviews with Enhanced ChatGPT4 Prompt

[kmesiab]

Description

The quality of code reviews introduced by this PR has VASTLY improved over previous versions, even with less capable models

This pull request introduces significant improvements to the ai-code-critic application, focusing on enhancing the flexibility and effectiveness of the code review process. The key features added in this update include customizable file exclusion based on extensions, individual file analysis within diffs, and an improved prompt for ChatGPT4 to ensure more relevant and actionable feedback.

Changes

• Customizable File Exclusion: Users can now specify a list of file extensions to exclude from code reviews. This feature allows for targeted reviews by focusing on relevant files, thereby improving the efficiency of the review process.

• Individual File Analysis: The application now processes each file in a Git diff separately, ensuring detailed and specific feedback for each file. This change enhances the thoroughness and relevance of the code reviews.

• Enhanced ChatGPT4 Prompt: The prompt sent to ChatGPT4 has been optimized to extract more detailed, useful, and contextually relevant feedback, covering aspects such as technical accuracy, best practices, performance, and maintainability.

POTENTIALLY BREAKING CHANGE

The newly introduced configuration property IGNORE_FILES should be set to a comma separated list of file extensions, including the leading period. (ex: .txt,.sum,.mod)

Additional Notes

Feedback and contributions to this update are highly encouraged. This enhancement aims to make the ai-code-critic application a more powerful tool for developers in maintaining high-quality codebases.

---

Looking forward to your reviews and comments on these changes!

--

Addresses

https://github.com/kmesiab/ai-code-critic/issues/48

Summary by CodeRabbit

• New Features

  • Introduced a new section in the documentation for excluding specific files from code reviews.
  • Added functionality to parse GitHub pull request URLs and Git diffs.
  • Updated code review prompts to include comprehensive considerations and markdown output format.

• Enhancements

  • Improved error handling and default value setup for code review configuration.
  • Enhanced test coverage for file path manipulation, environment variable handling, and Git diff parsing.

• Refactor

  • Reorganized logic in main application file to optimize pull request processing and code review retrieval.

• Documentation

  • Updated README with instructions for setting ignore files in code reviews.

[coderabbitai[bot]]

Walkthrough

The project has been updated to enhance code review processes by ignoring specific file types, parsing GitHub pull requests, handling Git diffs, and integrating a more comprehensive code review prompt. New configurations and tests ensure robustness, while the main logic now processes diffs in parallel for efficiency.

Changes

File Path	Change Summary
README.md	Added instructions for setting ignore files in code reviews.
internal/config.go	Imported strings, added timeout constant and IgnoreFiles field, updated GetConfig.
internal/config_test.go, internal/github_test.go	Renamed constants, added new tests.
internal/github.go	Added GitDiff struct and functions for parsing Git diffs and GitHub PR URLs.
internal/openai.go	Enhanced GetCodeReviewFromAPI prompt for detailed code reviews.
main.go	Updated to handle PR parsing and diff processing in goroutines.

Poem

In the burrows of the code, a rabbit hopped along, Tweaking tools with paws adept, making them strong. With each diff and pull, it danced in delight, For clean code and swift reviews, it leaped to great height. 🐇💻✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

---

Tips

### Chat There are 3 ways to chat with CodeRabbit: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit tests for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.