Skip to content

Commit 6a197c5

Browse files
hardikkguptahardikkgupta
authored
docs: add Flake8, PHPMD, PHPCS to template & reference (#428) (#429)
1 parent 784b904 commit 6a197c5

File tree

3 files changed

+132
-0
lines changed

3 files changed

+132
-0
lines changed

‎docs/reference/configuration.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2850,6 +2850,47 @@ ESLint is a static code analysis tool for JavaScript files.
28502850

28512851
ESLint is a static code analysis tool for JavaScript files.
28522852

2853+
### Flake8
2854+
2855+
Flake8 is a static code analysis tool for Python files.
2856+
2857+
#### Enable Flake8
2858+
2859+
<Tabs groupId="config-setting">
2860+
<TabItem value="web-ui" label="Web UI">
2861+
<table>
2862+
<tbody>
2863+
<tr>
2864+
<td><strong>Location</strong></td>
2865+
<td>Review &gt; Tools &gt; Flake8 &gt; Enable</td>
2866+
</tr>
2867+
<tr>
2868+
<td><strong>Default</strong></td>
2869+
<td>true</td>
2870+
</tr>
2871+
</tbody></table>
2872+
</TabItem>
2873+
<TabItem value="yaml" label=".coderabbit.yaml" default>
2874+
<table>
2875+
<tbody>
2876+
<tr>
2877+
<td><strong>Field</strong></td>
2878+
<td>`reviews.tools.flake8.enabled`</td>
2879+
</tr>
2880+
<tr>
2881+
<td><strong>Datatype</strong></td>
2882+
<td>boolean</td>
2883+
</tr>
2884+
<tr>
2885+
<td><strong>Default</strong></td>
2886+
<td>true</td>
2887+
</tr>
2888+
</tbody></table>
2889+
</TabItem>
2890+
</Tabs>
2891+
2892+
Flake8 is a static code analysis tool for Python files.
2893+
28532894
### GitHub Checks
28542895

28552896
GitHub Checks integration configuration.
@@ -3708,6 +3749,88 @@ Enable PMD.
37083749

37093750
Optional path to the PMD configuration file relative to the repository.
37103751

3752+
### PHPMD
3753+
3754+
PHPMD is a static code analysis tool for PHP files.
3755+
3756+
#### Enable PHPMD
3757+
3758+
<Tabs groupId="config-setting">
3759+
<TabItem value="web-ui" label="Web UI">
3760+
<table>
3761+
<tbody>
3762+
<tr>
3763+
<td><strong>Location</strong></td>
3764+
<td>Review &gt; Tools &gt; Enable PHPMD</td>
3765+
</tr>
3766+
<tr>
3767+
<td><strong>Default</strong></td>
3768+
<td>true</td>
3769+
</tr>
3770+
</tbody></table>
3771+
</TabItem>
3772+
<TabItem value="yaml" label=".coderabbit.yaml" default>
3773+
<table>
3774+
<tbody>
3775+
<tr>
3776+
<td><strong>Field</strong></td>
3777+
<td>`reviews.tools.phpmd.enabled`</td>
3778+
</tr>
3779+
<tr>
3780+
<td><strong>Datatype</strong></td>
3781+
<td>boolean</td>
3782+
</tr>
3783+
<tr>
3784+
<td><strong>Default</strong></td>
3785+
<td>true</td>
3786+
</tr>
3787+
</tbody></table>
3788+
</TabItem>
3789+
</Tabs>
3790+
3791+
PHPMD is a static code analysis tool for PHP files.
3792+
3793+
### PHPCS
3794+
3795+
PHPCS is a static code analysis and coding-standard checker for PHP (plus JS/CSS) files.
3796+
3797+
#### Enable PHPCS
3798+
3799+
<Tabs groupId="config-setting">
3800+
<TabItem value="web-ui" label="Web UI">
3801+
<table>
3802+
<tbody>
3803+
<tr>
3804+
<td><strong>Location</strong></td>
3805+
<td>Review &gt; Tools &gt; Enable PHPCS</td>
3806+
</tr>
3807+
<tr>
3808+
<td><strong>Default</strong></td>
3809+
<td>true</td>
3810+
</tr>
3811+
</tbody></table>
3812+
</TabItem>
3813+
<TabItem value="yaml" label=".coderabbit.yaml" default>
3814+
<table>
3815+
<tbody>
3816+
<tr>
3817+
<td><strong>Field</strong></td>
3818+
<td>`reviews.tools.phpcs.enabled`</td>
3819+
</tr>
3820+
<tr>
3821+
<td><strong>Datatype</strong></td>
3822+
<td>boolean</td>
3823+
</tr>
3824+
<tr>
3825+
<td><strong>Default</strong></td>
3826+
<td>true</td>
3827+
</tr>
3828+
</tbody></table>
3829+
</TabItem>
3830+
</Tabs>
3831+
3832+
PHPCS is a static code analysis tool for PHP, JavaScript and CSS files.
3833+
37113834
### Prisma Schema Linting
37123835

37133836
Configuration for Prisma Schema linting to ensure schema file quality

‎docs/reference/yaml-template.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ reviews:
107107
config_file: ""
108108
eslint:
109109
enabled: true
110+
flake8:
111+
enabled: true
110112
rubocop:
111113
enabled: true
112114
buf:
@@ -118,6 +120,10 @@ reviews:
118120
pmd:
119121
enabled: true
120122
config_file: ""
123+
phpmd:
124+
enabled: true
125+
phpcs:
126+
enabled: true
121127
cppcheck:
122128
enabled: true
123129
semgrep:

‎sidebars.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,13 +182,16 @@ const sidebars: SidebarsConfig = {
182182
"tools/cppcheck",
183183
"tools/detekt",
184184
"tools/eslint",
185+
"tools/flake8",
185186
"tools/gitleaks",
186187
"tools/golangci-lint",
187188
"tools/hadolint",
188189
"tools/languagetool",
189190
"tools/luacheck",
190191
"tools/markdownlint",
191192
"tools/oxlint",
193+
"tools/phpcs",
194+
"tools/phpmd",
192195
"tools/phpstan",
193196
"tools/pipeline-remediation",
194197
"tools/pmd",

0 commit comments

Comments
 (0)