6.3.5.6. SARIFReport¶

Output issue violations in SARIF format

This rule outputs the configured erosion kinds (defaults to all) as a SARIF 2.1.0 report.

Options¶

filename : bauhaus.analysis.config.ProjectRelativePath = 'None (value must be set)'

The filename this SARIF report is being output to.

kinds

Type: set[ViolationKind]

Default: {'ARCHITECTURE', 'CLONE', 'CYCLE', 'DEAD_ENTITY', 'METRIC', 'STYLE'}

Issues to include in SARIF report.

For METRIC_ALL_VALUES, also non-violation metric values are output, if report_all_values is set to true for the respective metric rules.

These types are used by options listed above:

An enumeration.

ARCHITECTURE

Architecture violations.

CLONE

Clones.

CYCLE

Cyclic dependencies.

DEAD_ENTITY

Dead entities.

METRIC

Metric violations.

METRIC_ALL_VALUES

Metric violations and non-violating metric values, if report_all_values=true

STYLE

Style violations.