Skip to content

Fix for "Suppress PSScriptAnalyzer Rule" snippets #5110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2024
Merged

Fix for "Suppress PSScriptAnalyzer Rule" snippets #5110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions snippets/PowerShell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,8 +268,9 @@
"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",
"body": [
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
"\t<#Category#>'${1:PSProvideDefaultParameterValue}', <#CheckId>\\$null, Scope='Function',",
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
"\t<#Category#>'${1:PSProvideDefaultParameterValue}', <#CheckId#>\\$null,",
"\tScope='Function',",
"\tJustification='${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
")]"
]
},
Expand Down Expand Up @@ -522,9 +523,10 @@
],
"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",
"body": [
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
"\t<#ParameterName#>'${0:${TM_SELECTED_TEXT:ParamName}}',",
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
"\t<#ParameterName#>'${2:${TM_SELECTED_TEXT:ParamName}}',",
"\tJustification='${0:Reason for suppressing}'",
")]"
]
},
Expand Down Expand Up @@ -566,13 +568,17 @@
]
},
"Scope: Suppress PSScriptAnalyzer Rule": {
"prefix": "suppress-message-rule-scope",
"prefix": [
"suppress-message-rule-scope",
"[SuppressMessageAttribute]"
],
"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",
"body": [
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}', <#CheckId#>\\$null, Scope='Function',",
"\tTarget='${1:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}'",
"\tJustification = '${0:Reason for suppressing}}'",
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}', <#CheckId#>\\$null,",
"\tScope='${2|Function,Parameter,Class,Variable,Object|}',",
"\tTarget='${3:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}',",
"\tJustification='${0:Reason for suppressing}'",
")]"
]
},
Expand Down
Loading