在 VS 代码片段中为 Powershell 变量保留 $

Question

我可以在 Powershell 的 VS 代码中保存带有选项卡间距的代码 sn-ps，但是当我调用 sn-p 时，它不显示我的变量的 $，从而一直忽略我的变量。它只会粘贴名称并省略$。

当你选择你的代码 sn-p 时，如何让 VS 代码粘贴到 $ 中？

这是我用于“模板”sn-p 的 VS Code JSON 文件

{
    // Place your snippets for powershell here. Each snippet is defined under a snippet name and has a prefix, body and 
    // description. The prefix is what is used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
    // $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. Placeholders with the 
    // same ids are connected.
    // Example:
    // "Print to console": {
    //  "prefix": "log",
    //  "body": [
    //      "console.log('$1');",
    //      "$2"
    //  ],
    //  "description": "Log output to console"
    // }

"Template": {
    "prefix": "template",
    "body": [
        "<#",
        ".SYNOPSIS",
        "\t<Overview of script>",
        "",
        ".SYNTAX",
        "\t<Cmdlet-Name> -Parameter <value>",
        "",
        ".DESCRIPTION",
        "\t<Brief description of script>",
        "",
        ".PARAMETER <Parameter_Name>",
        "\t<Brief description of parameter input required. Repeat this attribute if required>",
        "",
        ".INPUTS",
        "\t<Inputs if any, otherwise state None>",
        "",
        ".OUTPUTS",
        "\t<Outputs if any, otherwise state None - example: Log file stored in C:\file.log>",
        "", 
        ".EXAMPLE",
        "\t<Example goes here. Repeat this attribute for more than one example>",
        "",
        ".REMARKS",
        "\tVersion:        1.0",
        "#>",
        "",
        "#---------------------------------------------------------[Variables]------------------------------------------------------------",
        "",
        "$var1 = <stuff>",
        "$var2 = <stuff>",
        "",
        "#---------------------------------------------------------[Import Modules]--------------------------------------------------------",
        "",
        "Import-Module <name>",
        "",
        "#-----------------------------------------------------------[Functions]------------------------------------------------------------",
        "",
        "Function <FunctionName> {",
        "\t[CmdletBindinging()]",
        "\tparam(",
        "\t\t[Parameter()]",
        "\t\t[string]$MyOptionalParameter,",
        "",
        "\t\t[Parameter(Mandatory)]",
        "\t\t[int]$MyMandatoryParameter",
        "\t)",
        "",   
        "\tTry{",
        "\t\t<code goes here>",
        "\t}",
        "", 
        "\tCatch {",
        "\t\tWrite-Host $Error.Exception",
        "\t\t$Error.Exception | Out-File Out-File $env:TEMP\file.log",
        "\t\tBreak",
        "\t}",
        "",
        "\tFinally {",
        "\t\t$time = Get-Date",
        "\t\tcompleted at $time | Out-File $env:TEMP\file.log",
        "\t}",
        "}",
        "",
        "#-----------------------------------------------------------[Execution]------------------------------------------------------------",
        "",
        "<FunctionName>",
    ],
    "description": "test"
}

}

当我调用这个 sn-p 将模板粘贴到新的 .ps1 文件中时，它会省略所有 $。你如何让那些留下来？

Answer 1

在 Visual Studio Code sn-p 正文中使用 \\$ 来嵌入 文字 $。

例如，要嵌入 PowerShell 变量 $HOME，请使用 \\$HOME。

注意：从 sn-p 解析器的角度来看，single \ 是转义所必需的，但由于 sn-ps 被定义为 JavaScript 字符串，它们本身使用\ 作为转义字符，需要\\ 才能将单个\ 传递给sn-p 解析器。

见the docs。

---

顺便说一句：

使用$$ 偶然，有点有效，但它的目的不是逃避，它会导致不同的行为：

$$-prefixed 标识符的位置变为 制表符，因为 Visual Studio Code 将序列解释如下：

第一个$ 变成文字^[1]，但第二个$ 和后面的标识符被解释为Visual Studio Code 变量引用；如果该名称的内置变量不存在，则将其用作占位符文本。

---

^{[1] 任何 $not 后跟有效的 Visual Studio Code 占位符名称或变量引用均按字面意思处理。}