Skip to content

Commit 1aa99c2

Browse files
authored
Fix for "suppress psscriptanalyzer rule" snippets (#5110)
Fix for issue #5108 - Corrects a missing close comment in the Function rule snippet - Corrects the tab stop numbering in the Parameter rule snippet as well as duplicate use of `$TM_SELECTED_TEXT` - Adds a missing comma in The Scope rule snippet - Minor formatting
1 parent d1a89fa commit 1aa99c2

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

snippets/PowerShell.json

+15-9
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,9 @@
268268
"description": "Suppress a PSScriptAnalyzer rule for a function. More: https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules#suppressing-rules",
269269
"body": [
270270
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
271-
"\t<#Category#>'${1:PSProvideDefaultParameterValue}', <#CheckId>\\$null, Scope='Function',",
272-
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
271+
"\t<#Category#>'${1:PSProvideDefaultParameterValue}', <#CheckId#>\\$null,",
272+
"\tScope='Function',",
273+
"\tJustification='${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
273274
")]"
274275
]
275276
},
@@ -522,9 +523,10 @@
522523
],
523524
"description": "Suppress a PSScriptAnalyzer rule on a parameter. More: https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules#suppressing-rules",
524525
"body": [
525-
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
526-
"\t<#ParameterName#>'${0:${TM_SELECTED_TEXT:ParamName}}',",
527-
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
526+
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
527+
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
528+
"\t<#ParameterName#>'${2:${TM_SELECTED_TEXT:ParamName}}',",
529+
"\tJustification='${0:Reason for suppressing}'",
528530
")]"
529531
]
530532
},
@@ -566,13 +568,17 @@
566568
]
567569
},
568570
"Scope: Suppress PSScriptAnalyzer Rule": {
569-
"prefix": "suppress-message-rule-scope",
571+
"prefix": [
572+
"suppress-message-rule-scope",
573+
"[SuppressMessageAttribute]"
574+
],
570575
"description": "Suppress a PSScriptAnalyzer rule based on a function/parameter/class/variable/object's name by setting the SuppressMessageAttribute's Target property to a regular expression or a glob pattern. More: https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules#suppressing-rules",
571576
"body": [
572577
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
573-
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}', <#CheckId#>\\$null, Scope='Function',",
574-
"\tTarget='${1:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}'",
575-
"\tJustification = '${0:Reason for suppressing}}'",
578+
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}', <#CheckId#>\\$null,",
579+
"\tScope='${2|Function,Parameter,Class,Variable,Object|}',",
580+
"\tTarget='${3:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}',",
581+
"\tJustification='${0:Reason for suppressing}'",
576582
")]"
577583
]
578584
},

0 commit comments

Comments
 (0)