Skip to content

Commit 1455128

Browse files
JustinGroteJustinGrote
committed
More revamp on scriptanalyzer and others
1 parent c49e069 commit 1455128

File tree

1 file changed

+68
-62
lines changed

1 file changed

+68
-62
lines changed

‎snippets/PowerShell.json

+68-62
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@
2525
"prefix": "calculated-property",
2626
"description": "Typically used with Select-Object or Sort-Object. More: Get-Help about_Calculated_Properties",
2727
"body": [
28-
"@{Name='${1:PropertyName}';Expression={${2:${TM_SELECTED_TEXT:\\$_.PropertyValue}}}}$0"
28+
"@{Name='${1:PropertyName}';Expression={${2:${TM_SELECTED_TEXT:<# Desired result. You can reference this object via \\$_ and \\$PSItem#>}}}}$0 #>"
2929
]
3030
},
3131
"Class": {
3232
"prefix": "class",
3333
"description": "A blueprint used to create instances of objects at run time. More: Get-Help about_Classes",
3434
"body": [
3535
"class ${1:ClassName} {",
36-
"\t${0:${TM_SELECTED_TEXT:#Define the class. Try constructors, properties, or methods}}",
36+
"\t${0:${TM_SELECTED_TEXT:< #Define the class. Try constructors, properties, or methods #>}}",
3737
"}"
3838
]
3939
},
@@ -44,8 +44,8 @@
4444
],
4545
"description": "Set default values and validate object logic at the moment of creating the instance of the class. Constructors have the same name as the class. Constructors might have arguments, to initialize the data members of the new object. More: Get-Help about_Classes",
4646
"body": [
47-
"${1:ClassName}(${2:OptionalParameters}) {",
48-
"\t${0:${TM_SELECTED_TEXT:#Initialize the class. Use \\$this to reference the properties of the instance you are creating}}",
47+
"${1:ClassName}(${2:<#OptionalParameters#>}) {",
48+
"\t${0:${TM_SELECTED_TEXT:<# Initialize the class. Use \\$this to reference the properties of the instance you are creating #>}}",
4949
"}"
5050
]
5151
},
@@ -56,7 +56,7 @@
5656
"description": "A multi-line comment.",
5757
"body": [
5858
"$BLOCK_COMMENT_START",
59-
" # ${{0:$TM_SELECTED_TEXT:Enter a comment or description}}",
59+
" # ${0:{$TM_SELECTED_TEXT:Enter a comment or description}}",
6060
"$BLOCK_COMMENT_END"
6161
]
6262
},
@@ -67,7 +67,7 @@
6767
"do {",
6868
"\t${0:$TM_SELECTED_TEXT}",
6969
"} until (",
70-
"\t${1:#Condition that stops the loop if it returns true}",
70+
"\t${1:<# Condition that stops the loop if it returns true #>}",
7171
")"
7272
]
7373
},
@@ -78,7 +78,7 @@
7878
"do {",
7979
"\t${0:$TM_SELECTED_TEXT}",
8080
"} while (",
81-
"\t${1:#Condition that stops the loop if it returns false})",
81+
"\t${1:<# Condition that stops the loop if it returns false #>})",
8282
")"
8383
]
8484
},
@@ -147,25 +147,25 @@
147147
"description": "else defines what is done when all if and elseif conditions are false. More: Get-Help about_If",
148148
"body": [
149149
"else {",
150-
"\t${0:$TM_SELECTED_TEXT}",
150+
"\t${0:${TM_SELECTED_TEXT:<# Action when all if and elseif conditions are false #>}}",
151151
"}"
152152
]
153153
},
154154
"elseif": {
155155
"prefix": "elseif",
156156
"description": "elseif provides an alternative path when an if condition is false. More: Get-Help about_If",
157157
"body": [
158-
"elseif (${1:condition}) {",
159-
"\t${0:$TM_SELECTED_TEXT}",
158+
"elseif (${1:<#condition#>}) {",
159+
"\t${0:${TM_SELECTED_TEXT:<# Action when this condition is true #>}}",
160160
"}"
161161
]
162162
},
163163
"Enum": {
164164
"prefix": "enum",
165165
"description": "An enumeration is a distinct type that consists of a set of named labels called the enumerator list. More: Get-Help about_Enum",
166166
"body": [
167-
"enum ${1:EnumName} {",
168-
"\t${0:$TM_SELECTED_TEXT}",
167+
"enum ${1:<#EnumName#>} {",
168+
"\t${0:${TM_SELECTED_TEXT:<# Specify a list of distinct values #>}}",
169169
"}"
170170
]
171171
},
@@ -495,10 +495,10 @@
495495
},
496496
"for": {
497497
"prefix": "for",
498-
"description": "for loop snippet",
498+
"description": "Creates a loop that runs commands in a command block while a specified condition evaluates to $true. A typical use of the For loop is to iterate an array of values and to operate on a subset of these values. More: Get-Help about_For",
499499
"body": [
500500
"for ($${1:i} = 0; $${1:i} -lt $${2:array}.Count; $${1:i}++) {",
501-
"\t${0:$TM_SELECTED_TEXT}",
501+
"\t${0:${TM_SELECTED_TEXT:<# Action that will repeat until the condition is met #>}}",
502502
"}"
503503
]
504504
},
@@ -507,16 +507,25 @@
507507
"description": "reversed for loop snippet",
508508
"body": [
509509
"for ($${1:i} = $${2:array}.Count - 1; $${1:i} -ge 0 ; $${1:i}--) {",
510-
"\t${0:$TM_SELECTED_TEXT}",
510+
"\t${0:${$TM_SELECTED_TEXT}}",
511511
"}"
512512
]
513513
},
514514
"foreach": {
515515
"prefix": "foreach",
516-
"description": "foreach loop snippet",
516+
"description": "Iterate through a collection, assigning a variable to the current item on each loop rather than using the automatic variable $PSItem. More: Get-Help about_Foreach",
517517
"body": [
518-
"foreach ($${1:item} in $${2:collection}) {",
519-
"\t${0:$TM_SELECTED_TEXT}",
518+
"foreach ($${1:currentItemName} in $${2:collection}) {",
519+
"\t${0:${TM_SELECTED_TEXT:<# $${1} is the current item #>}}",
520+
"}"
521+
]
522+
},
523+
"foreach-item": {
524+
"prefix": "foreach-item",
525+
"description": "Quicker definition of foreach, just highlight the variable name of the collection you want to use and type 'item' then enter then tab. More: Get-Help about_Foreach",
526+
"body": [
527+
"foreach (${1/(.*)/$1Item/} in ${1:${TM_SELECTED_TEXT:collection}}) {",
528+
"\t${0:${1/(.*)/$1Item/}}",
520529
"}"
521530
]
522531
},
@@ -525,7 +534,7 @@
525534
"description": "[PS 7+] Process multiple objects in parallel using runspaces. This has some limitations compared to a regular ForEach-Object. More: Get-Help ForEach-Object",
526535
"body": [
527536
"${1:\\$collection} | Foreach-Object -ThrottleLimit ${2:5} -Parallel {",
528-
" ${0:${TM_SELECTED_TEXT:#Reference items via \\$PSItem and bring in outside variables with \\$USING:varname}}",
537+
" ${0:${TM_SELECTED_TEXT:#Action that will run in Parallel. Reference the current object via \\$PSItem and bring in outside variables with \\$USING:varname}}",
529538
"}"
530539
]
531540
},
@@ -592,25 +601,6 @@
592601
"}"
593602
]
594603
},
595-
"Function-Help": {
596-
"prefix": "help-function",
597-
"description": "Comment-based help for an advanced function snippet",
598-
"body": [
599-
"<#",
600-
".SYNOPSIS",
601-
"\t${1:A short one-line action-based description, e.g. 'Tests if a function is valid'}",
602-
".DESCRIPTION",
603-
"\t${2:A longer description of the function, its purpose, common use cases, etc.}",
604-
".NOTES",
605-
"\t${3:Information or caveats about the function e.g. 'This function is not supported in Linux'}",
606-
".LINK",
607-
"\t${4:Specify a URI to a help page, this will show when Get-Help -Online is used.}",
608-
".EXAMPLE",
609-
"\t${5:Test-MyTestFunction -Verbose}",
610-
"\t${6:Explanation of the function or its result. You can include multiple examples with additional .EXAMPLE lines}",
611-
"#>"
612-
]
613-
},
614604
"Function-Inline": {
615605
"prefix": "Function-Inline",
616606
"description": "Function definition snippet that does not contain a param block, but defines parameters inline. This syntax is commonly used in other languages",
@@ -621,10 +611,7 @@
621611
]
622612
},
623613
"Hashtable": {
624-
"prefix": [
625-
"Hashtable",
626-
"@{"
627-
],
614+
"prefix": "Hashtable",
628615
"description": "A key/value store that are very effecient for finding and retrieving data. More: Get-Help about_Hash_Tables",
629616
"body": [
630617
"\\$${1:Var} = @{",
@@ -633,7 +620,7 @@
633620
]
634621
},
635622
"Hidden Property": {
636-
"prefix": "class-proph",
623+
"prefix": "class-proph-hidden",
637624
"description": "Useful for creating properties and methods within a class that you do not necessarily want other users of the class to see, or readily be able to edit. More: about_Hidden",
638625
"body": [
639626
"hidden [${1:string}] $${0:PropertyName}"
@@ -662,16 +649,16 @@
662649
},
663650
"if": {
664651
"prefix": "if",
665-
"description": "if statement snippet",
652+
"description": "Run code blocks if a specified conditional test evaluates to true. More: Get-Help about_If",
666653
"body": [
667654
"if (${1:condition}) {",
668-
"\t${0:$TM_SELECTED_TEXT}",
655+
"\t${0:${TM_SELECTED_TEXT:<# Action to perform if the condition is true #>}}",
669656
"}"
670657
]
671658
},
672659
"IfShouldProcess": {
673660
"prefix": "if-Should-Process",
674-
"description": "Creates ShouldProcess block",
661+
"description": "Defines a condition that only executes if -WhatIf is not set, and returns a message otherwise. More: https://docs.microsoft.com/en-us/powershell/scripting/learn/deep-dives/everything-about-shouldprocess",
675662
"body": [
676663
"if (\\$PSCmdlet.ShouldProcess(\"${1:Target}\", \"${2:Operation}\")) {",
677664
"\t${0:$TM_SELECTED_TEXT}",
@@ -943,28 +930,48 @@
943930
},
944931
"Suppress PSScriptAnalyzer Rule": {
945932
"prefix": "suppress-message-rule",
946-
"description": "Suppress a built-in PSScriptAnalyzer rule using the SuppressMessageAttribute",
933+
"description": "Suppress a PSScriptAnalyzer rule. More: https://docs.microsoft.com/en-us/powershell/utility-modules/psscriptanalyzer/overview?view=ps-modules#suppressing-rules",
947934
"body": [
948-
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute('${1:PSUseDeclaredVarsMoreThanAssignments}', '')]"
935+
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
936+
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',<#CheckId#>\\$null,",
937+
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
938+
")]"
949939
]
950940
},
951-
"Suppress PSScriptAnalyzer Rule in Scope": {
952-
"prefix": "suppress-message-rule-for-scope",
953-
"description": "Suppress a built-in PSScriptAnalyzer rule for functions or classes in a specific scope using the SuppressMessageAttribute",
941+
"Suppress PSScriptAnalyzer Rule in Function": {
942+
"prefix": "suppress-message-rule-function",
943+
"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",
954944
"body": [
955-
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute('${1:PSProvideDefaultParameterValue}', '', Scope='Function', Target='${2:*}')]"
945+
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
946+
"\t<#Category#>'${1:PSProvideDefaultParameterValue}', <#CheckId>\\$null, Scope='Function',",
947+
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
948+
")]"
956949
]
957950
},
958951
"Suppress PSScriptAnalyzer Rule on Parameter": {
959-
"prefix": "suppress-message-rule-for-parameter",
960-
"description": "Suppress a built-in PSScriptAnalyzer rule on a parameter using the SuppressMessageAttribute",
952+
"prefix": "suppress-message-rule-parameter",
953+
"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",
961954
"body": [
962-
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute('${1:PSUseDeclaredVarsMoreThanAssignments}', '${2:ParamName}')]"
955+
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
956+
"\t<#ParameterName#>'${0:${TM_SELECTED_TEXT:ParamName}}",
957+
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
958+
")]"
959+
]
960+
},
961+
"Suppress PSScriptAnalyzer Rule on a specific Scope": {
962+
"prefix": "suppress-message-rule-scope",
963+
"description": "Suppress a PSScriptAnaylzer 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",
964+
"body": [
965+
"[Diagnostics.CodeAnalysis.SuppressMessageAttribute(",
966+
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}', <#CheckId#>\\$null, Scope='Function',",
967+
"\tTarget='${1:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}'",
968+
"\tJustification = '${0:Reason for suppressing}}'",
969+
")]"
963970
]
964971
},
965972
"switch": {
966973
"prefix": "switch",
967-
"description": "switch statement snippet",
974+
"description": "Equivalent to a series of if statements, but it is simpler. The switch statement lists each condition and an optional action. If a condition obtains, the action is performed. More: about_Switch",
968975
"body": [
969976
"switch (${1:\\$x}) {",
970977
"\t${2:condition} { ${0:$TM_SELECTED_TEXT} }",
@@ -976,8 +983,7 @@
976983
"prefix": "ternary",
977984
"description": "[PS 7+] Simplified version of if-else popular in other languages that works in Powershell. More: about_If",
978985
"body": [
979-
"(${TM_SELECTED_TEXT:${1:condition}}) ? $(${2:actionIfTrue}) : $(${3:actionIfFalse})",
980-
"$0"
986+
"(${1:${TM_SELECTED_TEXT:condition}}) ? $(${2:<#Action if True#>}) : $(${0:<#Action If False#>})"
981987
]
982988
},
983989
"try-catch": {
@@ -988,7 +994,7 @@
988994
"\t${0:$TM_SELECTED_TEXT}",
989995
"}",
990996
"catch {",
991-
"\t{1:Do this if a terminating exception happens}",
997+
"\t{1:<#Do this if a terminating exception happens#>}",
992998
"}"
993999
]
9941000
},
@@ -1000,10 +1006,10 @@
10001006
"\t${0:$TM_SELECTED_TEXT}",
10011007
"}",
10021008
"catch {",
1003-
"\t{1:Do this if a terminating exception happens}",
1009+
"\t${1:<#Do this if a terminating exception happens#>}",
10041010
"}",
10051011
"finally {",
1006-
"\t{2:Do this after the try block regardless of whether an exception occurred or not}",
1012+
"\t${2:<#Do this after the try block regardless of whether an exception occurred or not#>}",
10071013
"}"
10081014
]
10091015
},
@@ -1015,7 +1021,7 @@
10151021
"\t${0:$TM_SELECTED_TEXT}",
10161022
"}",
10171023
"finally {",
1018-
"\t{2:Do this after the try block regardless of whether an exception occurred or not}",
1024+
"\t${2:<#Do this after the try block regardless of whether an exception occurred or not#>}",
10191025
"}"
10201026
]
10211027
},

0 commit comments

Comments
 (0)