使用建议的 API

在 Visual Studio Code，我们非常重视扩展 API 的兼容性。我们尽最大努力避免破坏性的 API 变更，扩展作者可以期望已发布的扩展程序能够继续工作。然而，这给我们带来了很大的限制：一旦我们引入一个 API，我们就不能轻易地更改它了。

建议的 API 为我们解决了这个问题。建议的 API 是一组不稳定的 API，它们在 VS Code 中实现，但没有像稳定的 API 那样公开。它们可能会发生变化，仅在 Insiders 发行版中可用，并且不能在已发布的扩展中使用。尽管如此，扩展作者可以在本地开发中测试这些新的 API，并为 VS Code 团队提供反馈以迭代 API。最终，建议的 API 将进入稳定的 API，并可供所有扩展使用。

使用建议的 API

以下是在本地扩展开发中测试建议的 API 的步骤

• 使用 VS Code 的 Insiders 版本。
• 在您的 package.json 中，添加 "enabledApiProposals": ["<proposalName>"]。
• 将相应的 vscode.proposed.<proposalName>.d.ts 文件复制到您项目的源代码位置。

@vscode/dts CLI 实用程序允许您快速下载最新的 vscode.proposed.<proposalName>.d.ts 以进行扩展开发。它会根据您的 package.json 文件中列出的建议下载定义文件。

> npx @vscode/dts dev
Downloading vscode.proposed.languageStatus.d.ts
To:   /Users/Me/Code/MyExtension/vscode.proposed.languageStatus.d.ts
From: https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.languageStatus.d.ts
Read more about proposed API at: https://vscode.js.cn/api/advanced-topics/using-proposed-api

这里有一个使用建议的 API 的示例：proposed-api-sample。

建议的 API 不兼容性

在主分支上，vscode.proposed.<proposalName>.d.ts 始终与 vscode.d.ts 兼容。但是，当您将使用 @types/vscode 的 vscode.proposed.<proposal>.d.ts 添加到您的项目时，最新的 vscode.proposed.<proposal>.d.ts 可能与 @types/vscode 中的版本不兼容。

您可以通过以下任一方法解决此问题

• 移除对 @types/vscode 的依赖，并使用 npx @vscode/dts main 从 microsoft/vscode 主分支下载 vscode.d.ts。
• 使用 @types/vscode@<version>，并同时使用 npx @vscode/dts dev <version> 从 microsoft/vscode 的旧分支下载 vscode.proposed.<proposal>.d.ts。但是，请注意，API 可能已在最新版本的 VS Code Insiders 中更改。

使用建议的 API 分享扩展

虽然您无法在 Marketplace 上发布使用建议的 API 的扩展，但您仍然可以通过打包和分享您的扩展与您的同行分享。

要打包您的扩展，您可以运行 vsce package 以创建扩展的 VSIX 文件。然后，您可以将此 VSIX 文件分享给其他人，以便在他们的 VS Code 中安装该扩展。

要从 VSIX 文件安装扩展，您需要进入“扩展”视图，选择 ... 省略号 查看和更多操作 按钮，然后选择 从 VSIX 安装...。

下面的短视频显示了选择 从 VSIX 安装... 菜单项。

对于使用建议的 API 的扩展，还有几个步骤来启用您的扩展。从 VSIX 安装后，您需要退出并从命令行使用 code-insiders . --enable-proposed-api=<YOUR-EXTENSION-ID> 在您的项目文件夹中重新启动 VS Code Insiders。

如果您希望设置成使您的使用建议的 API 的扩展在每次启动 VS Code Insiders 时始终可用，您可以运行 首选项：配置运行时参数 命令来编辑 .vscode-insiders/argv.json 文件，以设置已启用扩展的列表。

{
    ...
    "enable-proposed-api": ["<YOUR-EXTENSION-ID>"]
}