Skip to content

Modernize built-in snippets #3839

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
andyleejordan merged 14 commits into from
Mar 5, 2022
Merged

Modernize built-in snippets #3839

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
ba742d6
Add Function-Help Snippet
JustinGrote Jan 29, 2022
096c543
Sort file properly
JustinGrote Feb 19, 2022
4d897ba
Fix format indent
JustinGrote Feb 19, 2022
46a6ba0
ArgumentCompleterAttribute
JustinGrote Feb 19, 2022
114460d
ArgumentCompleterAttribute Updates
JustinGrote Feb 19, 2022
5c69b38
Add class Help
JustinGrote Feb 19, 2022
c0f82b8
Remove Comment Help
JustinGrote Feb 19, 2022
0b49bec
Lots of Updates
JustinGrote Feb 20, 2022
1e1fc46
Remove comment about requires
JustinGrote Feb 20, 2022
6e2f92a
More revamp on scriptanalyzer and others
JustinGrote Feb 20, 2022
dd3c093
More cleanup and Sort
JustinGrote Feb 21, 2022
c1c06ca
Comment out Examples/DSC/Pester
JustinGrote Feb 21, 2022
c7d3990
Spell check and more Get-Help
andyleejordan Mar 5, 2022
ab1e93d
Move commented out snippets to community snippets document
andyleejordan Mar 5, 2022
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
Prev Previous commit
Next Next commit
Spell check and more Get-Help
  • Loading branch information
@andyleejordan
andyleejordan committed Mar 5, 2022
commit c7d39906fd77e063bd3760acbf78f8525230becc
42 changes: 21 additions & 21 deletions snippets/PowerShell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"ArgumentCompleterAttribute": {
"prefix": "argument-completer",
"description": "Allows you to add tab completion values to a specific parameter by writing a scriptblock that generates zero or more CompletionResult objects. More: Get-Help about_Functions_Argument_Completion",
"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])]",
Expand Down Expand Up @@ -563,7 +563,7 @@
// },
"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",
"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 #>}}",
Expand Down Expand Up @@ -608,7 +608,7 @@
},
"function": {
"prefix": "function",
"description": "A simple function with a parameter block to specify function arguments",
"description": "A simple function with a parameter block to specify function arguments. More: Get-Help about_Functions",
"body": [
"function ${1:FunctionName} {",
"\tparam (",
Expand Down Expand Up @@ -647,7 +647,7 @@
"function-advanced",
"cmdlet"
],
"description": "Script advanced function definition snippet",
"description": "Script advanced function definition snippet. More: Get-Help about_Functions_Advanced",
"body": [
"function ${1:Verb-Noun} {",
"\t[CmdletBinding()]",
Expand All @@ -671,7 +671,7 @@
},
"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",
"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}",
Expand All @@ -693,7 +693,7 @@
},
"Hashtable": {
"prefix": "Hashtable",
"description": "A key/value store that are very effecient for finding and retrieving data. More: Get-Help about_Hash_Tables",
"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}",
Expand All @@ -718,7 +718,7 @@
"hsl",
"literal-here-string"
],
"description": "Escape all text regardless. More: Get-Help about_Quoting_Rules",
"description": "Escape all text literally. More: Get-Help about_Quoting_Rules",
"body": [
"@'",
"${0:TM_SELECTED_TEXT}",
Expand All @@ -728,14 +728,14 @@
},
"Hidden Property": {
"prefix": "class-proph-hidden",
"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: Get-Help about_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])",
"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(",
Expand Down Expand Up @@ -774,7 +774,7 @@
},
"ModuleManifest": {
"prefix": "manifest",
"description": "Basic skeleton for a PowerShell module manifest, complete with PowerShell Gallery metadata.",
"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",
Expand Down Expand Up @@ -829,14 +829,14 @@
"\t\t}",
"\t}",
"",
"\t# If your module supports updateable help, what is the URI to the help archive? (optional)",
"\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.",
"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()]",
Expand Down Expand Up @@ -948,7 +948,7 @@
},
"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?view=powershell-7.2",
"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()]",
Expand Down Expand Up @@ -976,7 +976,7 @@
},
"Region Block": {
"prefix": "#region",
"description": "Region Block for organizing and folding of your code",
"description": "Region block for organizing and folding of your code",
"body": [
"#region ${1}",
"${0:$TM_SELECTED_TEXT}",
Expand All @@ -985,7 +985,7 @@
},
"Scope: Suppress PSScriptAnalyzer Rule": {
"prefix": "suppress-message-rule-scope",
"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",
"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',",
Expand All @@ -996,7 +996,7 @@
},
"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: about_Splatting",
"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}",
Expand All @@ -1019,7 +1019,7 @@
},
"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: about_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} }",
Expand All @@ -1029,14 +1029,14 @@
},
"Ternary Operator": {
"prefix": "ternary",
"description": "[PS 7+] Simplified version of if-else popular in other languages that works in Powershell. More: about_If",
"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: about_Try_Catch_Finally",
"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}",
Expand All @@ -1048,7 +1048,7 @@
},
"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: about_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}",
Expand All @@ -1063,7 +1063,7 @@
},
"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: about_Try_Catch_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}",
Expand Down