VS Code API

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

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

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

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

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

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

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

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

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

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

注册身份验证提供程序。

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

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

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

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

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

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

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

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

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

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

当前活动的 调试控制台。如果没有任何调试会话处于活动状态，则发送到调试控制台的输出不会显示。

当前活动的 调试会话 或 undefined。活动调试会话是由调试操作浮动窗口表示的会话，或当前显示在调试操作浮动窗口下拉菜单中的会话。如果没有任何调试会话处于活动状态，则值为 undefined。

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

断点列表。

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

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

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

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

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

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

添加断点。

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

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

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

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

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

移除断点。

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

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

应用程序的托管位置。在桌面上，这是 '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 的环境中，该值为空字符串。

uiKind 属性指示从哪个 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 属性排序。默认情况下，将应用第一个编辑。如果有任何其他编辑，这些编辑将在拖放小部件中作为可选择的拖放选项向用户显示。

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

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

注册文档高亮显示提供程序。

可以为一个语言注册多个提供程序。在这种情况下，提供程序按其 分数 排序，并按顺序询问文档高亮显示组。当提供程序返回 non-falsy 或 non-failure 结果时，该过程停止。

注册文档链接提供程序。

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

注册一个新的 DocumentPasteEditProvider。

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

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

对于 [DocumentPasteEditProvider.providerDocumentPasteEdits 粘贴操作](#DocumentPasteEditProvider.providerDocumentPasteEdits paste operations)，将调用每个提供程序，并且可以返回一个或多个 DocumentPasteEdits。编辑将使用 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 中列出的工具。输入将根据工具声明的模式进行验证

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

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

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

如果聊天参与者想要为跨多个回合的请求保留工具结果，则可以将工具结果存储在从处理程序返回的 ChatResult.metadata 中，并在下一个回合中从 ChatResponseTurn.result 中检索它们。

注册 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-事件触发时，聊天模型列表可能已更改，扩展应重新查询。

创建一个新的笔记本控制器。

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

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

为给定的笔记本类型注册 单元格状态栏项目提供程序。

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

• 已弃用 - 请改用 SourceControl.inputBox

创建一个新的 源代码管理 实例。

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

任务结束时触发。

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

任务开始时触发。

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

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

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

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

注册一个任务提供程序。

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

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

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

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

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

表示当前窗口的状态。

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

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

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

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

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

当 活动笔记本编辑器 更改时触发的 事件。注意，当活动编辑器更改为 undefined 时，该事件也会触发。

当 活动终端 更改时触发的 事件。注意，当活动终端更改为 undefined 时，该事件也会触发。

当 活动编辑器 更改时触发的 事件。注意，当活动编辑器更改为 undefined 时，该事件也会触发。

当 笔记本编辑器选择 更改时触发的 事件。

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

当终端中的 Shell 集成激活或其属性之一发生更改时触发。

当 终端状态 更改时触发的 事件。

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

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

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

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

当 可见笔记本编辑器 更改时触发的 事件。

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

当当前窗口的焦点或活动状态更改时触发的 事件。事件的值表示窗口是否具有焦点。

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

当终端命令结束时，将触发此事件。仅当为终端激活 Shell 集成 时，此事件才会触发。

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

当终端命令启动时，将触发此事件。仅当为终端激活 Shell 集成 时，此事件才会触发。

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

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

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

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

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

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

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

创建一个状态栏 项目。

创建一个状态栏 项目。

另请参阅 createStatusBarItem，了解如何创建带有标识符的状态栏项目。

创建一个带有后备 Shell 进程的 Terminal。如果工作区目录存在，则终端的 cwd 将是工作区目录。

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

创建一个带有后备 Shell 进程的 Terminal。

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

创建一个 Terminal，其中扩展控制其输入和输出。

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

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

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

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

当自定义编辑器打开时，将触发 onCustomEditor:viewType 激活事件。你的扩展必须注册 CustomTextEditorProvider、CustomReadonlyEditorProvider、CustomEditorProvider 作为激活的一部分用于 viewType。

注册文件装饰提供程序。

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

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

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

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

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

• uri 方案必须是 vscode.env.uriScheme；
• uri 授权机构必须是扩展 ID（例如 my.extension）；
• uri 路径、查询和片段部分是任意的。

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

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

• 注意： 存在一个激活事件 onUri，当定向到当前扩展的 uri 即将被处理时触发。

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

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

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

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

在状态栏中设置一条消息。这是更强大的状态栏 items 的简写形式。

在状态栏中设置一条消息。这是更强大的状态栏 items 的简写形式。

在状态栏中设置一条消息。这是更强大的状态栏 items 的简写形式。

注意 状态栏消息会堆叠，并且在不再使用时必须释放它们。

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

向用户显示一条信息消息。可以选择性地提供一个项目数组，这些项目将呈现为可单击的按钮。

向用户显示一条信息消息。可以选择性地提供一个项目数组，这些项目将呈现为可单击的按钮。

显示一条信息消息。

另请参阅 showInformationMessage

显示一条信息消息。

另请参阅 showInformationMessage

打开一个输入框，以向用户请求输入。

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

在 notebook editor 中显示给定的 NotebookDocument。

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

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

显示一个选择列表。

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

显示一个选择列表。

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

在文本编辑器中显示给定的文档。可以提供 column 来控制编辑器的显示位置。可能会更改 active editor。