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¶
This rule shares the following common options: exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity
The following places define options that affect this rule: Analysis-GlobalOptions
additional_args¶
additional_args : list[str] = ['detekt']
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
encoding¶
encoding : str = 'utf-8'
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] = {}
executable¶
executable : bauhaus.analysis.config.PlainPath | None = None
report_location¶
report_location : bauhaus.analysis.config.LayerRelativePath = 'build/reports/detekt/detekt.xml'
Option Types¶
These types are used by options listed above:
EncodingErrorHandler¶
STRICT
IGNORE
REPLACE