6.2.11.6. ImportPMD

Run PMD and import its results

Runs PMD 7.3 or later on the files in source_directories and imports its violations. By default, PMD's rulesets/java/quickstart.xml ruleset is applied; set config_file to apply another one. Use exclude_paths to skip generated sources.

Possible Messages

This rule has no predefined messages.

Options

additional_args

additional_args : list[str] = ['--no-fail-on-violation', '--no-fail-on-error', '--no-progress', '--no-cache']

Additional arguments for the tool. They are passed on unquoted and unfiltered.
 

check_returncode

check_returncode : bool = True

Whether a non-zero exit status of the tool fails the rule. Turn it off for tools that report findings through their exit status, as many linters do.

Independent of this option, a run that imports no violations while the tool exits non-zero fails: its results are indistinguishable from a run in which the tool found nothing.

 

config_file

config_file : bauhaus.analysis.config.PlainPath = 'rulesets/java/quickstart.xml'

Configuration file for the PMD tool, relative to cwd. Defaults to rulesets/java/quickstart.xml.

 

cwd

cwd : bauhaus.analysis.config.LayerRelativePath | None = None

Optional execution directory for the command.
 

encoding

encoding : str = 'utf-8'

The encoding of the output of the executed command. See also encoding_error_handler.
 

encoding_error_handler

encoding_error_handler

Type: EncodingErrorHandler

Default: 'IGNORE'

The strategy to handle encoding errors during processing of the output of the executed command.

  • STRICT: abort with on error on encoding errors,
  • IGNORE: ignore encoding errors (accepting data loss),
  • REPLACE: replace problematic code points with a question mark (?).
 

environment

environment : dict[str, str] = {}

Additional environment variables for the command. These entries are added to the inherited environment; existing entries are overwritten.
 

exclude_paths

exclude_paths : list[bauhaus.analysis.config.PlainPath] = []

Files and directories to skip, relative to cwd. Directories are skipped recursively; glob patterns are not supported. They are passed as --exclude.
 

executable

executable : bauhaus.analysis.config.PlainPath | None = None

Path to the tool's executable. Unset, the tool is looked up on PATH.
 

source_directories

source_directories : list[bauhaus.analysis.config.PlainPath] = []

Source directories to analyze, relative to cwd. The directories must not overlap. Without any, cwd is analyzed. They are passed as -d.
 

Option Types

These types are used by options listed above:

EncodingErrorHandler

  • STRICT

  • IGNORE

  • REPLACE