变量参考
Visual Studio Code 支持在调试和任务配置文件以及某些选定设置中使用变量替换。使用 ${variableName} 语法，可以在 launch.json 和 tasks.json 文件中的某些键和值字符串内进行变量替换。
预定义变量
支持以下预定义变量
- ${userHome} - 用户主文件夹的路径
- ${workspaceFolder} - 在 VS Code 中打开的文件夹的路径
- ${workspaceFolderBasename} - 在 VS Code 中打开的文件夹的名称，不带任何斜杠 (/)。
- ${file} - 当前打开的文件
- ${fileWorkspaceFolder} - 当前打开的文件的工作区文件夹
- ${relativeFile} - 当前打开的文件相对于
workspaceFolder的路径 - ${relativeFileDirname} - 当前打开的文件的 dirname 相对于
workspaceFolder的路径 - ${fileBasename} - 当前打开的文件的基本名称
- ${fileBasenameNoExtension} - 当前打开的文件不带扩展名的基本名称
- ${fileExtname} - 当前打开的文件的扩展名
- ${fileDirname} - 当前打开的文件的文件夹路径
- ${fileDirnameBasename} - 当前打开的文件的文件夹名称
- ${cwd} - VS Code 启动时任务运行器的当前工作目录
- ${lineNumber} - 活动文件中当前选定的行号
- ${selectedText} - 活动文件中当前选定的文本
- ${execPath} - 正在运行的 VS Code 可执行文件的路径
- ${defaultBuildTask} - 默认构建任务的名称
- ${pathSeparator} - 操作系统用于分隔文件路径中组件的字符
- ${/} - ${pathSeparator} 的简写
预定义变量示例
假设您有以下要求
- 一个位于
/home/your-username/your-project/folder/file.ext的文件在您的编辑器中打开； - 目录
/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 - ${fileDirname} -
/home/your-username/your-project/folder - ${fileExtname} -
.ext - ${lineNumber} - 光标所在的行号
- ${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：如果用户未输入其他内容，将使用的默认值。它必须是其中一个选项值。
选项可以是字符串值，也可以是具有标签和值的对象。下拉列表将显示标签: 值。
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"
}
]
}
运行示例
以下示例说明如何在调试配置中使用 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}"
}
]
}