Repository navigation
Expand file tree
/
Copy pathmodular.schema.json
More file actions
109 lines (109 loc) · 3.04 KB
/
Copy pathmodular.schema.json
File metadata and controls
109 lines (109 loc) · 3.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://unpkg.com/modular-check/modular.schema.json",
"title": "Modular project configuration",
"description": "Project-local policy for Modular repository scans. Network and browser audits remain CLI-only opt-ins.",
"type": "object",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"failOn": {
"$ref": "#/$defs/threshold",
"description": "Fail with exit code 3 when an unsuppressed finding at or above this severity exists."
},
"failOnNew": {
"$ref": "#/$defs/threshold",
"description": "Fail with exit code 3 only for unsuppressed baseline-new findings at or above this severity. Requires baseline."
},
"baseline": {
"type": "string",
"minLength": 1,
"description": "Repository-relative Modular baseline file."
},
"ignore": {
"type": "array",
"maxItems": 100,
"uniqueItems": true,
"items": {
"type": "string",
"minLength": 1,
"pattern": "^[^/\\\\]+$"
},
"description": "Exact directory names to exclude wherever they occur."
},
"maxFindingsPerRule": {
"type": "integer",
"minimum": 1
},
"outputFormats": {
"type": "array",
"uniqueItems": true,
"items": {
"enum": [
"json",
"sarif"
]
},
"description": "Additional machine-readable artifacts written beside the Markdown reports."
},
"suppressions": {
"type": "array",
"maxItems": 1000,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"rule",
"reason"
],
"properties": {
"rule": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Finding rule id glob, for example security.secret-* or site.meta-description."
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Optional repository-relative file glob."
},
"reason": {
"type": "string",
"minLength": 8,
"maxLength": 1000,
"description": "Auditable accepted-risk or false-positive rationale."
},
"expires": {
"type": "string",
"format": "date",
"description": "Optional last valid date; expired entries automatically stop suppressing."
}
}
}
},
"failOnRegression": {
"$ref": "#/$defs/threshold",
"description": "Gate new findings or increased severity against a required baseline."
},
"failOnIncomplete": {
"type": "boolean",
"description": "Exit 1 when discovered source files could not be fully inspected."
}
},
"$defs": {
"threshold": {
"enum": [
"critical",
"high",
"medium",
"low",
"info",
"none"
]
}
}
}