Getting Started

To start using PMD, enable it in the repository setting.

Configuration

You can customize PMD analysis by using sideci.yml.

linter:
  pmd_java:
    dir: src
    rulesets:
      - category/java/errorprone.xml
      - foo.xml
    encoding: Shift_JIS
    min_priority: 3

dir

This option allows you to specify the directory to analyze. The default value is ..

rulesets

This option allows you to enable and disable rulesets. The value will be passed to the -rulesets commandline option of PMD. The value should be a sequence of strings.

The default value contains the 4 rulesets:

• category/java/bestpractices.xml

• category/java/errorprone.xml

• category/java/multithreading.xml

• category/java/performance.xml

You can also specify the rulesets file in your repository.

encoding

This option allows you to specify encoding of the Java source code. The value will be passed to the -encoding commandline option of PMD, and the default is UTF-8.

min_priority

This option specifies the -minimumpriority commandline option of PMD. There is no default value.