Skip to content

Commit f75b79f

Browse files
feat: pmd (#89)
1 parent 7e80851 commit f75b79f

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

docs/tools/pmd.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: PMD
3+
sidebar_label: PMD
4+
description: CodeRabbit's guide to PMD.
5+
---
6+
7+
[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.
8+
9+
## Files
10+
11+
PMD will run on files with the following extensions:
12+
13+
- `.java`
14+
15+
## Configuration
16+
17+
PMD uses an XML configuration file.
18+
19+
PMD supports the following config files:
20+
21+
- User-defined config file set at `reviews.tools.pmd.config_file` in your project's `.coderabbit.yaml` file or setting the "Review → Tools → PMD → Config File" field in CodeRabbit's settings page.
22+
23+
## Links
24+
25+
- [PMD Configuring rules](https://pmd.github.io/pmd/pmd_userdocs_configuring_rules.html)

docs/tools/tools.md

+2
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Remove extraneous f prefix
5353
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
5454
| PHP | [PHPStan][PHPStan] |
5555
| Plaintext | [LanguageTool][LanguageTool] |
56+
| PMD | [PMD][PMD] |
5657
| Protobuf | [Buf][Buf] |
5758
| Python | [Ruff][Ruff] |
5859
| Regal | [Regal][Regal] |
@@ -81,3 +82,4 @@ Remove extraneous f prefix
8182
[Buf]: ./buf.md
8283
[Actionlint]: ./actionlint.md
8384
[Regal]: ./regal.md
85+
[PMD]: ./pmd.md

0 commit comments

Comments
 (0)