9.8 KiB
9.8 KiB
title, summary, tags, keywords, permalink, author
| title | summary | tags | keywords | permalink | author | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PMD CLI reference | Full reference for PMD's command-line interface, including options, output formats and supported languages |
|
|
pmd_userdocs_cli_reference.html | Tom Copeland <tom@infoether.com>, Xavier Le Vourch <xlv@users.sourceforge.net>, Juan Martín Sotuyo Dodero <juansotuyo@gmail.com> |
Options
The tool comes with a rather extensive help text, simply running with -help!
{% include custom/cli_option_row.html options="-rulesets,-R"
option_arg="refs"
description="Comma-separated list of ruleset or rule references."
required="yes"
%}
{% include custom/cli_option_row.html options="-dir,-d"
option_arg="path"
description="Root directory for the analyzed sources."
required="yes"
%}
{% include custom/cli_option_row.html options="-format,-f"
option_arg="format"
description="Output format of the analysis report. The available formats
are described [here](#available-report-formats)."
default="text"
%}
<tr><td/><td/><td/><td/></tr>
{% include custom/cli_option_row.html options="-auxclasspath"
option_arg="cp"
description="Specifies the classpath for libraries used by the source code.
This is used to resolve types in source files. Alternatively, a `file://` URL
to a text file containing path elements on consecutive lines can be specified."
languages="Java"
%}
{% include custom/cli_option_row.html options="-benchmark,-b"
description="Enables benchmark mode, which outputs a benchmark report upon completion.
The report is sent to standard error."
%}
{% include custom/cli_option_row.html options="-cache"
option_arg="filepath"
description="Specify the location of the cache file for incremental analysis.
This should be the full path to the file, including the desired file name (not just the parent directory).
If the file doesn't exist, it will be created on the first run. The file will be overwritten on each run
with the most up-to-date rule violations.
This can greatly improve analysis performance and is **highly recommended**."
%}
{% include custom/cli_option_row.html options="-debug,-verbose,-D,-V"
description="Debug mode. Prints more log output."
%}
{% include custom/cli_option_row.html options="-encoding,-e"
option_arg="charset"
description="Specifies the character set encoding of the source code files PMD is reading.
The valid values are the standard character sets of `java.nio.charset.Charset`."
default="UTF-8"
%}
{% include custom/cli_option_row.html options="-failOnViolation,--failOnViolation"
option_arg="bool"
description="Specifies whether PMD exits with non-zero status if violations are found.
By default PMD exits with status 4 if violations are found.
Disable this feature with `-failOnViolation false` to exit with 0 instead and just output the report."
default="true"
%}
{% include custom/cli_option_row.html options="-filelist"
option_arg="filepath"
description="Path to file containing a comma delimited list of files to analyze.
If this is given, then you don't need to provide `-dir`."
%}
{% include custom/cli_option_row.html options="-ignorelist"
option_arg="filepath"
description="Path to file containing a comma delimited list of files to ignore.
This option can be combined with `-dir` and `-filelist`.
This ignore list takes precedence over any files in the filelist."
%}
{% include custom/cli_option_row.html options="-help,-h,-H"
description="Display help on usage."
%}
{% include custom/cli_option_row.html options="-language,-l"
option_arg="lang"
description="Specify the language PMD should use. Used together with `-version`. See also [Supported Languages](#supported-languages)."
%}
{% include custom/cli_option_row.html options="-minimumpriority,-min"
option_arg="num"
description="Rule priority threshold; rules with lower priority than configured here won't be used."
default="5"
%}
{% include custom/cli_option_row.html options="-norulesetcompatibility"
description='Disable automatic fixing of invalid rule references. Without the switch, PMD tries to automatically replace rule references that point to moved or renamed rules with the newer location if possible. Disabling it is not recommended.'
%}
{% include custom/cli_option_row.html options="-no-cache"
description="Explicitly disables incremental analysis. This switch turns off suggestions to use Incremental Analysis,
and causes the `-cache` option to be discarded if it is provided."
%}
{% include custom/cli_option_row.html options="-property,-P"
option_arg="name>=<value"
description="Specifies a property for the report renderer. The option can be specified several times."
default="[]"
%}
{% include custom/cli_option_row.html options="-reportfile,-r"
option_arg="path"
description="Path to a file in which the report output will be sent. By default the report is printed on standard output."
%}
{% include custom/cli_option_row.html options="-shortnames"
description="Prints shortened filenames in the report."
%}
{% include custom/cli_option_row.html options="-showsuppressed"
description="Causes the suppressed rule violations to be added to the report."
%}
{% include custom/cli_option_row.html options="-stress,-S"
description="Performs a stress test."
%}
{% include custom/cli_option_row.html options="-suppressmarker"
option_arg="marker"
description="Specifies the comment token that marks lines which PMD should ignore."
default="NOPMD"
%}
{% include custom/cli_option_row.html options="-threads,-t"
option_arg="num"
description="Sets the number of threads used by PMD.
Set threads to `0` to disable multi-threading processing."
default="1"
%}
{% include custom/cli_option_row.html options="-uri,-u"
option_arg="uri"
description="Database URI for sources. If this is given, then you don't need to provide `-dir`."
languages="PLSQL"
%}
{% include custom/cli_option_row.html options="-version,-v"
option_arg="version"
description="Specify the version of a language PMD should use. Used together with `-language`. See also [Supported Languages](#supported-languages)."
%}
| Option | Description | Default value | Applies to |
|---|
Additional Java Runtime Options
PMD is executed via a Java runtime. In some cases, you might need to set additional runtime options, e.g. if you want to analyze a project, that uses one of OpenJDK's Preview Language Features.
Just set the environment variable PMD_JAVA_OPTS before executing PMD, e.g.
export PMD_JAVA_OPTS="--enable-preview"
./run.sh pmd -d ../../../src/main/java/ -f text -R rulesets/java/quickstart.xml
Exit Status
Please note that if PMD detects any violations, it will exit with status 4 (since 5.3). This behavior has been introduced to ease PMD integration into scripts or hooks, such as SVN hooks.
| 0 | Everything is fine, no violations found |
| 1 | Couldn't understand command-line parameters or PMD exited with an exception |
| 4 | At least one violation has been detected, unless -failOnViolation false is set. |
Supported Languages
The language is determined automatically by PMD from the file extensions. Some languages such as "Java"
however support multiple versions. The default version will be used, which is usually the latest supported
version. If you want to use an older version, so that e.g. rules, that suggest usage of language features,
that are not available yet, won't be executed, you need to specify a specific version via the -language
and -version parameter.
These parameters are irrelevant for languages that don't support different versions.
Example:
./run.sh pmd -d src/main/java -f text -R rulesets/java/quickstart.xml -language java -version 8
- apex (Salesforce Apex)
- java
- Supported Versions: 1.3, 1.4, 1.5, 5, 1.6, 6, 1.7, 7, 1.8, 8, 9, 1.9, 10, 1.10, 11, 12, 13, 13-preview, 14 (default), 14-preview
- ecmascript (JavaScript)
- jsp
- modelica
- plsql
- scala
- Supported Versions: 2.10, 2.11, 2.12, 2.13 (default)
- vf (Salesforce VisualForce)
- vm (Apache Velocity)
- xml and xsl
Available Report Formats
PMD comes with many different renderers. All formats are described at PMD Report formats