6.2.5.11. Architecture-GravisArchitectureProject¶
Architecture check using a Gravis architecture project
Required inputs: RFG
This rule is preferred over the traditional Architecture-GravisArchitecture rule. It performs an architecture analysis based on a Gravis Architecture Project. An Architecture Project keeps all files and settings in one place and ensures that the CI performs exactly the same analysis as Gravis. Steps for using it:
- set up an architecture project in Gravis,
- reference the project file from this rule.
Architecture projects can contain several architecture checks. You can select which check(s) to run or whether to run all checks.
Possible Messages
This rule has no predefined messages.
Options¶
This rule shares the following common options: confidence, exclude_messages_in_system_headers, excludes, includes, justification_checker, post_processing, provider, severity
The following places define options that affect this rule: Analysis-GlobalOptions
append_check_name¶
append_check_name : bool = True
architecture_project_file¶
architecture_project_file : bauhaus.analysis.config.LayerRelativePath = 'None (value must be set)'
checks¶
checks : set[str] | None = None
csv_output_file¶
csv_output_file : bauhaus.analysis.config.LayerRelativePath | None = None
export_warnings¶
export_warnings : bool = True
generate_violation_previews¶
generate_violation_previews : bool = True
loglevel¶
loglevel : LogLevel = 'WARNING'
preprocessing_step¶
preprocessing_step : typing.Callable[[_dg.Graph], typing.Optional[_dg.Graph]] | None = None
preview_generation_limit¶
preview_generation_limit : int = 10000
result_types_to_report¶
result_types_to_report
Result types that should be reported; currently possible values are "Absence", "Divergence", and "Convergence".Type: set[ArchitectureAnalysisResultType]
Default:
{'Absence', 'Divergence'}
Option Types¶
These types are used by options listed above:
ArchitectureAnalysisResultType¶
Types of possible architecture result edges.Absence
Convergence
Divergence
LogLevel¶
WARNING
INFO
DEBUG