Debian Codegraph @

src/ansiblelint/schemas/ansible-lint-config.json

raw
1 {
2 "$defs": {
3 "rule": {
4 "additionalProperties": false,
5 "properties": {
6 "exclude_paths": {
7 "items": {
8 "type": "string"
9 },
10 "title": "Glob-like paths to be excluded.",
11 "type": "array"
12 }
13 },
14 "type": "object"
15 }
16 },
17 "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible-lint-config.json",
18 "$schema": "http://json-schema.org/draft-07/schema",
19 "additionalProperties": false,
20 "description": "https://docs.ansible.com/projects/lint/configuring/",
21 "examples": [
22 ".ansible-lint",
23 ".ansible-lint.yml",
24 ".ansible-lint.yaml",
25 ".config/ansible-lint.yml",
26 ".config/ansible-lint.yaml"
27 ],
28 "properties": {
29 "display_relative_path": {
30 "default": true,
31 "title": "Configure how to display file paths",
32 "type": "boolean"
33 },
34 "enable_list": {
35 "items": {
36 "type": "string"
37 },
38 "title": "Enable List",
39 "type": "array"
40 },
41 "exclude_paths": {
42 "items": {
43 "type": "string"
44 },
45 "title": "Exclude Paths",
46 "type": "array"
47 },
48 "extra_vars": {
49 "title": "Extra Vars",
50 "type": "object"
51 },
52 "kinds": {
53 "items": {
54 "additionalProperties": {
55 "type": "string"
56 },
57 "type": "object"
58 },
59 "title": "Kinds",
60 "type": "array"
61 },
62 "loop_var_prefix": {
63 "title": "Loop Var Prefix",
64 "type": "string"
65 },
66 "max_block_depth": {
67 "title": "Maximum Block Depth",
68 "type": "integer",
69 "default": 20
70 },
71 "mock_modules": {
72 "items": {
73 "type": "string"
74 },
75 "title": "Mock Modules",
76 "type": "array"
77 },
78 "mock_roles": {
79 "items": {
80 "type": "string"
81 },
82 "title": "Mock Roles",
83 "type": "array"
84 },
85 "offline": {
86 "default": false,
87 "title": "Offline",
88 "type": "boolean"
89 },
90 "only_builtins_allow_collections": {
91 "items": {
92 "type": "string"
93 },
94 "title": "Only Builtins Allow Collections",
95 "type": "array"
96 },
97 "only_builtins_allow_modules": {
98 "items": {
99 "type": "string"
100 },
101 "title": "Only Builtins Allow Modules",
102 "type": "array"
103 },
104 "profile": {
105 "enum": [
106 "min",
107 "basic",
108 "moderate",
109 "safety",
110 "shared",
111 "production",
112 null
113 ],
114 "title": "Profile",
115 "type": ["null", "string"]
116 },
117 "progressive": {
118 "default": false,
119 "title": "Progressive (removed feature)",
120 "type": "boolean"
121 },
122 "project_dir": {
123 "default": null,
124 "title": "Project Directory",
125 "type": ["string", "null"]
126 },
127 "quiet": {
128 "default": true,
129 "title": "Quiet",
130 "type": "boolean"
131 },
132 "rules": {
133 "additionalProperties": {
134 "$ref": "#/$defs/rule"
135 },
136 "propertyNames": {
137 "oneOf": [
138 {
139 "enum": [
140 "command-instead-of-module",
141 "command-instead-of-shell",
142 "deprecated-bare-vars",
143 "deprecated-local-action",
144 "deprecated-module",
145 "empty-string-compare",
146 "fqcn",
147 "fqcn[action-core]",
148 "fqcn[action]",
149 "fqcn[canonical]",
150 "fqcn[keyword]",
151 "galaxy",
152 "galaxy[no-changelog]",
153 "galaxy[no-runtime]",
154 "galaxy[tags]",
155 "galaxy[version-incorrect]",
156 "galaxy[version-missing]",
157 "ignore-errors",
158 "inline-env-var",
159 "internal-error",
160 "jinja",
161 "jinja[invalid]",
162 "jinja[spacing]",
163 "key-order",
164 "latest",
165 "literal-compare",
166 "load-failure",
167 "load-failure[not-found]",
168 "loop-var-prefix",
169 "loop-var-prefix[missing]",
170 "loop-var-prefix[wrong]",
171 "meta-incorrect",
172 "meta-no-tags",
173 "meta-runtime",
174 "meta-video-links",
175 "name",
176 "name[casing]",
177 "name[play]",
178 "name[prefix]",
179 "name[template]",
180 "no-changed-when",
181 "no-handler",
182 "no-jinja-when",
183 "no-log-password",
184 "no-prompting",
185 "no-relative-paths",
186 "no-same-owner",
187 "no-tabs",
188 "only-builtins",
189 "package-latest",
190 "parser-error",
191 "partial-become",
192 "playbook-extension",
193 "risky-file-permissions",
194 "risky-octal",
195 "risky-shell-pipe",
196 "role-name",
197 "run-once",
198 "run-once[play]",
199 "run-once[task]",
200 "sanity",
201 "sanity[bad-ignore]",
202 "sanity[cannot-ignore]",
203 "schema",
204 "syntax-check",
205 "var-naming",
206 "yaml"
207 ],
208 "type": "string"
209 },
210 {
211 "pattern": "^[a-z0-9-\\[\\]]+$",
212 "type": "string"
213 }
214 ]
215 },
216 "title": "Rules specific configuration.",
217 "type": "object"
218 },
219 "rulesdir": {
220 "items": {
221 "type": "string"
222 },
223 "title": "Rulesdir",
224 "type": "array"
225 },
226 "sarif_file": {
227 "default": null,
228 "title": "SARIF Output filename",
229 "type": ["null", "string"]
230 },
231 "skip_action_validation": {
232 "default": false,
233 "title": "Skip Action Validation",
234 "type": "boolean"
235 },
236 "skip_list": {
237 "items": {
238 "type": "string"
239 },
240 "title": "Skip List",
241 "type": "array"
242 },
243 "strict": {
244 "default": false,
245 "title": "Strict",
246 "type": "boolean"
247 },
248 "supported_ansible_also": {
249 "items": {
250 "type": "string"
251 },
252 "title": "Add supported ansible versions",
253 "type": "array"
254 },
255 "tags": {
256 "items": {
257 "type": "string"
258 },
259 "title": "Tags",
260 "type": "array"
261 },
262 "task_name_prefix": {
263 "default": "{stem} | ",
264 "title": "Allow custom prefix for task[prefix]",
265 "type": "string"
266 },
267 "use_default_rules": {
268 "default": true,
269 "title": "Use Default Rules",
270 "type": "boolean"
271 },
272 "var_naming_pattern": {
273 "default": "^[a-z_][a-z0-9_]*$",
274 "title": "Regex used to verify variable names",
275 "type": "string"
276 },
277 "verbosity": {
278 "default": 0,
279 "title": "Verbosity",
280 "type": "integer"
281 },
282 "warn_list": {
283 "items": {
284 "type": "string"
285 },
286 "title": "Warn List",
287 "type": "array"
288 },
289 "write_exclude_list": {
290 "items": {
291 "type": "string"
292 },
293 "title": "Write Exclude List",
294 "type": "array"
295 },
296 "write_list": {
297 "items": {
298 "type": "string"
299 },
300 "title": "Write List",
301 "type": "array"
302 }
303 },
304 "title": "Ansible-lint Configuration Schema",
305 "type": "object"
306 }