Sigrid scope configuration file

Analysis scope configuration file used by Sigrid (sigrid-says.com)

Type object
File match sigrid.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/sigrid-scope-configuration-file/latest.json
Source https://www.schemastore.org/sigrid-scope-file.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Analysis scope configuration file used by Sigrid (sigrid-says.com)

Properties

languages language[] required
minItems=1
default_excludes boolean

When true, excludes files and directories from the analysis scope based on common conventions.

exclude string[]
component_depth integer

Directory depth that will be used to define components.

component_base_dirs string[]
components object[]
experimental boolean

Enable experimental analysis features.

model string | integer
dependencychecker object
9 nested properties
enabled boolean

When this or the 'blocklist' option is provided, OSH analysis is performed for every upload.

blocklist string[]

List of patterns for library names that should not be sent to external services.

blacklist string[]

Deprecated, use 'blocklist' instead.

transitive boolean

When true, transitive dependencies are also checked and included in the results.

exclude string | object | object | object | object[]

List of paths and/or dependencies that should be ignored for Open Source Health.

model string | integer
override_enabled_technologies string[]

List of additional technologies to analyze, which are not enabled by default.

override_disabled_technologies string[]

List of technologies for which the analysis should be disabled.

source string
Values: "all" "sbom"
architecture object
27 nested properties
enabled boolean

When true, architecture analysis will be triggered for each incoming upload.

model string | integer
exclude string[]
custom_components boolean

Deprecated. This option is obsolete.

file_annotation_components boolean

Automatic componentization based on @sigrid:component annotations in source files.

flatten_directories string[]
add_system_elements system_element[]
remove_system_elements system_element[]
add_dependencies dependency[]
remove_dependencies dependency[]
undesirable_dependencies dependency[]
rename Record<string, string>

Map of system elements for which to manually override the name.

merge_data_stores boolean

Default is false. When true, skips automated data store detection and assumes one monolithic data store.

grouping architecture_group[]
component_roles architecture_component_role[]
history_enabled boolean

Deprecated. This option is obsolete.

history boolean | string

Deprecated. This option is obsolete.

history_period_months integer

Period to use for repository history analysis, default is last 12 months.

history_start string | integer
history_end string | integer
history_interval string
Values: "week" "month"
history_filter_outliers boolean

Filters commits with an abnormally large amount of churn from the history analysis.

branch string
pattern=^[0-9a-zA-Z]+(,[0-9a-zA-Z]+)*$
duplication boolean

Set to false to disable duplication detection, improves performance for huge systems.

co_evolution boolean

Set to false to disable co-evolution detection, improves performance for huge systems.

disabled_metrics string[]

List of metrics that should be removed from the analysis and set to N/A.

custom_patterns architecture_pattern[]
thirdpartyfindings object
7 nested properties
enabled boolean

When true, third party findings analysis will be triggered for each incoming upload.

disabled_analyzers string[]
disabled_rules string[]

List of rule IDs that should not be reported by Sigrid.

enabled_analyzers string[]
enabled_rules string[]

List of rule IDs that should be reported by Sigrid, even though they are disabled by default.

include string[]
exclude string[]
checkmarx

Definitions

organization string
system string
model string | integer
language_name string
yyyymmdd string | integer
interval string
branches string
file_pattern_list string[]
component null | object
component_list object[]
language object | language_name
language_list language[]
analyzer_list string[]
pattern_list string[]
system_element object
name string required
type string
system_element_list system_element[]
dependency object
source string required
target string required
type string
count integer
bidirectional boolean
dependency_list dependency[]
architecture_group object
name string required
include string[] required
annotation string
exclude string[]
architecture_group_list architecture_group[]
architecture_component_role object
role string required
include string[] required
exclude string[]
architecture_component_role_list architecture_component_role[]
architecture_patterns architecture_pattern[]
architecture_pattern object
description string required
dependency_checker_source string