VS Code API

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

获取用户已登录到指定提供程序的所有账户。将此与 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。只要有活动的调试会话，就可以聚焦线程；而只有当会话暂停并检索到调用堆栈时，才能聚焦堆栈帧。

断点列表。

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

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

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

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

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

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

添加断点。

将通过调试适配器协议接收到的“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}'）会相对于给定文件夹进行解析。

停止给定的调试会话，如果省略 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 的环境中，该值为一个空字符串。

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

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

当编辑器的日志级别改变时触发的事件。

当默认 shell 改变时触发的事件。触发时会带上新的 shell 路径。

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

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

http: 或 https: 方案

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

如果扩展在客户端机器上运行，此操作无效。

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

注意：通过 openExternal 打开的 URI 会自动解析，你不应在它们上调用 asExternalUri。

vscode.env.uriScheme

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

扩展不应对生成的 URI 作出任何假设，也不应以任何方式更改它。相反，扩展可以例如在身份验证流程中使用此 URI，将其作为回调查询参数添加到要进行身份验证的服务器。

注意：如果服务器决定向 URI 添加额外的查询参数（例如，token 或 secret），它们将出现在传递给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 值以替换任何模板值）。

当诊断的全局集合改变时触发的事件。这包括新添加和删除的诊断。

创建一个诊断集合。

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

获取给定资源的全部诊断信息。

获取全部诊断信息。

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

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

匹配程度按照以下规则计算：

1. 当DocumentSelector是一个数组时，计算其中包含的每个 DocumentFilter 或语言标识符的匹配度，并取最大值。
2. 字符串将被解糖（desugared）为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 或异常）不会导致整个操作失败。

注册一个 Code Lens 提供者。

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

注册一个颜色提供者。

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

注册一个完成项提供者。

可以为一种语言注册多个提供者。在这种情况下，提供者按其分数排序，并且分数相等的提供者组会按顺序被要求提供完成项。当某个组中的一个或多个提供者返回结果时，该过程停止。失败的提供者（拒绝的 Promise 或异常）不会导致整个操作失败。

完成项提供者可以关联一组 triggerCharacters。当用户键入触发字符时，会请求完成，但仅从注册了该触发字符的提供者处请求。因此，触发字符应与词语字符不同，常见的触发字符是 . 用于触发成员完成。

注册一个声明提供程序。

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

注册一个定义提供程序。

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

注册新的 DocumentDropEditProvider。

一种语言可以注册多个放置提供程序。当内容被放置到编辑器中时，编辑器语言的所有已注册提供程序将根据它们处理的 MIME 类型（由其 DocumentDropEditProviderMetadata 指定）被调用。

每个提供程序可以返回一个或多个 DocumentDropEdits。这些编辑会使用 DocumentDropEdit.yieldTo 属性进行排序。默认情况下，第一个编辑将被应用。如果存在其他编辑，这些编辑将在放置小部件中作为可选择的放置选项显示给用户。

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

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

注册文档高亮提供程序。

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

注册文档链接提供程序。

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

注册新的 DocumentPasteEditProvider。

一种语言可以注册多个提供程序。该语言的所有已注册提供程序将根据其处理的 MIME 类型（由 DocumentPasteProviderMetadata 指定）在复制和粘贴操作时被调用。

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

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

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

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

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

注册文档范围的语义标记提供程序。

注意：如果文档同时具有 DocumentSemanticTokensProvider 和 DocumentRangeSemanticTokensProvider，则范围提供程序仅在最初调用，直到完整文档提供程序解析第一个请求。一旦完整文档提供程序解析了第一个请求，通过范围提供程序提供的语义标记将被丢弃，从那时起，将只使用文档提供程序。

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

注册整个文档的语义标记提供程序。

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

注册文档符号提供程序。

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

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

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

注册折叠范围提供程序。

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

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

注册悬停提供程序。

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

注册实现提供程序。

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

注册内嵌提示提供程序。

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

注册内联补全提供程序。

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

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

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

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

一种语言可以注册多个提供程序。在这种情况下，提供程序按其 score 排序，并按顺序查询。使用第一个产生结果的最佳匹配提供程序。

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

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

注册引用提供程序。

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

注册重命名提供程序。

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

注册选择范围提供程序。

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

注册签名帮助提供程序。

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

另请参阅 languages.registerSignatureHelpProvider

注册类型定义提供程序。

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

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

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

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

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

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

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

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

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

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

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

在前一种情况下，调用者应传递 toolInvocationToken，它随 chat request 提供。这确保聊天 UI 为正确的对话显示工具调用。

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

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

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

通过 selector 选择聊天模型。这可能返回多个或零个聊天模型，扩展必须优雅地处理这些情况，特别是当不存在聊天模型时。

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 的模型。请记住，可用模型集合会随时间变化，而且在不同模型中，prompt 的表现也可能不同。

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

创建一个新的 Notebook 控制器。

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

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

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

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

• 已弃用 - 请改用 SourceControl.inputBox

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

当前处于活动状态的任务执行或一个空数组。

当任务结束时触发。

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

当任务开始时触发。

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

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

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

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

注册一个任务提供程序。

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

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

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

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

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

表示当前窗口的状态。

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

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

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

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

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

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

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

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

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

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

当终端中激活 shell 集成或其某个属性发生更改时触发。

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

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

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

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

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

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

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

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

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

当终端命令结束时触发。此事件仅在终端激活了 shell 集成 时触发。

通过 createTerminal API 或命令创建终端时触发的 事件。

当终端命令启动时触发。此事件仅在终端激活了 shell 集成 时触发。

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

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

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

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

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

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

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

创建一个状态栏 项。

创建一个状态栏 项。

另请参阅 createStatusBarItem 以创建带有标识符的状态栏项。

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

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

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

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

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

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

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

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

注册一个自定义编辑器提供程序，用于通过 customEditors 扩展点贡献的 viewType。

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

注册文件装饰提供程序。

注册用于在终端中检测和处理链接的提供程序。

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

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

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

注册一个能够处理系统范围 uris 的 uri handler。如果打开了多个窗口，最顶部的窗口将处理该 uri。uri handler 的范围限定在其贡献的扩展程序内；它只能处理定向到其自身扩展程序的 uri。uri 必须遵守以下规则：

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

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

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

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

注册 webview panel 序列化程序。

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

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

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

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

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

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

注意状态栏消息是堆叠的，并且在使用完毕后必须释放。

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

显示一条错误消息。

另请参阅 showInformationMessage

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

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

显示一条信息消息。

另请参阅 showInformationMessage

显示一条信息消息。

另请参阅 showInformationMessage

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

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

在 notebook editor 中显示给定的 NotebookDocument。

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

显示允许多选的选择列表。

显示一个选择列表。

显示允许多选的选择列表。

显示一个选择列表。

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

在文本编辑器中显示给定的文档。可以提供一个 列 来控制编辑器的显示位置。可能会更改 活动的编辑器。

在文本编辑器中显示给定的文档。可以提供 选项 来控制编辑器显示的选项。可能会更改 活动的编辑器。