6.2.11.10. ImportRuff¶
Run Ruff and import its results
Runs the Ruff linter and imports its findings as analysis violations.
Use additional_args to pass the files or
directories Ruff should check. Each diagnostic becomes a violation with the
provider option's value, ruff by default.
Ruff discovers its configuration from the checked files, for example a
pyproject.toml. Set config_file to use
a specific configuration file instead.
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] = []
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 | None = None
--config in place of the configuration Ruff finds itself.
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
Option Types¶
These types are used by options listed above:
EncodingErrorHandler¶
STRICT
IGNORE
REPLACE