VS Code API

当身份验证提供程序的身份验证会话被添加、删除或更改时触发的 Event。

获取用户已登录指定提供程序的所有帐户。将其与 getSession 配合使用，以获取特定帐户的身份验证会话。

目前，只有两个由内置扩展贡献到编辑器并实现 GitHub 和 Microsoft 身份验证的身份验证提供程序：它们的 providerId 分别是 'github' 和 'microsoft'。

注意：获取帐户并不意味着您的扩展可以访问该帐户或其身份验证会话。您可以通过调用 getSession 来验证对帐户的访问权限。

获取与所需范围匹配的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示一个快速选择器以选择他们想要使用的帐户。

目前，只有两个由内置扩展贡献到编辑器并实现 GitHub 和 Microsoft 身份验证的身份验证提供程序：它们的 providerId 分别是 'github' 和 'microsoft'。

获取与所需范围匹配的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示一个快速选择器以选择他们想要使用的帐户。

目前，只有两个由内置扩展贡献到编辑器并实现 GitHub 和 Microsoft 身份验证的身份验证提供程序：它们的 providerId 分别是 'github' 和 'microsoft'。

获取与所需范围匹配的身份验证会话。如果未注册具有 providerId 的提供程序，或者用户不同意与扩展共享身份验证信息，则拒绝。如果存在多个具有相同范围的会话，将向用户显示一个快速选择器以选择他们想要使用的帐户。

目前，只有两个由内置扩展贡献到编辑器并实现 GitHub 和 Microsoft 身份验证的身份验证提供程序：它们的 providerId 分别是 'github' 和 'microsoft'。

注册身份验证提供程序。

每个 ID 只能有一个提供程序，如果 ID 已被另一个提供程序使用，则会抛出错误。ID 区分大小写。

创建一个新的 聊天参与者 实例。

执行由给定命令标识符表示的命令。

• 注意 1： 执行编辑器命令时，并非所有类型都允许作为参数传递。允许的类型包括原始类型 string、boolean、number、undefined 和 null，以及 Position、Range、Uri 和 Location。
• 注意 2： 执行扩展贡献的命令时没有限制。

检索所有可用命令的列表。以划线开头的命令被视为内部命令。

注册一个可以通过键盘快捷键、菜单项、操作或直接调用的命令。

使用已存在的命令标识符两次注册命令将导致错误。

注册一个文本编辑器命令，可以通过键盘快捷键、菜单项、操作或直接调用。

文本编辑器命令与普通 命令 不同，它们只在调用命令时有活动编辑器时执行。此外，编辑器命令的命令处理程序可以访问活动编辑器和 编辑 构建器。请注意，编辑构建器仅在回调执行期间有效。

创建一个新的 评论控制器 实例。

当前活动的 调试控制台。如果没有活动的调试会话，发送到调试控制台的输出将不显示。

当前活动的 调试会话 或 undefined。活动的调试会话是调试操作浮动窗口所代表的会话，或者是调试操作浮动窗口下拉菜单中当前显示的会话。如果没有活动的调试会话，则值为 undefined。

当前聚焦的线程或堆栈帧，如果没有聚焦线程或堆栈，则为 undefined。只要有活动的调试会话，线程就可以被聚焦，而堆栈帧只能在会话暂停并检索到调用堆栈时被聚焦。

断点列表。

当 活动调试会话 更改时触发的 Event。注意，当活动调试会话更改为 undefined 时，该事件也会触发。

当 debug.activeStackItem 更改时触发的事件。

当断点集被添加、删除或更改时发出的 Event。

当从 调试会话 收到自定义 DAP 事件时触发的 Event。

当新的 调试会话 启动时触发的 Event。

当 调试会话 终止时触发的 Event。

添加断点。

将通过调试适配器协议接收的“Source”描述符对象转换为可用于加载其内容的 Uri。如果源描述符基于路径，则返回文件 Uri。如果源描述符使用引用编号，则构造一个需要相应 ContentProvider 和正在运行的调试会话的特定调试 Uri（方案 'debug'）

如果“Source”描述符没有足够的信息来创建 Uri，则会抛出错误。

为特定调试类型注册 调试适配器描述符工厂。扩展只允许为其定义的调试类型注册 DebugAdapterDescriptorFactory。否则会抛出错误。为一种调试类型注册多个 DebugAdapterDescriptorFactory 会导致错误。

为给定调试类型注册调试适配器跟踪器工厂。

为特定调试类型注册 调试配置提供程序。可选的 triggerKind 可用于指定何时触发提供程序的 provideDebugConfigurations 方法。目前有两种触发方式：值为 Initial（或未给出触发方式参数）时，provideDebugConfigurations 方法用于提供初始调试配置以复制到新创建的 launch.json 中。使用触发方式 Dynamic 时，provideDebugConfigurations 方法用于动态确定要呈现给用户的调试配置（除了 launch.json 中的静态配置）。请注意，triggerKind 参数仅适用于 provideDebugConfigurations 方法：因此 resolveDebugConfiguration 方法完全不受影响。为不同触发方式注册具有解析方法的单个提供程序，会导致多次调用相同的解析方法。可以为相同类型注册多个提供程序。

移除断点。

通过使用命名的启动或命名的复合配置，或通过直接传递 DebugConfiguration 来开始调试。命名的配置将在给定文件夹中找到的 '.vscode/launch.json' 中查找。在调试开始之前，所有未保存的文件都将保存，并且启动配置将更新。配置中使用的文件夹特定变量（例如 '${workspaceFolder}'）将根据给定文件夹解析。

停止给定的调试会话，如果省略会话，则停止所有调试会话。

应用程序的托管位置。在桌面端是 'desktop'，在 Web 端是指定的嵌入器，例如 'github.dev'、'codespaces'，或者如果嵌入器未提供该信息，则为 'web'。

编辑器的应用程序名称，例如 'VS Code'。

编辑器运行的应用程序根文件夹。

注意，在没有应用程序根文件夹表示的环境中运行时，该值为空字符串。

系统剪贴板。

指示这是应用程序的全新安装。如果在安装后的第一天内，则为 true，否则为 false。

指示用户是否启用了遥测。可以观察到这一点以确定扩展是否应该发送遥测。

表示首选用户语言，例如 de-CH、fr 或 en-US。

编辑器的当前日志级别。

计算机的唯一标识符。

远程的名称。由扩展定义，流行的示例包括 Windows Subsystem for Linux 的 wsl 或使用安全 shell 的远程的 ssh-remote。

注意，当没有远程扩展主机时，该值为 undefined，但在存在远程扩展主机时，所有扩展主机（本地和远程）中都定义了该值。使用 Extension.extensionKind 来了解特定扩展是否远程运行。

当前会话的唯一标识符。每次启动编辑器时都会更改。

检测到的扩展主机的默认 shell，这由扩展主机平台的 terminal.integrated.defaultProfile 设置覆盖。请注意，在不支持 shell 的环境中，该值为空字符串。

UI 类型属性指示从哪个 UI 访问扩展。例如，可以从桌面应用程序或 Web 浏览器访问扩展。

编辑器在操作系统中注册的自定义 URI 方案。

当编辑器的日志级别更改时触发的 Event。

当默认 shell 更改时触发的 Event。这将触发新的 shell 路径。

当用户启用或禁用遥测时触发的 Event。如果用户启用了遥测，则为 true，如果用户禁用了遥测，则为 false。

将 URI 解析为外部可访问的形式。

http: 或 https: 方案

将从扩展运行位置的 外部 URI（例如 http: 或 https: 链接）解析为客户端机器上相同资源的 URI。

如果扩展在客户端机器上运行，则此操作是空操作。

如果扩展远程运行，此函数会自动在本地机器和远程上的 target 之间建立端口转发隧道，并返回隧道的本地 URI。端口转发隧道的生命周期由编辑器管理，并且隧道可以由用户关闭。

注意，通过 openExternal 传递的 URI 会自动解析，您不应该对它们调用 asExternalUri。

vscode.env.uriScheme

创建一个 URI，如果它在浏览器中打开（例如通过 openExternal），将触发已注册的 UriHandler。

扩展不应假定结果 URI 的任何内容，也不应以任何方式更改它。相反，扩展可以例如在身份验证流程中使用此 URI，通过将该 URI 作为回调查询参数添加到服务器以进行身份验证。

注意，如果服务器决定向 URI 添加额外的查询参数（例如令牌或密钥），它们将出现在传递给 UriHandler 的 URI 中。

身份验证流程的示例

vscode.window.registerUriHandler({
  handleUri(uri: vscode.Uri): vscode.ProviderResult<void> {
    if (uri.path === '/did-authenticate') {
      console.log(uri.toString());
    }
  }
});

const callableUri = await vscode.env.asExternalUri(
  vscode.Uri.parse(vscode.env.uriScheme + '://my.extension/did-authenticate')
);
await vscode.env.openExternal(callableUri);

注意，扩展不应缓存 asExternalUri 的结果，因为解析的 URI 可能会由于系统或用户操作而失效——例如，在远程情况下，用户可能会关闭由 asExternalUri 打开的端口转发隧道。

任何其他方案

任何其他方案都将按照提供的 URI 是工作区 URI 的方式处理。在这种情况下，该方法将返回一个 URI，当处理该 URI 时，编辑器将打开工作区。

创建一个新的 遥测记录器。

使用默认应用程序外部打开链接。根据使用的方案，这可以是

• 浏览器（http:，https:）
• 邮件客户端（mailto:）
• VSCode 本身（来自 vscode.env.uriScheme 的 vscode:）

注意，showTextDocument 是在编辑器中打开文本文档的正确方法，而不是此函数。

系统当前已知的所有扩展。

当 extensions.all 更改时触发的事件。这可能发生在扩展安装、卸载、启用或禁用时。

通过其完整标识符（形式为：publisher.name）获取扩展。

为扩展加载的本地化字符串包。如果未加载任何包，则为 undefined。如果未找到包或我们正在使用默认语言运行时，则通常不加载包。

为扩展加载的本地化包的 URI。如果未加载任何包，则为 undefined。如果未找到包或我们正在使用默认语言运行时，则通常不加载包。

标记字符串以进行本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对该消息有本地化值，则将返回该本地化值（并为任何模板值注入 args 值）。

示例

l10n.t('Hello {0}!', 'World');

标记字符串以进行本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对该消息有本地化值，则将返回该本地化值（并为任何模板值注入 args 值）。

示例

l10n.t('Hello {name}', { name: 'Erich' });

标记字符串以进行本地化。如果 env.language 指定的语言有可用的本地化包，并且该包对该消息有本地化值，则将返回该本地化值（并为任何模板值注入 args 值）。

当全局诊断集更改时触发的 Event。这是新添加和移除的诊断。

创建一个诊断集合。

创建一个新的 语言状态项。

获取给定资源的所有诊断。

获取所有诊断。

返回所有已知语言的标识符。

计算文档 选择器 和文档之间的匹配度。值大于零表示选择器匹配文档。

匹配度根据以下规则计算

1. 当 DocumentSelector 是一个数组时，计算每个包含的 DocumentFilter 或语言标识符的匹配度，并取最大值。
2. 字符串将被解糖为 DocumentFilter 的 language 部分，因此 "fooLang" 就像 { language: "fooLang" }。
3. 一个 DocumentFilter 将通过将其部分与文档进行比较来与文档匹配。适用以下规则
   1. 当 DocumentFilter 为空 ({}) 时，结果为 0
   2. 当定义了 scheme、language、pattern 或 notebook 但其中一个不匹配时，结果为 0
   3. 匹配 * 的分数为 5，通过相等或 glob 模式匹配的分数为 10
   4. 结果是每个匹配的最大值

示例

// default document from disk (file-scheme)
doc.uri; //'file:///my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript' }, doc); // 10;
match({ language: 'javascript', scheme: 'file' }, doc); // 10;
match('*', doc); // 5
match('fooLang', doc); // 0
match(['fooLang', '*'], doc); // 5

// virtual document, e.g. from git-index
doc.uri; // 'git:/my/file.js'
doc.languageId; // 'javascript'
match('javascript', doc); // 10;
match({ language: 'javascript', scheme: 'git' }, doc); // 10;
match('*', doc); // 5

// notebook cell document
doc.uri; // `vscode-notebook-cell:///my/notebook.ipynb#gl65s2pmha`;
doc.languageId; // 'python'
match({ notebookType: 'jupyter-notebook' }, doc); // 10
match({ notebookType: 'fooNotebook', language: 'python' }, doc); // 0
match({ language: 'python' }, doc); // 10
match({ notebookType: '*' }, doc); // 5

注册一个调用层次结构提供程序。

注册一个代码操作提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个代码镜头提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个颜色提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个补全提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并按顺序请求相同分数的组提供补全项。当一个或多个组的提供程序返回结果时，该过程停止。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

补全项提供程序可以与一组 triggerCharacters 相关联。当键入触发字符时，会请求补全，但只从注册了键入字符的提供程序请求。因此，触发字符应不同于 单词字符，常见的触发字符是 . 以触发成员补全。

注册一个声明提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个定义提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的 DocumentDropEditProvider。

可以为一种语言注册多个拖放提供程序。当内容拖放到编辑器中时，所有注册的编辑器语言提供程序将根据其 DocumentDropEditProviderMetadata 指定的 mime 类型被调用。

每个提供程序可以返回一个或多个 DocumentDropEdit。编辑项根据 DocumentDropEdit.yieldTo 属性排序。默认情况下，将应用第一个编辑项。如果有任何附加的编辑项，它们将作为可选择的拖放选项显示在拖放小部件中。

为文档注册格式化提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册一个文档高亮提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并按顺序请求文档高亮。当提供程序返回一个 非假值 或 非失败 结果时，该过程停止。

注册一个文档链接提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个新的 DocumentPasteEditProvider。

可以为一种语言注册多个提供程序。根据 DocumentPasteProviderMetadata 指定的处理的 MIME 类型，所有为该语言注册的提供程序都将用于复制和粘贴操作。

对于 复制操作，每个提供程序对 DataTransfer 所做的更改将合并到一个 DataTransfer 中，该 DataTransfer 用于填充剪贴板。

对于 [DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作](#DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作)，每个提供程序都将被调用，并且可以返回一个或多个 DocumentPasteEdit。编辑项根据 DocumentPasteEdit.yieldTo 属性进行排序。默认情况下，将应用第一个编辑项，其余编辑项将作为可选择的粘贴选项显示在粘贴小部件中。

为文档范围注册格式化提供程序。

注意： 文档范围提供程序也是一个 文档格式化程序，这意味着在注册范围提供程序时无需 注册 文档格式化程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

为文档范围注册语义令牌提供程序。

注意：如果文档同时具有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，则范围提供程序将仅在初始阶段调用，即在完整文档提供程序解析第一个请求时。一旦完整文档提供程序解析了第一个请求，通过范围提供程序提供的语义令牌将被丢弃，并且从那时起，将仅使用文档提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

为整个文档注册语义令牌提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册一个文档符号提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个提供程序，用于在文本文档中查找可评估的表达式。编辑器将在活动的调试会话中评估表达式，并在调试悬停中显示结果。

如果为一种语言注册了多个提供程序，将使用任意一个提供程序。

注册一个折叠范围提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。如果多个折叠范围从相同位置开始，则仅使用第一个注册提供程序的范围。如果折叠范围与具有较小位置的另一个范围重叠，则也会忽略它。

失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个悬停提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个实现提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个内联提示提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个内联完成提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个提供程序，用于返回调试器“内联值”功能的数据。每当通用调试器在源文件中停止时，都会调用为该文件语言注册的提供程序，以返回将在行尾编辑器中显示的文本数据。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个链接编辑范围提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序按其分数排序，并使用最佳匹配且有结果的提供程序。所选提供程序的失败将导致整个操作的失败。

注册一个在键入时进行格式化的提供程序。当用户启用 `editor.formatOnType` 设置时，此提供程序将处于活动状态。

可以为一种语言注册多个提供程序。在这种情况下，提供程序将根据其 分数 进行排序，并使用最佳匹配的提供程序。所选提供程序的失败将导致整个操作失败。

注册一个引用提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个重命名提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序按其分数排序并按顺序询问。第一个产生结果的提供程序定义整个操作的结果。

注册一个选择范围提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个签名帮助提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序按其分数排序并按顺序调用，直到某个提供程序返回有效结果。

另请参阅 languages.registerSignatureHelpProvider

注册一个类型定义提供程序。

可以为一种语言注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

注册一个类型层次结构提供程序。

注册一个工作区符号提供程序。

可以注册多个提供程序。在这种情况下，提供程序并行请求，结果合并。失败的提供程序（拒绝的 Promise 或异常）不会导致整个操作失败。

为一种语言设置语言配置。

设置（并更改）与给定文档关联的语言。

请注意，调用此函数将触发 onDidCloseTextDocument 事件，然后触发 onDidOpenTextDocument 事件。

所有扩展通过lm.registerTool注册的所有可用工具的列表。可以使用lm.invokeTool调用它们，输入与它们声明的`inputSchema`匹配。

当可用聊天模型的集合发生变化时触发的事件。

根据给定的输入，按名称调用lm.tools中列出的工具。输入将根据工具声明的`inputSchema`进行验证

工具可以由聊天参与者在处理聊天请求的上下文中调用，也可以由任何扩展在全球范围内在任何自定义流程中调用。

在前一种情况下，调用者应传递来自聊天请求的toolInvocationToken。这确保聊天 UI 为正确的对话显示工具调用。

工具结果是文本和prompt-tsx部分组成的数组。如果工具调用者使用`vscode/prompt-tsx`，它可以使用`ToolResult`将其响应部分合并到其提示中。如果不是，可以通过带有LanguageModelToolResultPart的用户消息将这些部分传递给LanguageModelChat。

如果聊天参与者希望在多次交互中保留请求的工具结果，它可以将工具结果存储在处理程序返回的ChatResult.metadata中，并在下次交互时从ChatResponseTurn.result中检索它们。

注册一个LanguageModelChatProvider 注意：您还必须通过 package.json 中的 `languageModelChatProviders` 贡献点定义语言模型聊天提供程序。

注册一个提供程序，用于发布模型上下文协议（Model Context Protocol）服务器供编辑器使用。这允许 MCP 服务器动态地提供给编辑器，除了用户在其配置文件中创建的那些之外。

在调用此方法之前，扩展必须使用相应的id注册`contributes.mcpServerDefinitionProviders`扩展点，例如

    "contributes": {
        "mcpServerDefinitionProviders": [
            {
                "id": "cool-cloud-registry.mcp-servers",
                "label": "Cool Cloud Registry",
            }
        ]
    }

当新的 McpServerDefinitionProvider 可用时，编辑器将向用户显示“刷新”操作以发现新服务器。为了启用此流程，扩展应在激活期间调用 `registerMcpServerDefinitionProvider`。

注册一个 LanguageModelTool。该工具还必须在 package.json 的 `languageModelTools` 贡献点中注册。注册的工具可在 lm.tools 列表中供任何扩展查看。但为了让语言模型看到它，必须在 LanguageModelChatRequestOptions.tools 中将其作为可用工具列表传递。

通过选择器选择聊天模型。这可能产生多个或没有聊天模型，扩展必须优雅地处理这些情况，特别是在没有聊天模型存在时。

const models = await vscode.lm.selectChatModels({ family: 'gpt-3.5-turbo' });
if (models.length > 0) {
    const [first] = models;
    const response = await first.sendRequest(...)
    // ...
} else {
    // NO chat models available
}

选择器可以广泛匹配给定供应商或家族的所有模型，也可以通过 ID 精确选择一个模型。请记住，可用模型的集合会随时间变化，并且在不同模型中提示的性能可能会有所不同。

请注意，扩展可以保留此函数返回的结果并在以后使用它们。但是，当 onDidChangeChatModels 事件触发时，聊天模型列表可能已更改，扩展应重新查询。

创建一个新的 Notebook 控制器。

创建用于与特定渲染器通信的新消息传递实例。

• 注意 1: 扩展只能创建其在 `package.json` 文件中定义的渲染器。
• 注意 2: 只有当 `requiresMessaging` 在其 `notebookRenderer` 贡献中设置为 `always` 或 `optional` 时，渲染器才能访问消息传递。

为给定 Notebook 类型注册一个单元格状态栏项提供程序。

扩展创建的最后一个源代码控制的输入框。

• 已弃用 - 请改用 SourceControl.inputBox

创建一个新的源代码控制实例。

当前活动任务执行或空数组。

任务结束时触发。

当底层进程结束时触发。对于不执行底层进程的任务，此事件不会触发。

任务开始时触发。

当底层进程启动时触发。对于不执行底层进程的任务，此事件不会触发。

执行由编辑器管理的一个任务。返回的任务执行可用于终止该任务。

• 抛出 - 在无法启动新进程的环境中运行 ShellExecution 或 ProcessExecution 任务时。在这种环境中，只能运行 CustomExecution 任务。

获取系统中所有可用的任务。这包括来自 `tasks.json` 文件的任务以及通过扩展贡献的任务提供程序提供的任务。

注册一个任务提供程序。

创建一个新的测试控制器。

设置中配置的当前活动颜色主题。可以通过 `workbench.colorTheme` 设置更改活动主题。

当前活动的笔记本编辑器或 `undefined`。活动编辑器是指当前获得焦点的编辑器，或者在没有焦点时，最近更改输入的编辑器。

当前活动的终端或`undefined`。活动终端是指当前具有焦点或最近具有焦点的终端。

当前活动的编辑器或 `undefined`。活动编辑器是指当前获得焦点的编辑器，或者在没有焦点时，最近更改输入的编辑器。

表示当前窗口的状态。

表示主编辑器区域内的网格小部件

当前打开的终端或空数组。

当前可见的笔记本编辑器或空数组。

当前可见的编辑器或空数组。

当活动颜色主题更改或有更改时触发的事件。

当活动的 Notebook 编辑器发生变化时触发的事件。注意，当活动编辑器变为`undefined`时，此事件也会触发。

当活动的终端发生变化时触发的事件。请注意，当活动的终端变为`undefined`时，此事件也会触发。

当活动编辑器发生变化时触发的事件。请注意，当活动编辑器变为`undefined`时，此事件也会触发。

当笔记本编辑器选择发生变化时触发的事件。

当笔记本编辑器可见范围发生变化时触发的事件。

当 shell 集成在终端中激活或其属性之一发生变化时触发。

当终端状态发生变化时触发的事件。

当编辑器选项发生更改时触发的事件。

当编辑器中的选择发生更改时触发的事件。

当编辑器视图列发生更改时触发的事件。

当编辑器可见范围发生更改时触发的事件。

当可见笔记本编辑器发生变化时触发的事件。

当可见编辑器数组发生更改时触发的事件。

当当前窗口的焦点或活动状态发生变化时触发的事件。事件的值表示窗口是否处于焦点。

当终端被释放时触发的事件。

当终端命令结束时，此事件将被触发。此事件仅在终端的shell 集成被激活时才会触发。

当终端被创建时触发的事件，无论是通过 createTerminal API 还是命令。

当终端命令启动时，此事件将被触发。此事件仅在终端的shell 集成被激活时才会触发。

创建一个InputBox以让用户输入一些文本。

请注意，在许多情况下，更方便的 window.showInputBox 更易于使用。window.createInputBox 应在 window.showInputBox 无法提供所需灵活性时使用。

创建一个具有给定名称和语言 ID 的新输出通道。如果未提供语言 ID，则默认使用 Log 作为语言 ID。

您可以从可见编辑器或活动编辑器访问可见或活动的输出通道作为文本文档，并使用语言 ID 贡献语言功能，如语法着色、代码透镜等。

创建一个具有给定名称的新日志输出通道。

创建一个QuickPick，让用户从 T 类型项目列表中选择一个项目。

请注意，在许多情况下，更方便的 window.showQuickPick 更易于使用。window.createQuickPick 应在 window.showQuickPick 无法提供所需灵活性时使用。

创建一个状态栏项。

创建一个状态栏项。

另请参阅 createStatusBarItem，用于创建带标识符的状态栏项。

创建一个带有后端 shell 进程的终端。如果工作区目录存在，终端的当前工作目录将是工作区目录。

• 抛出 - 在无法启动新进程的环境中运行时。

创建一个带有后端 shell 进程的终端。

• 抛出 - 在无法启动新进程的环境中运行时。

创建一个终端，其中扩展程序控制其输入和输出。

创建一个 TextEditorDecorationType，可用于向文本编辑器添加装饰。

为使用扩展点`views`贡献的视图创建一个TreeView。

创建并显示一个新的 webview 面板。

为 `customEditors` 扩展点贡献的 `viewType` 注册自定义编辑器提供程序。

当自定义编辑器打开时，会触发 `onCustomEditor:viewType` 激活事件。您的扩展必须在激活期间为 `viewType` 注册一个 CustomTextEditorProvider、CustomReadonlyEditorProvider 或 CustomEditorProvider。

注册一个文件装饰提供程序。

注册一个提供程序，用于在终端内检测和处理链接。

注册一个贡献终端配置文件的提供程序。

为使用扩展点 `views` 贡献的视图注册一个 TreeDataProvider。这将允许您向 TreeView 贡献数据，并在数据更改时进行更新。

注意：要访问TreeView并对其执行操作，请使用createTreeView。

注册一个能够处理系统范围URI的URI 处理程序。如果有多个窗口打开，则最顶层的窗口将处理该 URI。URI 处理程序的作用域限定为其贡献的扩展；它只能处理指向该扩展本身的 URI。URI 必须遵守以下规则：

• uri-scheme 必须是 `vscode.env.uriScheme`；
• uri-authority 必须是扩展 ID（例如 `my.extension`）；
• uri-path、-query 和 -fragment 部分是任意的。

例如，如果 `my.extension` 扩展注册了一个 uri 处理程序，它将只被允许处理带有 `product-name://my.extension` 前缀的 uri。

一个扩展在其整个激活生命周期中只能注册一个 URI 处理程序。

• 注意：当定向到当前扩展的 URI 即将处理时，会触发 `onUri` 激活事件。

注册一个 webview 面板序列化程序。

支持恢复的扩展应具有 `“onWebviewPanel:viewType”` 激活事件，并确保在激活期间调用 `registerWebviewPanelSerializer`。

对于给定的 `viewType`，一次只能注册一个序列化程序。

注册一个新的 webview 视图提供程序。

向状态栏设置一条消息。这是功能更强大的状态栏项目的简写。

向状态栏设置一条消息。这是功能更强大的状态栏项目的简写。

向状态栏设置一条消息。这是功能更强大的状态栏项目的简写。

请注意，状态栏消息是堆叠的，不再使用时必须释放。

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

显示错误消息。

另请参阅 showInformationMessage

向用户显示一条信息消息。可选地提供一组项目，这些项目将作为可点击按钮呈现。

向用户显示一条信息消息。可选地提供一组项目，这些项目将作为可点击按钮呈现。

显示一条信息消息。

另请参阅 showInformationMessage

显示一条信息消息。

另请参阅 showInformationMessage

打开一个输入框，要求用户输入。

如果输入框被取消（例如按下 ESC 键），则返回值为 `undefined`。否则，返回值为用户输入的字符串，如果用户未输入任何内容但通过“确定”关闭输入框，则返回空字符串。

在笔记本编辑器中显示给定的NotebookDocument。

向用户显示一个文件打开对话框，允许选择要打开的文件。

显示一个允许进行多项选择的选择列表。

显示一个选择列表。

显示一个允许进行多项选择的选择列表。

显示一个选择列表。

向用户显示一个文件保存对话框，允许选择要保存的文件。