Skip to content

Feat/flake8 #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@ description: The latest updates and changes to CodeRabbit.
sidebar_position: 13
---

## July 3, 2025

### Enhanced Python Static Analysis: Flake8 Support

We're excited to announce enhanced Python static analysis capabilities with [Flake8](https://flake8.pycqa.org/) support!

[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.

See our [tools documentation](https://docs.coderabbit.ai/tools/) for more details.

## July 1, 2025

### Enhanced Code Guidelines Support
Expand Down
1 change: 0 additions & 1 deletion docs/reference/yaml-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ reviews:
enabled: true
htmlhint:
enabled: true
config_file: ""
checkmake:
enabled: true
chat:
Expand Down
36 changes: 36 additions & 0 deletions docs/tools/flake8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Flake8
sidebar_label: Flake8
description: CodeRabbit's guide to Flake8.
---

```mdx-code-block
import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
<ProPlanNotice />
```

[Flake8](https://flake8.pycqa.org/) is a Python linting utility that wraps PyFlakes, pycodestyle, and Mccabe to check your Python code for style and logical errors.

## Supported Files

Flake8 will run on files with the following extensions:

- `*.py`

## Features

Flake8 can detect many issues such as:

- Style violations (PEP 8)
- Logical errors and unused imports
- Code complexity issues
- Syntax errors
- And many more

## Links

- [Flake8 Official Website](https://flake8.pycqa.org/)
- [Flake8 GitHub Repository](https://github.com/pycqa/flake8)
- [Flake8 Documentation](https://flake8.pycqa.org/en/latest/)
- [Flake8 Configuration](https://flake8.pycqa.org/en/latest/user/configuration.html)
3 changes: 2 additions & 1 deletion docs/tools/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
| Plaintext | [LanguageTool][LanguageTool] | Grammar and Spell Checking |
| Java | [PMD][PMD] | Code Quality |
| Protobuf | [Buf][Buf] | Code Quality |
| Python | [Ruff][Ruff], [Pylint][Pylint] | Code Quality |
| Python | [Ruff][Ruff], [Pylint][Pylint], [Flake8][Flake8] | Code Quality |
| Regal | [Regal][Regal] | Code Quality |
| Ruby | [RuboCop][RuboCop], [Brakeman][Brakeman] | Code Quality, Code Security |
| Rust | [Clippy][Clippy] | Code Quality |
Expand Down Expand Up @@ -86,3 +86,4 @@ For an overview of how CodeRabbit uses these tools when generating code reviews,
[Checkmake]: /tools/checkmake.md
[PHPMD]: /tools/phpmd.md
[PHPCS]: /tools/phpcs.md
[Flake8]: /tools/flake8.md