Skip to content
This repository was archived by the owner on Aug 16, 2025. It is now read-only.

docs: add Flake8, PHPMD, PHPCS to template & reference (#428) #429

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
docs: wrap / --extend-ignore (review feedback)
  • Loading branch information
hardikkgupta committed Jul 3, 2025
commit 5871712fadde2e186f9e3d7dbb5aed4eca8ff71f
50 changes: 25 additions & 25 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -3712,23 +3712,19 @@ 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">
<table>
<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>
Expand All @@ -3737,35 +3733,35 @@ 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">
<table>
<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>
Expand All @@ -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>
Expand All @@ -3792,21 +3788,25 @@ 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">
<table>
<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>
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/tools/flake8.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down