From d89576915b0f4fe3f3ec328c3dbe23bddfe67dac Mon Sep 17 00:00:00 2001 From: Ruhan Date: Fri, 30 Aug 2024 22:41:18 +0530 Subject: [PATCH] feat: pmd --- docs/tools/pmd.md | 25 +++++++++++++++++++++++++ docs/tools/tools.md | 2 ++ 2 files changed, 27 insertions(+) create mode 100644 docs/tools/pmd.md diff --git a/docs/tools/pmd.md b/docs/tools/pmd.md new file mode 100644 index 00000000..bf7d6a16 --- /dev/null +++ b/docs/tools/pmd.md @@ -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) diff --git a/docs/tools/tools.md b/docs/tools/tools.md index a941b8af..d8748e05 100644 --- a/docs/tools/tools.md +++ b/docs/tools/tools.md @@ -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] | @@ -81,3 +82,4 @@ Remove extraneous f prefix [Buf]: ./buf.md [Actionlint]: ./actionlint.md [Regal]: ./regal.md +[PMD]: ./pmd.md