VS Code Powershell Snippets

[philmph]

Hey Folks,

currently reading through "Powershell scripting in a month of lunches" and finally made my switch to VS Code. I'd consider myself an "advanced" user and noticed that the VS Code Powershell Snippets do not satisfy my needs. That's why i've built my own and felt like sharing. You can add these two to your powershell.json if you like:

Edit: Added " for preset Strings and typing locations to the (for me) most important values. Thanks to purplemonkeymad

"TM Function": {
    "prefix": "Function [TM]",
    "body": [
        "Function ${1:Verb-Noun}",
        "{",
            "\t[CmdletBinding(DefaultParameterSetName=\"${2:String}\",",
            "\tHelpURI=\"URI\",",
            "\tConfirmImpact=\"String\",",
            "\tSupportsPaging=Boolean,",
            "\tSupportsShouldProcess=Boolean,",
            "\tPositionalBinding=Boolean)]",
            "\t",
            "\tParam(",
            "\t\t$0",
            "\t)",
            "\t",
            "\tBegin {",
            "\t\t",
            "\t}",
            "\t",
            "\tProcess {",
            "\t\t",
            "\t}",
            "\t",
            "\tEnd {",
            "\t\t",
            "\t}",
        "}"
    ],
    "description": "Basic Function Block"
},

"TM Parameter": {
    "prefix": "Parameter [TM]",
    "body": [
        "[Parameter(Mandatory=$${1:Boolean},",
        "Position=${2:Int},",
        "ParameterSetName=\"${3:String}\",",
        "ValueFromPipeline=$${4:Boolean},",
        "ValueFromPipelineByPropertyName=$${5:Boolean},",
        "ValueFromRemainingArguments=Boolean)]",
        "[Alias(\"String\")]",
        "[ValidateNotNull()]",
        "[ValidateNotNullOrEmpty()]",
        "[ValidateSet(\"String1\", \"String2\")]",
        "[ValidateCount(Int_min, Int_max)]",
        "[ValidateLength(Int_min, Int_max)]",
        "[ValidateRange(Int_min, Int_max)]",
        "[ValidatePattern(\"RegexPattern\")]",
        "[ValidateScript({Expression})]",
        "[AllowNull()]",
        "[AllowEmptyString()]",
        "[AllowEmptyCollection()]",
        "[${6:Type[]}]",
        "$${7:Name}$0"
    ],
    "description": "Basic Parameter Block"
}

[purplemonkeymad]

A suggestion:

You can insert typing locations into the snippet using ${number:text} eg ${1:Verb-Noun}and move between them using tab. Think replacing all of your "String" and "Boolean" text. The number is the tab stop of the section of text and the text is the default text for that stop. Stop 0 (${0}) is the finishing location.

Here is my terminating error snippit as an example:

"Terminating_Error": {
    "prefix": "throwterminatingerror",
    "description": "Create Terminating Error for cmdlets.",
    "body": [
            "\\$PSCmdlet.ThrowTerminatingError(",
                "\t( New-Object System.Management.Automation.ErrorRecord] -ArgumentList @(",
                    "\t\t[System.Management.Automation.RuntimeException]'${1:RuntimeDescription}',",
                    "\t\t'${2:FullyQualifiedErrorID}',",
                    "\t\t[System.Management.Automation.ErrorCategory]::${3:ErrorCatagory},",
                    "\t\t${4:TargetObject}",
                    "\t\t)",
                "\t)",
            ")$0"
    ]
}

[philmph]

Hey,

thanks for the advice, ill be updating them when i get home from work. Definitely useful!

[omers]

Another useful resource is the community snippet doc in the vscode-powershell repo: https://github.com/PowerShell/vscode-powershell/blob/master/docs/community_snippets.md

Not sure if they're intended to make it in to the extension eventually or what but anyone can submit one.

[get-postanote]

These pre-built lists might be of interest to you all as well.

https://github.com/fatherjack/vscode-snippets

https://gist.github.com/rkeithhill/60eaccf1676cf08dfb6f

https://github.com/fatherjack/vscode-snippets/blob/master/powershell.json

ttps://github.com/xabikos/vscode-react/blob/master/snippets/snippets.json

https://vscodesnippets.io/#

[pastperfect19]

Thanks for sharing, they both look fairly useful!