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

feat: pmd #89

Merged
merged 1 commit into from
Sep 2, 2024
Merged

feat: pmd #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 25 additions & 0 deletions docs/tools/pmd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: PMD
sidebar_label: PMD
description: CodeRabbit's guide to PMD.
---

[PMD](https://pmd.github.io/) is an extensible multilanguage static code analyzer. It’s mainly concerned with Java.

## Files

PMD will run on files with the following extensions:

- `.java`

## Configuration

PMD uses an XML configuration file.

PMD supports the following config files:

- 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.

## Links

- [PMD Configuring rules](https://pmd.github.io/pmd/pmd_userdocs_configuring_rules.html)
2 changes: 2 additions & 0 deletions docs/tools/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ Remove extraneous f prefix
| Markdown | [Markdownlint][Markdownlint], [LanguageTool][LanguageTool] |
| PHP | [PHPStan][PHPStan] |
| Plaintext | [LanguageTool][LanguageTool] |
| PMD | [PMD][PMD] |
| Protobuf | [Buf][Buf] |
| Python | [Ruff][Ruff] |
| Regal | [Regal][Regal] |
Expand Down Expand Up @@ -81,3 +82,4 @@ Remove extraneous f prefix
[Buf]: ./buf.md
[Actionlint]: ./actionlint.md
[Regal]: ./regal.md
[PMD]: ./pmd.md