{{ message }}
Repository navigation
Expand file tree
/
Copy pathPowerShell.json
More file actions
707 lines (707 loc) · 28.6 KB
/
Copy pathPowerShell.json
File metadata and controls
707 lines (707 loc) · 28.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
{
"ArgumentCompleterAttribute": {
"prefix": "argument-completer",
"description": "Allows you to add tab completion values to a specific parameter by writing a script block that generates zero or more CompletionResult objects. More: Get-Help about_Functions_Argument_Completion",
"body": [
"[ArgumentCompleter({",
"\t[OutputType([System.Management.Automation.CompletionResult])]",
"\tparam(",
"\t\t[string] \\$CommandName,",
"\t\t[string] \\$ParameterName,",
"\t\t[string] \\$WordToComplete,",
"\t\t[System.Management.Automation.Language.CommandAst] \\$CommandAst,",
"\t\t[System.Collections.IDictionary] \\$FakeBoundParameters",
"\t)",
"\t",
"\t\\$CompletionResults = [System.Collections.Generic.List[System.Management.Automation.CompletionResult]]::new()",
"\t",
"\t${0:$TM_SELECTED_TEXT}",
"\t",
"\treturn \\$CompletionResults",
"})]"
]
},
"Calculated Property": {
"prefix": "calculated-property",
"description": "Typically used with Select-Object or Sort-Object. More: Get-Help about_Calculated_Properties",
"body": [
"@{Name='${1:PropertyName}';Expression={${2:${TM_SELECTED_TEXT:<# Desired result. You can reference this object via \\$_ and \\$PSItem #>}}}}$0"
]
},
"Class": {
"prefix": "class",
"description": "A blueprint used to create instances of objects at run time. More: Get-Help about_Classes",
"body": [
"class ${1:ClassName} {",
"\t${0:${TM_SELECTED_TEXT:<# Define the class. Try constructors, properties, or methods. #>}}",
"}"
]
},
"Class Constructor": {
"prefix": ["ctor-class", "class-constructor"],
"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",
"body": [
"${1:ClassName}(${2:<#OptionalParameters#>}) {",
"\t${0:${TM_SELECTED_TEXT:<# Initialize the class. Use \\$this to reference the properties of the instance you are creating #>}}",
"}"
]
},
"Class Method": {
"prefix": "class-method",
"description": "Defines the actions that a class can perform. Methods may take parameters that provide input data. Methods can return output. Data returned by a method can be any defined data type. More: Get-Help about_Classes",
"body": [
"[${1:void}] ${2:MethodName}($${3:OptionalParameters}) {",
"\t${0:${TM_SELECTED_TEXT:<# Action to perform. You can use $$this to reference the current instance of this class #>}}",
"}"
]
},
"Class Property": {
"prefix": "class-property",
"description": "Properties are variables declared at class scope. A property may be of any built-in type or an instance of another class. Classes have no restriction in the number of properties they have. More: Get-Help about_Classes",
"body": ["[${1:propertyType}] $${0:PropertyName}"]
},
"Comment Block": {
"prefix": ["block-comment"],
"description": "A multi-line comment.",
"body": [
"$BLOCK_COMMENT_START",
" # ${0:{$TM_SELECTED_TEXT:Enter a comment or description}}",
"$BLOCK_COMMENT_END"
]
},
"do-until": {
"prefix": "do-until",
"description": "Runs a statement list repeatedly until a condition is met More: Get-Help about_Do",
"body": [
"do {",
"\t${0:$TM_SELECTED_TEXT}",
"} until (",
"\t${1:<# Condition that stops the loop if it returns true #>}",
")"
]
},
"do-while": {
"prefix": "do-while",
"description": "Runs a statement list repeatedly as long as a condition is met. More: Get-Help about_Do",
"body": [
"do {",
"\t${0:$TM_SELECTED_TEXT}",
"} while (",
"\t${1:<# Condition that stops the loop if it returns false #>}",
")"
]
},
"else": {
"prefix": "else",
"description": "else defines what is done when all if and elseif conditions are false. More: Get-Help about_If",
"body": [
"else {",
"\t${0:${TM_SELECTED_TEXT:<# Action when all if and elseif conditions are false #>}}",
"}"
]
},
"elseif": {
"prefix": "elseif",
"description": "elseif provides an alternative path when an if condition is false. More: Get-Help about_If",
"body": [
"elseif (${1:<#condition#>}) {",
"\t${0:${TM_SELECTED_TEXT:<# Action when this condition is true #>}}",
"}"
]
},
"Enum": {
"prefix": "enum",
"description": "An enumeration is a distinct type that consists of a set of named labels called the enumerator list. More: Get-Help about_Enum",
"body": [
"enum ${1:<#EnumName#>} {",
"\t${0:${TM_SELECTED_TEXT:<# Specify a list of distinct values #>}}",
"}"
]
},
"for": {
"prefix": "for",
"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",
"body": [
"for ($${1:i} = 0; $${1:i} -lt $${2:array}.Count; $${1:i}++) {",
"\t${0:${TM_SELECTED_TEXT:<# Action that will repeat until the condition is met #>}}",
"}"
]
},
"for-reversed": {
"prefix": "forr",
"description": "reversed for loop snippet",
"body": [
"for ($${1:i} = $${2:array}.Count - 1; $${1:i} -ge 0 ; $${1:i}--) {",
"\t${0:${$TM_SELECTED_TEXT}}",
"}"
]
},
"foreach": {
"prefix": "foreach",
"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",
"body": [
"foreach ($${1:currentItemName} in $${2:collection}) {",
"\t${0:${TM_SELECTED_TEXT:<# $${1} is the current item #>}}",
"}"
]
},
"foreach-item": {
"prefix": "foreach-item",
"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",
"body": [
"foreach (${1/(.*)/$1Item/} in ${1:${TM_SELECTED_TEXT:collection}}) {",
"\t${0:${1/(.*)/$1Item/}}",
"}"
]
},
"Foreach with Progress": {
"prefix": "foreach-progress",
"description": "Insert a foreach loop with Write-Progress initialized",
"body": [
"\\$total = \\$${1:array}.count",
"\\$${4:i} = 1",
"\\$progPercent = \"{0:n2}\" -f ([math]::round(\\$${4:i}/\\$total,4) * 100)",
"Write-Progress -Activity \"${3:activityName}\" -Status \"\\$${4:i} of \\$total - \\$progPercent% Complete:\" -PercentComplete \\$progPercent",
"foreach ($${2:item} in $${1:array}) {",
" \\$progPercent = \"{0:n2}\" -f ([math]::round(\\$${4:i}/\\$total,4) * 100)",
" Write-Progress -Activity \"${3:activityName}\" -Status \"\\$${4:i} of \\$total - \\$progPercent% Complete:\" -PercentComplete \\$progPercent",
" # Insert Code Here",
" ${0}",
" ",
" \\$${4:i}++",
"}",
""
]
},
"ForEach-Object -Parallel": {
"prefix": "foreach-parallel",
"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",
"body": [
"${1:\\$collection} | Foreach-Object -ThrottleLimit ${2:5} -Parallel {",
" ${0:${TM_SELECTED_TEXT:#Action that will run in Parallel. Reference the current object via \\$PSItem and bring in outside variables with \\$USING:varname}}",
"}"
]
},
"function": {
"prefix": "function",
"description": "A simple function with a parameter block to specify function arguments. More: Get-Help about_Functions",
"body": [
"function ${1:FunctionName} {",
"\tparam (",
"\t\t${2:OptionalParameters}",
"\t)",
"\t${0:$TM_SELECTED_TEXT}",
"}"
]
},
"Function Help": {
"prefix": ["help-function", "comment-help"],
"description": "Comment-based help for an advanced function. More: Get-Help about_Comment_Based_Help",
"body": [
"<#",
".SYNOPSIS",
"\t${1:A short one-line action-based description, e.g. 'Tests if a function is valid'}",
".DESCRIPTION",
"\t${2:A longer description of the function, its purpose, common use cases, etc.}",
".NOTES",
"\t${3:Information or caveats about the function e.g. 'This function is not supported in Linux'}",
".LINK",
"\t${4:Specify a URI to a help page, this will show when Get-Help -Online is used.}",
".EXAMPLE",
"\t${5:Test-MyTestFunction -Verbose}",
"\t${6:Explanation of the function or its result. You can include multiple examples with additional .EXAMPLE lines}",
"#>",
"",
"${0:$TM_SELECTED_TEXT}"
]
},
"Function-Advanced": {
"prefix": ["function-advanced", "cmdlet"],
"description": "Script advanced function definition snippet. More: Get-Help about_Functions_Advanced",
"body": [
"function ${1:Verb-Noun} {",
"\t[CmdletBinding()]",
"\tparam (",
"\t\t$0",
"\t)",
"\t",
"\tbegin {",
"\t\t",
"\t}",
"\t",
"\tprocess {",
"\t\t$TM_SELECTED_TEXT",
"\t}",
"\t",
"\tend {",
"\t\t",
"\t}",
"}"
]
},
"Function-Advanced-Doc-Full-Example-From-ISE": {
"prefix": ["function-advanced-doc-fromISE", "cmdlet-doc-fromISE"],
"description": "Script advanced function definition with full comment-based help and parameter attributes.",
"body": [
"function ${1:Verb-Noun} {",
"\t<#",
"\t.SYNOPSIS",
"\t${2:Short description}",
"\t.DESCRIPTION",
"\t${3:Long description}",
"\t.EXAMPLE",
"\t${4:Example of how to use this cmdlet}",
"\t.EXAMPLE",
"\t${5:Another example of how to use this cmdlet}",
"\t.INPUTS",
"\t${6:Inputs to this cmdlet (if any)}",
"\t.OUTPUTS",
"\t${7:Output from this cmdlet (if any)}",
"\t.NOTES",
"\t${8:General notes}",
"\t.COMPONENT",
"\t${9:The component this cmdlet belongs to}",
"\t.ROLE",
"\t${10:The role this cmdlet belongs to}",
"\t.FUNCTIONALITY",
"\t${11:The functionality that best describes this cmdlet}",
"\t#>",
"\t[CmdletBinding(DefaultParameterSetName = '${12:ParameterSet1}',",
"\t\tSupportsShouldProcess,",
"\t\tPositionalBinding,",
"\t\tHelpUri = '${13:http://yourwebsiteforhelp.here}',",
"\t\tConfirmImpact = 'Medium')]",
"\t[Alias('${14:Be-lazyWithThis}','${15:lzy}','${16:Use-OldFunctionName}')]",
"\t[OutputType([${17:String}])]",
"\tparam (",
"\t\t# ${18:Param1} help description",
"\t\t[Parameter(Mandatory,",
"\t\t\tValueFromPipeline,",
"\t\t\tValueFromPipelineByPropertyName,",
"\t\t\tValueFromRemainingArguments,",
"\t\t\tPosition = 0,",
"\t\t\tParameterSetName = '${12:ParameterSet1}')]",
"\t\t[ValidateNotNull()]",
"\t\t[ValidateNotNullOrEmpty()]",
"\t\t[ValidateCount(0, 5)]",
"\t\t[ValidateSet(\"${19:sun}\", \"${20:moon}\", \"${21:earth}\")]",
"\t\t[Alias(\"${22:p1}\")]",
"\t\t$${18:Param1},",
"",
"\t\t# ${24:Param2} help description",
"\t\t[Parameter(ParameterSetName = '${12:ParameterSet1}')]",
"\t\t[AllowNull()]",
"\t\t[AllowEmptyCollection()]",
"\t\t[AllowEmptyString()]",
"\t\t[ValidateScript({ ${25:true} })]",
"\t\t[ValidateRange(0, 5)]",
"\t\t[${26:int}]",
"\t\t$${24:Param2},",
"",
"\t\t# ${28:Param3} help description",
"\t\t[Parameter(ParameterSetName = '${29:Another Parameter Set}')]",
"\t\t[ValidatePattern(\"${30:[a-z]*}\")]",
"\t\t[ValidateLength(0, 15)]",
"\t\t[${31:String}]",
"\t\t$${28:Param3},",
"",
"\t\t# ${33:Param4} help description",
"\t\t# Checkout the docs https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_functions_argument_completion?view=powershell-7.5#argumentcompletions-attribute on different ways to provide Argument Completion",
"\t\t[Parameter(ParameterSetName = '${34:Yet Another Parameter Set}')]",
"\t\t[ArgumentCompleter({'${35:add completer script}'})]",
"\t\t[ValidateLength(0, 15)]",
"\t\t[${36:String}]",
"\t\t$${33:Param4}",
"\t)",
"",
"\tbegin {",
"\t\t${38:#BeginCodeHere}",
"\t}",
"",
"\tprocess {",
"\t\tif (\\$pscmdlet.ShouldProcess(\"${39:Target}\", \"${40:Operation}\")) {",
"\t\t\t${41:#ProcessCodeHere}",
"\t\t}",
"\t}",
"",
"\tend {",
"\t\t${42:#EndCodeHere}",
"\t}",
"",
"\tclean {",
"\t\t${43:#CleanCodeHere} - Added in 7.3 for more information see https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_functions_advanced_methods?view=powershell-7.5#clean",
"\t}",
"}"
]
},
"Function-Inline": {
"prefix": "function-inline",
"description": "Function definition snippet that does not contain a param block, but defines parameters inline. This syntax is commonly used in other languages. More: Get-Help about_Functions",
"body": [
"function ${1:FunctionName} (${2:OptionalParameters}) {",
"\t${0:$TM_SELECTED_TEXT}",
"}"
]
},
"Function: Suppress PSScriptAnalyzer Rule": {
"prefix": ["suppress-message-rule-function", "[SuppressMessageAttribute]"],
"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,",
"\tScope='Function',",
"\tJustification='${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
")]"
]
},
"Hashtable": {
"prefix": "hashtable",
"description": "A key/value store that are very efficient for finding and retrieving data. More: Get-Help about_Hash_Tables",
"body": ["\\$${1:Var} = @{", "\t${2:Name} = ${3:Value}", "}"]
},
"Here-String": {
"prefix": ["hs", "here-string"],
"description": "Escape all text but evaluate variables. More: Get-Help about_Quoting_Rules",
"body": ["@\"", "${0:TM_SELECTED_TEXT}", "\"@", ""]
},
"Here-String (Literal)": {
"prefix": ["hsl", "literal-here-string"],
"description": "Escape all text literally. More: Get-Help about_Quoting_Rules",
"body": ["@'", "${0:TM_SELECTED_TEXT}", "'@", ""]
},
"Hidden Property": {
"prefix": "class-proph-hidden",
"description": "Useful for creating internal properties and methods within a class that are hidden from users. More: Get-Help about_Hidden",
"body": ["hidden [${1:string}] $${0:PropertyName}"]
},
"IArgumentCompleter Class": {
"prefix": "iargument-completer",
"description": "Implementation of the IArgumentCompleter interface that can be directly attached to parameters (e.g. [MyCustomArgumentCompleter]). More: Get-Help about_Functions_Argument_Completion",
"body": [
"class ${1:ArgumentCompleter} : System.Management.Automation.IArgumentCompleter {",
"\t[System.Collections.Generic.IEnumerable[System.Management.Automation.CompletionResult]] CompleteArgument(",
"\t\t[string] \\$CommandName,",
"\t\t[string] \\$ParameterName,",
"\t\t[string] \\$WordToComplete,",
"\t\t[System.Management.Automation.Language.CommandAst] \\$CommandAst,",
"\t\t[System.Collections.IDictionary] \\$FakeBoundParameters",
"\t) {",
"\t\t\\$CompletionResults = [System.Collections.Generic.List[System.Management.Automation.CompletionResult]]::new()",
"\t\t",
"\t\t${0:$TM_SELECTED_TEXT}",
"\t\t",
"\t\treturn \\$CompletionResults",
"\t}",
"}"
]
},
"if": {
"prefix": "if",
"description": "Run code blocks if a specified conditional test evaluates to true. More: Get-Help about_If",
"body": [
"if (${1:condition}) {",
"\t${0:${TM_SELECTED_TEXT:<# Action to perform if the condition is true #>}}",
"}"
]
},
"IfShouldProcess": {
"prefix": "if-should-process",
"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",
"body": [
"if (\\$PSCmdlet.ShouldProcess(\"${1:Target}\", \"${2:Operation}\")) {",
"\t${0:$TM_SELECTED_TEXT}",
"}"
]
},
"ModuleManifest": {
"prefix": "manifest",
"description": "Basic skeleton for a PowerShell module manifest, complete with PowerShell Gallery metadata. More: https://docs.microsoft.com/en-us/powershell/scripting/developer/module/how-to-write-a-powershell-module-manifest",
"body": [
"@{",
"\t# If authoring a script module, the RootModule is the name of your .psm1 file",
"\tRootModule = '${module:MyModule}.psm1'",
"",
"\tAuthor = '${author:Cool Person <coolperson@email.local>}'",
"",
"\tCompanyName = '${company:Contoso Inc.}'",
"",
"\tModuleVersion = '${ModuleVersion:0.1}'",
"",
"\t# Use the New-Guid command to generate a GUID, and copy/paste into the next line",
"\tGUID = '<pasteNewGUIDhere>'",
"",
"\tCopyright = '2017 ${company:Copyright Holder}'",
"",
"\tDescription = '${Description:What does this module do?}'",
"",
"\t# Minimum PowerShell version supported by this module (optional, recommended)",
"\t# PowerShellVersion = ''",
"",
"\t# Which PowerShell Editions does this module work with? (Core, Desktop)",
"\tCompatiblePSEditions = @('Desktop', 'Core')",
"",
"\t# Which PowerShell functions are exported from your module? (eg. Get-CoolObject)",
"\tFunctionsToExport = @('')",
"",
"\t# Which PowerShell aliases are exported from your module? (eg. gco)",
"\tAliasesToExport = @('')",
"",
"\t# Which PowerShell variables are exported from your module? (eg. Fruits, Vegetables)",
"\tVariablesToExport = @('')",
"",
"\t# PowerShell Gallery: Define your module's metadata",
"\tPrivateData = @{",
"\t\tPSData = @{",
"\t\t\t# What keywords represent your PowerShell module? (eg. cloud, tools, framework, vendor)",
"\t\t\tTags = @('${tag1:cooltag1}', '${tag2:cooltag2}')",
"",
"\t\t\t# What software license is your code being released under? (see https://opensource.org/licenses)",
"\t\t\tLicenseUri = ''",
"",
"\t\t\t# What is the URL to your project's website?",
"\t\t\tProjectUri = ''",
"",
"\t\t\t# What is the URI to a custom icon file for your project? (optional)",
"\t\t\tIconUri = ''",
"",
"\t\t\t# What new features, bug fixes, or deprecated features, are part of this release?",
"\t\t\tReleaseNotes = @'",
"'@",
"\t\t}",
"\t}",
"",
"\t# If your module supports updatable help, what is the URI to the help archive? (optional)",
"\t# HelpInfoURI = ''",
"}"
]
},
"Parallel Pipeline Function": {
"prefix": "function-parallel-pipeline",
"description": "Collects everything in the process block and does work in the end block. Useful when making a 'fan out' function that acts on multiple items simultaneously because the pipeline only does one item at a time in the process block. More: Get-Help about_Functions_Advanced",
"body": [
"function $1 {",
" [CmdletBinding()]",
" param(",
" [parameter(ValueFromPipeline)]$$2",
" )",
"",
" begin {",
" [Collections.ArrayList]\\$inputObjects = @()",
" }",
" process {",
" [void]\\$inputObjects.Add($$2)",
" }",
" end {",
" \\$inputObjects | Foreach -Parallel {",
" $0",
" }",
" }",
"}"
]
},
"Parameter": {
"prefix": "parameter",
"description": "A parameter definition for a method or function. More: Get-Help about_Functions",
"body": [
"# ${1:Parameter help description}",
"[Parameter(${2:AttributeValues})]",
"[${3:ParameterType}]",
"$${0:ParameterName}"
]
},
"Parameter_Block": {
"prefix": "param-block-advanced-function",
"description": "A parameter block for an advanced function. More: Get-Help about_Functions_Advanced",
"body": [
"[CmdletBinding()]",
"param (",
" [Parameter()]",
" [${1:TypeName}]",
" $${2:ParameterName}$0",
")"
]
},
"Parameter-LiteralPath": {
"prefix": "parameter-literalpath",
"description": "Parameter declaration snippet for a LiteralPath parameter",
"body": [
"# Specifies a path to one or more locations. Unlike the Path parameter, the value of the LiteralPath parameter is",
"# used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters,",
"# enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any",
"# characters as escape sequences.",
"[Parameter(Mandatory=\\$true,",
" Position=${1:0},",
" ParameterSetName=\"${2:LiteralPath}\",",
" ValueFromPipelineByPropertyName=\\$true,",
" HelpMessage=\"Literal path to one or more locations.\")]",
"[Alias(\"PSPath\")]",
"[ValidateNotNullOrEmpty()]",
"[string[]]",
"$${2:LiteralPath}$0"
]
},
"Parameter-Path": {
"prefix": "parameter-path",
"description": "Parameter declaration snippet for Path parameter that does not accept wildcards. Do not use with parameter-literalpath.",
"body": [
"# Specifies a path to one or more locations.",
"[Parameter(Mandatory=\\$true,",
" Position=${1:0},",
" ParameterSetName=\"${2:ParameterSetName}\",",
" ValueFromPipeline=\\$true,",
" ValueFromPipelineByPropertyName=\\$true,",
" HelpMessage=\"Path to one or more locations.\")]",
"[Alias(\"PSPath\")]",
"[ValidateNotNullOrEmpty()]",
"[string[]]",
"$${3:ParameterName}$0"
]
},
"Parameter-Path-Wildcards": {
"prefix": "parameter-path-wildcards",
"description": "Parameter declaration snippet for Path parameter that accepts wildcards. Add parameter-literalpath to handle paths with embedded wildcard chars.",
"body": [
"# Specifies a path to one or more locations. Wildcards are permitted.",
"[Parameter(Mandatory=\\$true,",
" Position=${1:Position},",
" ParameterSetName=\"${2:ParameterSetName}\",",
" ValueFromPipeline=\\$true,",
" ValueFromPipelineByPropertyName=\\$true,",
" HelpMessage=\"Path to one or more locations.\")]",
"[ValidateNotNullOrEmpty()]",
"[SupportsWildcards()]",
"[string[]]",
"$${3:ParameterName}$0"
]
},
"Parameter: Suppress PSScriptAnalyzer Rule": {
"prefix": ["suppress-message-rule-parameter", "[SuppressMessageAttribute]"],
"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(",
"\t<#Category#>'${1:PSUseDeclaredVarsMoreThanAssignments}',",
"\t<#ParameterName#>'${2:${TM_SELECTED_TEXT:ParamName}}',",
"\tJustification='${0:Reason for suppressing}'",
")]"
]
},
"Pipeline Function": {
"prefix": "function-pipeline",
"description": "Basic function that accepts pipeline input. More: https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_pipelines",
"body": [
"function $1 {",
" [CmdletBinding()]",
" param(",
" [parameter(ValueFromPipeline)]$2",
" )",
"",
" process {",
" $0",
" }",
"}"
]
},
"PSCustomObject": {
"prefix": ["pscustomobject", "[PSCustomObject]"],
"description": "Create a custom object from a hashtable of properties. More: Get-Help about_PSCustomObject",
"body": ["[PSCustomObject]@{", "\t${1:Name} = ${2:Value}", "}"]
},
"Region Block": {
"prefix": "region",
"description": "Region block for organizing and folding of your code",
"body": ["#region ${1}", "${0:$TM_SELECTED_TEXT}", "#endregion"]
},
"Scope: Suppress PSScriptAnalyzer Rule": {
"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,",
"\tScope='${2|Function,Parameter,Class,Variable,Object|}',",
"\tTarget='${3:${TM_SELECTED_TEXT:RegexOrGlobPatternToMatchName}}',",
"\tJustification='${0:Reason for suppressing}'",
")]"
]
},
"splat": {
"prefix": "splat",
"description": "Use a hashtable to capture the parameters of a function and then pass them to a function in a concise way. More: Get-Help about_Splatting",
"body": [
"$${1/[^\\w]/_/}Params = @{",
"\t${2:Parameter} = ${0:Value}",
"}",
"${1:${TM_SELECTED_TEXT}} @${1/[^\\w]/_/}Params"
]
},
"Suppress PSScriptAnalyzer Rule": {
"prefix": ["suppress-message-rule", "[SuppressMessageAttribute]"],
"description": "Suppress a PSScriptAnalyzer rule. 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,",
"\tJustification = '${0:${TM_SELECTED_TEXT:Reason for suppressing}}'",
")]"
]
},
"switch": {
"prefix": "switch",
"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: Get-Help about_Switch",
"body": [
"switch (${1:\\$x}) {",
"\t${2:condition} { ${0:$TM_SELECTED_TEXT} }",
"\tDefault {}",
"}"
]
},
"Ternary Operator": {
"prefix": "ternary",
"description": "[PS 7+] Simplified version of if-else popular in other languages that works in Powershell. More: Get-Help about_If",
"body": [
"(${1:${TM_SELECTED_TEXT:condition}}) ? $(${2:<#Action if True#>}) : $(${0:<#Action If False#>})"
]
},
"try-catch": {
"prefix": "try-catch",
"description": "Attempt a block of code and if a terminating exception occurs, perform another block of code rather than terminate the program More: Get-Help about_Try_Catch_Finally",
"body": [
"try {",
"\t${0:$TM_SELECTED_TEXT}",
"}",
"catch {",
"\t${1:<#Do this if a terminating exception happens#>}",
"}"
]
},
"try-catch-finally": {
"prefix": "try-catch-finally",
"description": "Attempt a block of code and if a terminating exception occurs, perform another block of code, finally performing a final block of code regardless of the outcome. More: Get-Help about_Try_Catch_Finally",
"body": [
"try {",
"\t${0:$TM_SELECTED_TEXT}",
"}",
"catch {",
"\t${1:<#Do this if a terminating exception happens#>}",
"}",
"finally {",
"\t${2:<#Do this after the try block regardless of whether an exception occurred or not#>}",
"}"
]
},
"try-finally": {
"prefix": "try-finally",
"description": "Attempt a block of code and perform an action regardless of the outcome. Useful for cleanup or gracefully disconnecting active sessions even if there was a terminating error. More: Get-Help about_Try_Catch_Finally",
"body": [
"try {",
"\t${0:$TM_SELECTED_TEXT}",
"}",
"finally {",
"\t${2:<#Do this after the try block regardless of whether an exception occurred or not#>}",
"}"
]
},
"while": {
"prefix": "while",
"description": "Repeatedly perform an action after verifying a condition is true first. More: Get-Help about_While",
"body": ["while (${1:condition}) {", "\t${0:$TM_SELECTED_TEXT}", "}"]
}
}
You can’t perform that action at this time.