编辑

常用功能

常用功能是你的扩展的重要组成部分。几乎所有扩展都使用其中一些功能。以下是你如何利用它们的方法。

命令

命令是 VS Code 工作方式的核心。你可以打开命令面板来执行命令，将自定义键盘绑定到命令，并右键单击以在上下文菜单中调用命令。

扩展可以

使用 vscode.commands API 注册和执行命令。
通过 contributes.commands 贡献点使命令在命令面板中可用。

在扩展指南 / 命令主题中了解更多关于命令的信息。

配置

扩展可以通过 contributes.configuration 贡献点贡献扩展特定的设置，并使用 workspace.getConfiguration API 读取它们。

键盘绑定

扩展可以添加自定义键盘绑定。在 contributes.keybindings 和键盘绑定主题中了解更多信息。

扩展可以注册自定义上下文菜单项，这些菜单项将在右键单击时显示在 VS Code UI 的不同部分。在 contributes.menus 贡献点了解更多信息。

数据存储

有五种数据存储选项

ExtensionContext.workspaceState：一个工作区存储，你可以在其中写入键/值对。VS Code 管理此存储，并在再次打开同一工作区时恢复它。
ExtensionContext.globalState：一个全局存储，你可以在其中写入键/值对。VS Code 管理此存储，并为每次扩展激活恢复它。你可以通过在 globalState 上使用 setKeysForSync 方法设置同步键来选择性地同步全局存储中的键/值对。
ExtensionContext.storageUri：一个工作区特定的存储 URI，指向一个本地目录，你的扩展在此目录中拥有读/写访问权限。如果你需要存储只能从当前工作区访问的大文件，这是一个不错的选择。
ExtensionContext.globalStorageUri：一个全局存储 URI，指向一个本地目录，你的扩展在此目录中拥有读/写访问权限。如果你需要存储可从所有工作区访问的大文件，这是一个不错的选择。
ExtensionContext.secrets：一个用于存储将加密的秘密（或任何敏感信息）的全局存储。这些不会跨机器同步。对于 VS Code 桌面版，这利用了 Electron 的 safeStorage API。对于 VS Code 网页版，这使用了双密钥加密 (DKE) 实现。

扩展上下文在扩展入口文件中的 activate 函数中可用。

setKeysForSync 示例

如果你的扩展需要在不同机器之间保留一些用户状态，则使用 vscode.ExtensionContext.globalState.setKeysForSync 将状态提供给设置同步。

你可以使用以下模式

// on activate
const versionKey = 'shown.version';
context.globalState.setKeysForSync([versionKey]);

// later on show page
const currentVersion = context.extension.packageJSON.version;
const lastVersionShown = context.globalState.get(versionKey);
if (isHigher(currentVersion, lastVersionShown)) {
    context.globalState.update(versionKey, currentVersion);
}

跨机器共享状态可以通过共享已解除或已查看的标记，帮助避免用户看到欢迎或更新页面的多个实例的问题。

显示通知

几乎所有扩展都需要在某个时刻向用户呈现信息。VS Code 提供了三个 API 用于显示不同严重程度的通知消息

快速选择

借助 vscode.QuickPick API，你可以轻松地收集用户输入或让用户从多个选项中进行选择。QuickInput 示例演示了该 API。

文件选择器

扩展可以使用 window.showOpenDialog API 打开系统文件选择器并选择文件或文件夹。

输出通道

输出面板显示了 OutputChannel 的集合，它们非常适合日志记录。你可以通过 window.createOutputChannel API 轻松利用它。

进度 API

你可以使用 vscode.Progress API 向用户报告进度更新。

进度可以使用 ProgressLocation 选项在不同位置显示

在通知区域
在源代码管理视图
VS Code 窗口中的一般进度

进度示例演示了该 API。

07/09/2025