Edit

PMD

Supported Version	Language	Website
6.20.0	Java 12.0.2	https://pmd.github.io

Getting Started

To start using PMD, enable it in Repository Settings.

Configuration

You can customize PMD analysis by using sider.yml:

linter:
  pmd_java:
    dir: src
    rulesets:
      - category/java/errorprone.xml
      - path/to/custom-ruleset.xml
    encoding: Shift_JIS
    min_priority: 3

Name	Type	Default	Description
root_dir	string	-	A root directory.
dir	string	.	A directory to analyze.
rulesets	string, string[]	(see below)	-rulesets option of PMD.
encoding	string	(PMD's default)	-encoding option of PMD.
min_priority	number	(PMD's default)	-minimumpriority option of PMD.

dir

This option allows you to specify the directory to analyze.

rulesets

This option allows you to use your custom rulesets. By default, the following rulesets are included:

• category/java/bestpractices.xml
• category/java/design.xml
• category/java/errorprone.xml
• category/java/multithreading.xml
• category/java/performance.xml
• category/java/security.xml

You can also specify the rulesets file in your repository as follow.

linter:
  pmd_java:
    rulesets:
      - your_pmd_custom_rules.xml

Please see the PMD documentation for the customization details.

encoding

This option allows you to specify the encoding of the Java source code.

min_priority

This option allows you to specify the rule priority threshold.