变量引用

Visual Studio Code 支持在 调试 和 任务 配置文件中进行变量替换，以及部分选定的设置。变量替换通过使用 ${variableName} 语法，在 launch.json 和 tasks.json 文件的某些键和值字符串中得到支持。

预定义变量

支持以下预定义变量

预定义变量示例

假设您有以下条件

1. 在编辑器中打开了一个位于 /home/your-username/your-project/folder/file.ext 的文件；
2. 目录 /home/your-username/your-project 已作为根工作区打开。

这将导致每个变量具有以下值

• ${userHome}: /home/your-username
• ${workspaceFolder}: /home/your-username/your-project
• ${workspaceFolderBasename}: your-project
• ${file}: /home/your-username/your-project/folder/file.ext
• ${fileWorkspaceFolder}: /home/your-username/your-project
• ${relativeFile}: folder/file.ext
• ${relativeFileDirname}: folder
• ${fileBasename}: file.ext
• ${fileBasenameNoExtension}: file
• ${fileExtname}: .ext
• ${fileDirname}: /home/your-username/your-project/folder
• ${fileDirnameBasename}: folder
• ${lineNumber}: 光标的行号
• ${columnNumber}: 光标的列号
• ${selectedText}: 在代码编辑器中选定的文本
• ${execPath}: Code.exe 的位置
• ${pathSeparator}: macOS 或 Linux 上是 /，Windows 上是 \

平台和工作区注意事项

特定于平台的行为

一些预定义变量可能会根据操作系统解析为不同的值

• 在 Windows 上，文件路径使用反斜杠（\）。在 JSON 文件（如 tasks.json 或 launch.json）中组合路径时，请确保正确转义反斜杠（例如："${workspaceFolder}\\subdir"）。
• 在 macOS 和 Linux 上，文件路径使用正斜杠（/）。

建议使用 ${pathSeparator} 或 ${/} 来使配置跨平台兼容。

按工作区文件夹范围限定的变量

通过在变量后面追加根文件夹的名称（用冒号分隔），可以访问工作区的同级根文件夹。如果没有根文件夹名称，则变量的作用域与使用它的文件夹相同。

例如，在一个多根工作区中，包含 Server 和 Client 文件夹，${workspaceFolder:Client} 指的是 Client 根的路径。

环境变量

您可以使用 ${env:Name} 语法引用环境变量。例如，${env:USERNAME} 引用 USERNAME 环境变量。

{
  "type": "node",
  "request": "launch",
  "name": "Launch Program",
  "program": "${workspaceFolder}/app.js",
  "cwd": "${workspaceFolder}",
  "args": ["${env:USERNAME}"]
}

配置变量

要引用 VS Code 设置（配置），请使用 ${config:Name} 语法。例如，${config:editor.fontSize} 引用 editor.fontSize 设置。

命令变量

您可以使用任何 VS Code 命令作为变量，语法为 ${command:commandID}。

命令变量将被命令执行的（字符串）结果替换。命令的实现范围可以是从一个不带 UI 的简单计算，到基于 VS Code 扩展 API 可用 UI 功能的复杂功能。如果命令返回的不是字符串，则变量替换将不会完成。命令变量必须返回一个字符串。

这是此功能的一个示例：VS Code 的 Node.js 调试器扩展提供了一个交互式命令 extension.pickNodeProcess，用于从所有正在运行的 Node.js 进程列表中选择一个进程。该命令返回所选进程的进程 ID。这样就可以在按进程 ID 附加的启动配置中使用 extension.pickNodeProcess 命令，如下所示：

{
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Attach by Process ID",
      "processId": "${command:extension.pickNodeProcess}"
    }
  ]
}

在启动配置或任务配置中使用命令变量时，将当前 launch.json 配置作为对象通过参数传递给命令。这使得命令在被调用时能够了解特定 launch.json 配置的上下文和参数。

输入变量

命令变量已经很强大了，但它们缺乏一种机制来为特定用例配置要运行的命令。例如，无法为通用的“用户输入提示”传递提示消息或默认值。

这个限制通过输入变量得到解决，其语法为 ${input:variableID}。variableID 指的是 launch.json 和 tasks.json 的 inputs 部分中的条目，其中指定了其他配置属性。不支持嵌套输入变量。

以下示例显示了一个使用输入变量的 tasks.json 的整体结构

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "task name",
      "command": "${input:variableID}"
      // ...
    }
  ],
  "inputs": [
    {
      "id": "variableID",
      "type": "type of input variable"
      // type specific configuration attributes
    }
  ]
}

目前 VS Code 支持三种类型的输入变量

• promptString：显示一个输入框以从用户获取字符串。
• pickString：显示一个快速选择下拉列表，让用户从多个选项中进行选择。
• command：运行任意命令。

每种类型都需要额外的配置属性

promptString:

• description：显示在快速输入中，为输入提供上下文。
• default：如果用户未输入其他内容，则使用的默认值。
• password：设置为 true 以使用密码提示进行输入，该提示不会显示输入的字符。

pickString:

• description：显示在快速选择中，为输入提供上下文。
• options：一个供用户选择的选项数组。
• default：如果用户未输入其他内容，则使用的默认值。它必须是选项值之一。

选项可以是字符串值，也可以是同时包含标签和值的对象。下拉列表将显示 label: value。

command:

• command：在变量插值时运行命令。
• args：传递给命令实现的可选参数包。

下面是一个 tasks.json 示例，说明了如何使用 inputs（以 Angular CLI 为例）

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "ng g",
      "type": "shell",
      "command": "ng",
      "args": ["g", "${input:componentType}", "${input:componentName}"]
    }
  ],
  "inputs": [
    {
      "type": "pickString",
      "id": "componentType",
      "description": "What type of component do you want to create?",
      "options": [
        "component",
        "directive",
        "pipe",
        "service",
        "class",
        "guard",
        "interface",
        "enum"
      ],
      "default": "component"
    },
    {
      "type": "promptString",
      "id": "componentName",
      "description": "Name your component.",
      "default": "my-new-component"
    }
  ]
}

运行示例

以下示例展示了如何在调试配置中使用类型为 command 的用户输入变量，该变量允许用户从特定文件夹中找到的所有测试用例列表中选择一个。假定某个扩展提供了 extension.mochaSupport.testPicker 命令，该命令可以定位可配置位置的所有测试用例并显示一个选择器 UI 来选择其中一个。命令输入的参数由命令本身定义。

{
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Run specific test",
      "program": "${workspaceFolder}/${input:pickTest}"
    }
  ],
  "inputs": [
    {
      "id": "pickTest",
      "type": "command",
      "command": "extension.mochaSupport.testPicker",
      "args": {
        "testFolder": "/out/tests"
      }
    }
  ]
}

命令输入也可以与任务一起使用。在此示例中，使用了内置的 Terminate Task 命令。它可以接受一个参数来终止所有任务。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Terminate All Tasks",
      "command": "echo ${input:terminate}",
      "type": "shell",
      "problemMatcher": []
    }
  ],
  "inputs": [
    {
      "id": "terminate",
      "type": "command",
      "command": "workbench.action.tasks.terminate",
      "args": "terminateAll"
    }
  ]
}

常见问题

调试配置或任务中变量替换的详细信息

调试配置或任务中的变量替换是一个两阶段过程

• 第一阶段，所有变量都解析为字符串结果。如果一个变量出现多次，它只解析一次。
• 第二阶段，所有变量都用第一阶段的结果进行替换。

这意味着变量的解析（例如，扩展中实现的基于命令的变量）无法访问调试配置或任务中的其他已替换变量。它只能看到原始变量。这意味着变量不能相互依赖（这确保了隔离性，并使替换对评估顺序具有鲁棒性）。

用户和工作区设置是否支持变量替换？

预定义变量支持 settings.json 文件中的部分设置键，例如终端的 cwd、env、shell 和 shellArgs 值。一些设置，如 window.title，有自己的变量。

  "window.title": "${dirty}${activeEditorShort}${separator}${rootName}${separator}${appName}"

请参考设置编辑器中的注释（⌘, (Windows、Linux Ctrl+,)），以了解特定于设置的变量。

为什么 ${workspaceRoot} 没有被记录？

变量 ${workspaceRoot} 已被弃用，取而代之的是 ${workspaceFolder}，以更好地与多根工作区支持保持一致。

为什么 tasks.json 中的变量没有被解析？

tasks.json 中的并非所有值都支持变量替换。特别是，只有 command、args 和 options 支持变量替换。inputs 部分中的输入变量将不会被解析，因为不支持嵌套输入变量。

如何知道变量的实际值？

检查变量运行时值的简单方法是创建一个 VS Code 任务，将变量值输出到控制台。例如，要查看 ${workspaceFolder} 的解析值，可以在 tasks.json 中创建并运行（终端 > 运行任务）以下简单的“echo”任务。

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "echo",
      "type": "shell",
      "command": "echo ${workspaceFolder}"
    }
  ]
}

相关资源

• 调试
• 任务