-
Notifications
You must be signed in to change notification settings - Fork 39
docs: add Flake8, PHPMD, PHPCS to template & reference (#428) #429
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
Open
hardikkgupta
wants to merge
2
commits into
coderabbitai:main
Choose a base branch
from
hardikkgupta:docs/add-flake8-phpmd-phpcs-428
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+166
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
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/en/latest/) is a static code analysis tool for Python that wraps PyFlakes (error detection), pycodestyle (PEP 8 style rules) and McCabe (cyclomatic-complexity measurement) to catch a wide range of issues in a single pass. | ||
|
||
## Supported Files | ||
|
||
Flake8 runs on files with the following extension: | ||
|
||
- `*.py` | ||
|
||
## Features | ||
Flake8 can detect many issues, including: | ||
|
||
- PEP 8 style-guide violations | ||
- Unused or re-defined variables and imports | ||
- Undefined names / variables | ||
- Cyclomatic-complexity over threshold (default 10) | ||
- Error-prone constructs (e.g., comparison to literal True / False) | ||
- Select / ignore rule filtering (`--select`, `--extend-ignore`) | ||
- Extensible plugin ecosystem and custom rule support | ||
|
||
## Links | ||
|
||
- [Flake8 Official Website](https://flake8.pycqa.org/en/latest/) | ||
- [Flake8 PyPI Page](https://pypi.org/project/flake8/) | ||
- [Flake8 GitHub Repository](https://github.com/PyCQA/flake8) | ||
- [User Guide](https://flake8.pycqa.org/en/latest/) |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was already added in durring
https://github.com/coderabbitai/coderabbit-docs/pull/431/files