使用提议的 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 安装后，您需要在项目文件夹中退出并从命令行重新启动 VS Code Insiders，使用 code-insiders . --enable-proposed-api=<YOUR-EXTENSION-ID>。
如果您希望将使用建议 API 的扩展设置为在每次启动 VS Code Insiders 时都可用，您可以运行首选项：配置运行时参数命令来编辑 .vscode-insiders/argv.json 文件，以设置已启用扩展的列表。
{
...
"enable-proposed-api": ["<YOUR-EXTENSION-ID>"]
}