Skip to content

Commit de170b2

Browse files
kddejongPotatoWKY
authored andcommitted
feat(cloudformation): cfn-lint configuration (aws#8362)
## Problem - Allow for the ability to configure cfn-lint. Minimal impact to the settings panel by using a nest object ## Solution --- - Treat all work as PUBLIC. Private `feature/x` branches will not be squash-merged at release time. - Your code changes must meet the guidelines in [CONTRIBUTING.md](https://github.com/aws/aws-toolkit-vscode/blob/master/CONTRIBUTING.md#guidelines). - License: I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent 1e83c85 commit de170b2

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

packages/core/src/shared/settings-toolkit.gen.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,18 @@ export const toolkitSettings = {
6262
"aws.cloudformation.diagnostics.cfnLint.lintOnChange": {},
6363
"aws.cloudformation.diagnostics.cfnLint.delayMs": {},
6464
"aws.cloudformation.diagnostics.cfnLint.path": {},
65+
"aws.cloudformation.diagnostics.cfnLint.customization": {
66+
"ignoreChecks": {},
67+
"includeChecks": {},
68+
"mandatoryChecks": {},
69+
"includeExperimental": {},
70+
"configureRules": {},
71+
"regions": {},
72+
"customRules": {},
73+
"appendRules": {},
74+
"overrideSpec": {},
75+
"registrySchemas": {}
76+
},
6577
"aws.cloudformation.diagnostics.cfnGuard.enabled": {},
6678
"aws.cloudformation.diagnostics.cfnGuard.validateOnChange": {},
6779
"aws.cloudformation.diagnostics.cfnGuard.enabledRulePacks": {},

packages/toolkit/package.json

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,82 @@
349349
"default": "",
350350
"description": "Path to locally installed cfn-lint executable. If empty, uses bundled version."
351351
},
352+
"aws.cloudformation.diagnostics.cfnLint.customization": {
353+
"type": "object",
354+
"default": {
355+
"includeChecks": [
356+
"I"
357+
]
358+
},
359+
"description": "CFN-Lint customization options",
360+
"properties": {
361+
"ignoreChecks": {
362+
"type": "array",
363+
"items": {
364+
"type": "string"
365+
},
366+
"description": "Rule IDs to ignore"
367+
},
368+
"includeChecks": {
369+
"type": "array",
370+
"items": {
371+
"type": "string"
372+
},
373+
"description": "Only check these rule IDs"
374+
},
375+
"mandatoryChecks": {
376+
"type": "array",
377+
"items": {
378+
"type": "string"
379+
},
380+
"description": "Always check these rules"
381+
},
382+
"includeExperimental": {
383+
"type": "boolean",
384+
"description": "Include experimental rules"
385+
},
386+
"configureRules": {
387+
"type": "array",
388+
"items": {
389+
"type": "string"
390+
},
391+
"description": "Rule configurations (RuleId:key=value)"
392+
},
393+
"regions": {
394+
"type": "array",
395+
"items": {
396+
"type": "string"
397+
},
398+
"description": "AWS regions to validate against"
399+
},
400+
"customRules": {
401+
"type": "array",
402+
"items": {
403+
"type": "string"
404+
},
405+
"description": "Paths to custom rule files"
406+
},
407+
"appendRules": {
408+
"type": "array",
409+
"items": {
410+
"type": "string"
411+
},
412+
"description": "Additional rule directories"
413+
},
414+
"overrideSpec": {
415+
"type": "string",
416+
"description": "CloudFormation spec override file path"
417+
},
418+
"registrySchemas": {
419+
"type": "array",
420+
"items": {
421+
"type": "string"
422+
},
423+
"description": "CloudFormation Registry schema paths"
424+
}
425+
},
426+
"additionalProperties": false
427+
},
352428
"aws.cloudformation.diagnostics.cfnGuard.enabled": {
353429
"type": "boolean",
354430
"default": true,

0 commit comments

Comments
 (0)