使用提议的 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兼容。但是，当您将vscode.proposed.<proposal>.d.ts添加到使用@types/vscode的项目中时，最新的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>"]
}