🚀 在 VS Code 中！

变量参考

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

预定义变量

支持以下预定义变量

  • ${userHome} - 用户主文件夹的路径
  • ${workspaceFolder} - 在 VS Code 中打开的文件夹的路径
  • ${workspaceFolderBasename} - 在 VS Code 中打开的文件夹的名称，不带任何斜杠 (/)。
  • ${file} - 当前打开的文件
  • ${fileWorkspaceFolder} - 当前打开文件的工作区文件夹
  • ${relativeFile} - 当前打开的文件相对于 workspaceFolder 的路径
  • ${relativeFileDirname} - 当前打开文件的目录名相对于 workspaceFolder 的路径
  • ${fileBasename} - 当前打开文件的基本名称
  • ${fileBasenameNoExtension} - 当前打开文件的基本名称，不带文件扩展名
  • ${fileExtname} - 当前打开文件的扩展名
  • ${fileDirname} - 当前打开文件的文件夹路径
  • ${fileDirnameBasename} - 当前打开文件的文件夹名称
  • ${cwd} - 任务运行器在 VS Code 启动时的当前工作目录
  • ${lineNumber} - 活动文件中当前选定行的行号
  • ${columnNumber} - 活动文件中当前选定列的列号
  • ${selectedText} - 活动文件中当前选定的文本
  • ${execPath} - 正在运行的 VS Code 可执行文件的路径
  • ${defaultBuildTask} - 默认构建任务的名称
  • ${pathSeparator} - 操作系统用于分隔文件路径中组件的字符
  • ${/} - ${pathSeparator} 的简写形式

预定义变量示例

假设您有以下要求

  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 上为 \

提示：在 tasks.json 和 launch.json 的字符串值内使用 IntelliSense 来获取预定义变量的完整列表。

按工作区文件夹范围划分的变量

通过将根文件夹的名称附加到变量（用冒号分隔），可以访问工作区的同级根文件夹。如果没有根文件夹名称，则变量的作用域限定为使用它的同一文件夹。

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

环境变量

您还可以通过 ${env:Name} 语法引用环境变量（例如，${env:USERNAME}）。

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

配置变量

您可以通过 ${config:Name} 语法引用 VS Code 设置（“配置”）（例如，${config: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 配置将作为对象通过参数传递给命令。这允许命令在调用时了解特定 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 的示例，说明了如何使用 Angular CLI 的 inputs

{
  "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"
    }
  ]
}

运行示例

Inputs Example

以下示例说明了如何在调试配置中使用 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"
      }
    }
  ]
}

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

{
  "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}"
    }
  ]
}
02/06/2025