From 15e6d467e8383a9102eca18fe65faf86800a31c5 Mon Sep 17 00:00:00 2001
From: electricplayer <40640596+electricplayer@users.noreply.github.com>
Date: Wed, 2 Jul 2025 23:58:15 -0500
Subject: [PATCH 1/2] docs: add Flake8, PHPMD, PHPCS to template & reference
 (fix #428)

---
 docs/reference/configuration.md | 123 ++++++++++++++++++++++++++++++++
 docs/reference/yaml-template.md |   6 ++
 docs/tools/flake8.md            |  37 ++++++++++
 3 files changed, 166 insertions(+)
 create mode 100644 docs/tools/flake8.md

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
index 5109ba5a..965491eb 100644
--- a/docs/reference/configuration.md
+++ b/docs/reference/configuration.md
@@ -2850,6 +2850,47 @@ ESLint is a static code analysis tool for JavaScript files.
 
 ESLint is a static code analysis tool for JavaScript files.
 
+### Flake8
+
+Flake8 is a static code analysis tool for Python files.
+
+#### Enable Flake8
+
+<Tabs groupId="config-setting">
+  <TabItem value="web-ui" label="Web UI">
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Location</strong></td>
+        <td>Review &gt; Tools &gt; Enable Flake8</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+  <TabItem value="yaml" label=".coderabbit.yaml" default>
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Field</strong></td>
+        <td>`reviews.tools.flake8.enabled`</td>
+      </tr>
+      <tr>
+        <td><strong>Datatype</strong></td>
+        <td>boolean</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+</Tabs>
+
+Flake8 is a static code analysis tool for Python files.
+
 ### GitHub Checks
 
 GitHub Checks integration configuration.
@@ -3671,6 +3712,88 @@ PMD is an extensible multilanguage static code analyzer. It’s mainly concerned
 
 Enable PMD.
 
+### PHPMD
+
+PHPMD is a static code analysis tool for PHP files.
+
+#### Enable PHPMD
+
+<Tabs groupId="config-setting">
+  <TabItem value="web-ui" label="Web UI">
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Location</strong></td>
+        <td>Review &gt; Tools &gt; Enable PHPMD</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+  <TabItem value="yaml" label=".coderabbit.yaml" default>
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Field</strong></td>
+        <td>`reviews.tools.phpmd.enabled`</td>
+      </tr>
+      <tr>
+        <td><strong>Datatype</strong></td>
+        <td>boolean</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+</Tabs>
+
+PHPMD is a static code analysis tool for PHP files.
+
+### PHPCS
+
+PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.
+
+#### Enable PHPCS
+
+<Tabs groupId="config-setting">
+  <TabItem value="web-ui" label="Web UI">
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Location</strong></td>
+        <td>Review &gt; Tools &gt; Enable PHPCS</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+  <TabItem value="yaml" label=".coderabbit.yaml" default>
+    <table>
+      <tbody>
+      <tr>
+        <td><strong>Field</strong></td>
+        <td>`reviews.tools.phpcs.enabled`</td>
+      </tr>
+      <tr>
+        <td><strong>Datatype</strong></td>
+        <td>boolean</td>
+      </tr>
+      <tr>
+        <td><strong>Default</strong></td>
+        <td>true</td>
+      </tr>
+    </tbody></table>
+  </TabItem>
+</Tabs>
+
+PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
+
 #### Config File
 
 <Tabs groupId="config-setting">
diff --git a/docs/reference/yaml-template.md b/docs/reference/yaml-template.md
index cb9e8473..67aa96ff 100644
--- a/docs/reference/yaml-template.md
+++ b/docs/reference/yaml-template.md
@@ -107,6 +107,8 @@ reviews:
       config_file: ""
     eslint:
       enabled: true
+    flake8:
+      enabled: true
     rubocop:
       enabled: true
     buf:
@@ -118,6 +120,10 @@ reviews:
     pmd:
       enabled: true
       config_file: ""
+    phpmd:
+      enabled: true
+    phpcs:
+      enabled: true
     cppcheck:
       enabled: true
     semgrep:
diff --git a/docs/tools/flake8.md b/docs/tools/flake8.md
new file mode 100644
index 00000000..af38dc42
--- /dev/null
+++ b/docs/tools/flake8.md
@@ -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/)
\ No newline at end of file

From 5871712fadde2e186f9e3d7dbb5aed4eca8ff71f Mon Sep 17 00:00:00 2001
From: electricplayer <40640596+electricplayer@users.noreply.github.com>
Date: Thu, 3 Jul 2025 15:43:04 -0500
Subject: [PATCH 2/2] docs: wrap / --extend-ignore (review feedback)

---
 docs/reference/configuration.md | 50 ++++++++++++++++-----------------
 docs/tools/flake8.md            |  2 +-
 2 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
index 965491eb..bd0b3e8e 100644
--- a/docs/reference/configuration.md
+++ b/docs/reference/configuration.md
@@ -2862,7 +2862,7 @@ Flake8 is a static code analysis tool for Python files.
       <tbody>
       <tr>
         <td><strong>Location</strong></td>
-        <td>Review &gt; Tools &gt; Enable Flake8</td>
+        <td>Review &gt; Tools &gt; Flake8 &gt; Enable</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
@@ -3712,11 +3712,7 @@ PMD is an extensible multilanguage static code analyzer. It’s mainly concerned
 
 Enable PMD.
 
-### PHPMD
-
-PHPMD is a static code analysis tool for PHP files.
-
-#### Enable PHPMD
+#### Config File
 
 <Tabs groupId="config-setting">
   <TabItem value="web-ui" label="Web UI">
@@ -3724,11 +3720,11 @@ PHPMD is a static code analysis tool for PHP files.
       <tbody>
       <tr>
         <td><strong>Location</strong></td>
-        <td>Review &gt; Tools &gt; Enable PHPMD</td>
+        <td>Review > Tools > PMD > Config File</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
-        <td>true</td>
+        <td>_No default_</td>
       </tr>
     </tbody></table>
   </TabItem>
@@ -3737,27 +3733,27 @@ PHPMD is a static code analysis tool for PHP files.
       <tbody>
       <tr>
         <td><strong>Field</strong></td>
-        <td>`reviews.tools.phpmd.enabled`</td>
+        <td>`reviews.tools.pmd.config_file`</td>
       </tr>
       <tr>
         <td><strong>Datatype</strong></td>
-        <td>boolean</td>
+        <td>string</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
-        <td>true</td>
+        <td>_No default_</td>
       </tr>
     </tbody></table>
   </TabItem>
 </Tabs>
 
-PHPMD is a static code analysis tool for PHP files.
+Optional path to the PMD configuration file relative to the repository.
 
-### PHPCS
+### PHPMD
 
-PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.
+PHPMD is a static code analysis tool for PHP files.
 
-#### Enable PHPCS
+#### Enable PHPMD
 
 <Tabs groupId="config-setting">
   <TabItem value="web-ui" label="Web UI">
@@ -3765,7 +3761,7 @@ PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS
       <tbody>
       <tr>
         <td><strong>Location</strong></td>
-        <td>Review &gt; Tools &gt; Enable PHPCS</td>
+        <td>Review &gt; Tools &gt; Enable PHPMD</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
@@ -3778,7 +3774,7 @@ PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS
       <tbody>
       <tr>
         <td><strong>Field</strong></td>
-        <td>`reviews.tools.phpcs.enabled`</td>
+        <td>`reviews.tools.phpmd.enabled`</td>
       </tr>
       <tr>
         <td><strong>Datatype</strong></td>
@@ -3792,9 +3788,13 @@ PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS
   </TabItem>
 </Tabs>
 
-PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
+PHPMD is a static code analysis tool for PHP files.
 
-#### Config File
+### PHPCS
+
+PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.
+
+#### Enable PHPCS
 
 <Tabs groupId="config-setting">
   <TabItem value="web-ui" label="Web UI">
@@ -3802,11 +3802,11 @@ PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
       <tbody>
       <tr>
         <td><strong>Location</strong></td>
-        <td>Review > Tools > PMD > Config File</td>
+        <td>Review &gt; Tools &gt; Enable PHPCS</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
-        <td>_No default_</td>
+        <td>true</td>
       </tr>
     </tbody></table>
   </TabItem>
@@ -3815,21 +3815,21 @@ PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
       <tbody>
       <tr>
         <td><strong>Field</strong></td>
-        <td>`reviews.tools.pmd.config_file`</td>
+        <td>`reviews.tools.phpcs.enabled`</td>
       </tr>
       <tr>
         <td><strong>Datatype</strong></td>
-        <td>string</td>
+        <td>boolean</td>
       </tr>
       <tr>
         <td><strong>Default</strong></td>
-        <td>_No default_</td>
+        <td>true</td>
       </tr>
     </tbody></table>
   </TabItem>
 </Tabs>
 
-Optional path to the PMD configuration file relative to the repository.
+PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
 
 ### Prisma Schema Linting
 
diff --git a/docs/tools/flake8.md b/docs/tools/flake8.md
index af38dc42..9819c80c 100644
--- a/docs/tools/flake8.md
+++ b/docs/tools/flake8.md
@@ -26,7 +26,7 @@ Flake8 can detect many issues, including:
 - 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)
+- Select / ignore rule filtering (`--select`, `--extend-ignore`)
 - Extensible plugin ecosystem and custom rule support
 
 ## Links