6.2.11.3. ImportDetekt

Run detekt and import its results

Runs detekt through its Gradle plugin (gradlew detekt) and imports its findings as analysis violations.

The reader parses the Checkstyle-format XML report the plugin writes to report_location; that report has to be enabled in the Gradle build (it is by default). Each finding becomes a violation with the provider option's value, detekt by default.

Possible Messages

This rule has no predefined messages.

Options

additional_args

additional_args : list[str] = ['detekt']

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

check_returncode

check_returncode : bool = False

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.

 

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.
 

executable

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

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

report_location

report_location : bauhaus.analysis.config.LayerRelativePath = 'build/reports/detekt/detekt.xml'

Checkstyle XML report detekt writes, relative to cwd. The default is the location of the detekt Gradle plugin.
 

Option Types

These types are used by options listed above:

EncodingErrorHandler

  • STRICT

  • IGNORE

  • REPLACE