diff --git a/docs/changelog.md b/docs/changelog.md index 402e75e7..e9d04422 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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 diff --git a/docs/reference/yaml-template.md b/docs/reference/yaml-template.md index cb9e8473..6a670197 100644 --- a/docs/reference/yaml-template.md +++ b/docs/reference/yaml-template.md @@ -145,7 +145,6 @@ reviews: enabled: true htmlhint: enabled: true - config_file: "" checkmake: enabled: true chat: diff --git a/docs/tools/flake8.md b/docs/tools/flake8.md new file mode 100644 index 00000000..b0a29761 --- /dev/null +++ b/docs/tools/flake8.md @@ -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'; + + +``` + +[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) diff --git a/docs/tools/list.md b/docs/tools/list.md index bfe5e5ce..b7a103b0 100644 --- a/docs/tools/list.md +++ b/docs/tools/list.md @@ -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 | @@ -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