The tool comes with a rather extensive help text, simply running with--help!
| Option | Description | Default value | Applies to |
|---|---|---|---|
--rulesets <refs>-R <refs> | Required Path to a ruleset xml file. The path may reference a resource on the classpath of the application, be a local file system path, or a URL. The option can be repeated, and multiple arguments separated by comma can be provided to a single occurrence of the option. | | |
--format <format>-f <format> | Output format of the analysis report. The available formats are describedhere. | text | |
--aux-classpath <cp> | Specifies the classpath for libraries used by the source code. This is used to resolve types in source files. The platform specific path delimiter (":" on Linux, ";" on Windows) is used to separate the entries. Alternatively, a singlefile: URL to a text file containing path elements on consecutive lines can be specified.See alsoProviding the auxiliary classpath. | | Java |
--benchmark-b | Enables benchmark mode, which outputs a benchmark report upon completion. The report is sent to standard error. | | |
--cache <filepath> | 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 ishighly recommended. | | |
--debug--verbose-D-v | Debug mode. Prints more log output. See alsoLogging. | | |
--[no-]fail-on-error | Specifies whether PMD exits with non-zero status if recoverable errors occurred. By default PMD exits with status 5 if recoverable errors occurred (whether there are violations or not). Disable this option with--no-fail-on-error to exit with 0 instead. In any case, a report with the found violations will be written. | | |
--[no-]fail-on-violation | 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--no-fail-on-violation to exit with 0 instead. In any case a report with the found violations will be written. | | |
--force-language <lang> | Force a language to be used for all input files, irrespective of file names. When using this option, the automatic language selection by extension is disabled and PMD tries to parse all files with the given language<lang>. Parsing errors are ignored and unparsable files are skipped.Use This option allows to use the xml language for files, that don't use xml as extension. Seeexample below. | | |
--help-h | Display help on usage. | | |
--use-version <lang-version> | The specific language version PMD should use when parsing source code for a given language. Values are in the format oflanguage-version. This option can be repeated to configure several languages for the same run. Note that this option does not change how languages are assigned to files. It only changes something if the project you analyze contains some files that PMD detects as the given language. Language detection is only influenced by file extensions and the See alsoSupported Languages. | | |
--minimum-priority <priority> | Rule priority threshold; rules with lower priority than configured here won't be used. Valid values (case-insensitive): High, Medium_High, Medium, Medium_Low, Low. An integer between 1 (High) and 5 (Low) is also supported. SeeConfiguring rules on how to override priorities in custom rulesets. | Low | |
--no-ruleset-compatibility | 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. | | |
--no-cache | 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. | | |
--[no-]progress | Enables / disable progress bar indicator of live analysis progress. This ie enabled by default. | | |
--property <name>=<value>-P <name>=<value> | Specifies a property for the report renderer. The option can be specified several times. Using | | |
--report-file <path>-r <path> | Path to a file to which report output is written. The file is created if it does not exist. If this option is not specified, the report is rendered to standard output. | | |
--show-suppressed | Causes the suppressed rule violations to be added to the report if supported by the report format. SeePMD Report formats for details. | | |
--suppress-marker <marker> | Specifies the comment token that marks lines which PMD should ignore. | NOPMD | |
--threads <num>-t <num> | Set the number of threads used by PMD. This can be an integer, or a float (or int) followed by the letterC, eg0.5C or1C. In the latter case, the float will be multiplied by the number of cores of the host machine, and rounded down to an integer. If the specified number of threads is zero, then PMD will use the main thread for everything. If it isn > 0, PMD will spawnn separate analysis threads besides the main thread. | 1C |
PMD and CPD use the same set of options to specify the files that are to beprocessed by the analyzer. There are different ways to specify files, but atleast one of--dir,--file-list or--uri must be provided.
| Option | Description | Default value | Applies to |
|---|---|---|---|
--dir <path>-d <path> | Path to a source file, or directory containing source files to analyze. Zip and Jar files are also supported, if they are specified directly (archive files found while exploring a directory are not recursively expanded). This option can be repeated, and multiple arguments can be provided to a single occurrence of the option. One of--dir,--file-list or--uri must be provided. | | |
--file-list <filepath> | Path to a file containing a list of files to analyze, one path per line. One of--dir,--file-list or--uri must be provided. | | |
--exclude <filepath+> | Specify one or more paths to files that will be ignored. This option overrides files included by any of--dir,--file-list and--uri. It can combine with--exclude-file-list. Available for PMD since 7.14.0, for CPD since 7.0.0. | | |
--exclude-file-list <filepath> | Path to a file containing a list of files to ignore, one path per line. This option overrides files included by any of--dir,--file-list and--uri. It can combine with--exclude. Available for PMD since 7.14.0, for CPD since 7.14.0. For PMD, this option was called--ignore-list. | | |
--ignore-list <filepath> | Deprecated (Since 7.14.0) This option has been renamed--exclude-file-list. Path to file containing a list of files to ignore, one path per line. This option overrides files included by any of--dir,--file-list and--uri. It can combine with--exclude. | | |
--non-recursive | When specified, any directory mentioned with--dir or in the--file-list will only be searched for files that are direct children. By default, subdirectories are recursively included. Available for PMD since 7.14.0, for CPD since 7.0.0. | | |
--relativize-paths-with <path>-z <path> | Path relative to which directories are rendered in the report. This option allows shortening directories in the report; without it, paths are rendered as mentioned in the source directory (option "--dir"). The option can be repeated, in which case the shortest relative path will be used. If the root path is mentioned (e.g. "/" or "C:\\"), then the paths will be rendered as absolute. | | |
--uri <uri>-u <uri> | Database URI for sources. One of--dir,--file-list or--uri must be provided. | | PLSQL |
--encoding <charset>-e <charset> | Specifies the character set encoding of the source code files the tool is reading. The valid values are the standard character sets ofjava.nio.charset.Charset. | UTF-8 |
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’sJEP 12: Preview Language Features.
Just set the environment variablePMD_JAVA_OPTS before executing PMD, e.g.
~ $export PMD_JAVA_OPTS="--enable-preview"~ $pmd check -d src/main/java/ -f text -R rulesets/java/quickstart.xmlC:\>set "PMD_JAVA_OPTS=--enable-preview"C:\>pmd.bat check -d src\main\java\ -f text -R rulesets/java/quickstart.xmlIf you develop custom rules and package them as a jar file, you need to add it to PMD’s runtime classpath.You can either copy the jar file into thelib/ subfolder alongside the other jar files, that are in PMD’sstandard distribution.
Or you can set the environment variableCLASSPATH before starting PMD, e.g.
~ $export CLASSPATH=custom-rule-example.jar~ $pmd check -d ../../../src/main/java/ -f text -R myrule.xmlC:\>set CLASSPATH=custom-rule-example.jarC:\>pmd.bat check -d ..\..\..\src\main\java\ -f text -R myrule.xmlPlease note that if PMD detects any violations, it will exit with status 4 (since 5.3) or 5 (since 7.3.0).This behavior has been introduced to ease PMD integration into scripts or hooks, such as SVN hooks.
| 0 | Everything is fine, no violations found and no recoverable error occurred. |
| 1 | PMD exited with an exception. |
| 2 | Usage error. Command-line parameters are invalid or missing. |
| 4 | At least one violation has been detected, unless--no-fail-on-violation is set.Since PMD 5.3. |
| 5 | At least one recoverable error has occurred. There might be additionally zero or more violations detected. To ignore recoverable errors, use--no-fail-on-error.Since PMD 7.3.0. |
Note:If PMD exits with 5, then PMD had either trouble parsing one or more files or a rule failed with an exception.That means, that either no violations for the entire file or for that rule are reported. These cases can be considered as false-negatives.In any case, the root cause should be investigated. If it’s a problem in PMD itself, please create a bug report. Recoverable errorsare usually part of the generated PMD report.
PMD internally usesslf4j and ships with slf4j-simple as the logging implementation.Logging messages are printed to System.err, that’s why you should use--report-file to specify an output forthe report and not rely on redirecting the console output.
The configuration for slf4j-simple is in the fileconf/simplelogger.properties. There you can enablelogging of specific classes if needed. The--debug command line option configures the default log levelto be “debug”.
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 supportednon-preview version. If you want to use an older version, so that e.g. rules that suggest usage of language featuresthat are not available yet won’t be executed, you need to specify a specific version via the--use-versionparameter.
The selected language version can also influence which rules are applied. Some rules might be relevant forjust a specific version of the language. Such rules are marked with eitherminimumLanguageVersion ormaximumLanguageVersion or both. Most rules apply for all language versions.
These parameters are most of the time irrelevant, if the rules apply for all versions.
The available versions depend on the language. You can get a list of the currently supported language versionsvia the CLI option--help.
Example:
~ $pmd check -d src/main/java -f text -R rulesets/java/quickstart.xml --use-version java-1.8C:\>pmd.bat check -d src\main\java -f text -R rulesets/java/quickstart.xml --use-version java-1.8PMD comes with many different renderers.All formats are described atPMD Report formats
If your xml language doesn’t usexml as file extension, you can still use PMD with--force-language:
~ $pmd check -d src/xml-file.ext -f text -R ruleset.xml --force-language xmlC:\>pmd.bat check -d src\xml-file.ext -f text -R ruleset.xml --force-language xmlYou can also specify a directory instead of a single file. Then all files are analyzed. In that case,parse errors are suppressed in order to reduce irrelevant noise:
~ $pmd check -d src/ -f text -R ruleset.xml --force-language xmlC:\>pmd.bat check -d src\ -f text -R ruleset.xml --force-language xmlAlternatively, you can create a filelist to only analyze files with a given extension:
~ $find src/ -name "*.ext" > filelist.txt~ $pmd check --file-list filelist.txt -f text -R ruleset.xml --force-language xmlC:\>for /r src\ %i in (*.ext) do echo %i >> filelist.txtC:\>pmd.bat check --file-list filelist.txt -f text -R ruleset.xml --force-language xml