现已发布!阅读关于 11 月份的新功能和修复。

VS Code API

VS Code API 是一组 JavaScript API,你可以在 Visual Studio Code 扩展中调用。此页面列出了扩展作者可用的所有 VS Code API。

API 命名空间和类

此列表是从 VS Code 仓库中的 vscode.d.ts 文件编译的。

身份验证

身份验证的命名空间。

事件

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

函数

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

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

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

参数描述
providerId: string

要使用的提供程序的 ID

返回描述
Thenable<readonly AuthenticationSessionAccountInformation[]>

一个 thenable,它解析为身份验证帐户的只读数组。

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

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

参数描述
providerId: string

要使用的提供程序的 ID

scopes: readonly string[]

表示请求的权限的范围列表。这些取决于身份验证提供程序

options: AuthenticationGetSessionOptions & {createIfNone: true}
返回描述
Thenable<AuthenticationSession>

一个 thenable,它解析为身份验证会话

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

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

参数描述
providerId: string

要使用的提供程序的 ID

scopes: readonly string[]

表示请求的权限的范围列表。这些取决于身份验证提供程序

options: AuthenticationGetSessionOptions & {forceNewSession: true | AuthenticationForceNewSessionOptions}
返回描述
Thenable<AuthenticationSession>

一个 thenable,它解析为身份验证会话

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

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

参数描述
providerId: string

要使用的提供程序的 ID

scopes: readonly string[]

表示请求的权限的范围列表。这些取决于身份验证提供程序

options?: AuthenticationGetSessionOptions
返回描述
Thenable<AuthenticationSession | undefined>

一个 thenable,如果可用则解析为身份验证会话,如果不存在会话则解析为 undefined

注册身份验证提供程序。

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

参数描述
id: string

提供程序的唯一标识符。

label: string

提供程序的人工可读名称。

provider: AuthenticationProvider

身份验证提供程序。

options?: AuthenticationProviderOptions

提供程序的其他选项。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

聊天

用于处理聊天功能的命名空间。用户通过在聊天视图中向聊天参与者发送消息来与他们互动。聊天参与者可以通过 ChatResponseStream 返回 markdown 或其他类型的内容。

函数

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

参数描述
id: string

参与者的唯一标识符。

handler: ChatRequestHandler

参与者的请求处理程序。

返回描述
ChatParticipant

一个新的聊天参与者

命令

用于处理命令的命名空间。简而言之,命令是具有唯一标识符的函数。该函数有时也称为命令处理程序

可以使用 registerCommandregisterTextEditorCommand 函数将命令添加到编辑器。可以 手动或从 UI 手势执行命令。这些是

  • 面板 - 使用 package.json 中的 commands 部分使命令显示在命令面板中。
  • 键绑定 - 使用 package.json 中的 keybindings 部分为你的扩展启用键绑定

其他扩展和编辑器本身的命令对于扩展是可访问的。但是,在调用编辑器命令时,并非所有参数类型都受支持。

这是一个示例,它注册了一个命令处理程序,并将该命令的条目添加到面板中。首先,使用标识符 extension.sayHello 注册一个命令处理程序。

commands.registerCommand('extension.sayHello', () => {
  window.showInformationMessage('Hello World!');
});

其次,将命令标识符绑定到一个标题,该标题将在面板中显示(package.json)。

{
  "contributes": {
    "commands": [
      {
        "command": "extension.sayHello",
        "title": "Hello World"
      }
    ]
  }
}

函数

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

  • 注意 1: 执行编辑器命令时,并非所有类型都可以作为参数传递。允许的类型包括基本类型 stringbooleannumberundefinednull,以及 PositionRangeUriLocation
  • 注意 2: 执行由扩展贡献的命令时,没有限制。
参数描述
command: string

要执行的命令的标识符。

...rest: any[]

传递给命令函数的参数。

返回描述
Thenable<T>

一个 thenable,它解析为给定命令的返回值。当命令处理函数不返回任何内容时,返回 undefined

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

参数描述
filterInternal?: boolean

设置为 true 以不显示内部命令(以下划线开头)。

返回描述
Thenable<string[]>

一个 thenable,它解析为命令 ID 的列表。

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

使用现有命令标识符注册命令两次将导致错误。

参数描述
command: string

命令的唯一标识符。

callback: (args: any[]) => any

命令处理函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
Disposable

可释放对象,在释放时注销此命令。

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

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

参数描述
command: string

命令的唯一标识符。

callback: (textEditor: TextEditor, edit: TextEditorEdit, args: any[]) => void

一个可以访问 editoredit 的命令处理函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
Disposable

可释放对象,在释放时注销此命令。

注释

函数

创建一个新的 注释控制器 实例。

参数描述
id: string

注释控制器的 id

label: string

注释控制器的用户可读字符串。

返回描述
CommentController

注释控制器 的实例。

调试

调试功能的命名空间。

变量

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

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

当前聚焦的线程或堆栈帧,如果没有聚焦线程或堆栈,则为 undefined。当存在活动调试会话时,可以随时聚焦线程,而仅当会话暂停并检索了调用堆栈时,才可以聚焦堆栈帧。

断点列表。

事件

一个 Event,当 活动调试会话 发生更改时触发。请注意,当活动调试会话更改为 undefined 时,也会触发该事件。

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

一个 Event,当添加、删除或更改断点集时发出。

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

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

一个 Event,当 调试会话 终止时触发。

函数

添加断点。

参数描述
breakpoints: readonly Breakpoint[]

要添加的断点。

返回描述
void

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

如果“Source”描述符的信息不足以创建 Uri,则会引发错误。

参数描述
source: DebugProtocolSource

一个符合调试适配器协议中定义的 Source 类型的对象。

session?: DebugSession

一个可选的调试会话,当源描述符使用引用编号从活动调试会话加载内容时将使用该会话。

返回描述
Uri

一个可用于加载源内容的 URI。

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

参数描述
debugType: string

注册工厂的调试类型。

factory: DebugAdapterDescriptorFactory
返回描述
Disposable

一个Disposable,当被释放时会取消注册该工厂。

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

参数描述
debugType: string

注册工厂的调试类型,或者使用 '*' 来匹配所有调试类型。

factory: DebugAdapterTrackerFactory
返回描述
Disposable

一个Disposable,当被释放时会取消注册该工厂。

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

参数描述
debugType: string

注册提供程序的调试类型。

provider: DebugConfigurationProvider

要注册的调试配置提供程序

triggerKind?: DebugConfigurationProviderTriggerKind

为之注册提供程序的 'provideDebugConfiguration' 方法的触发器。如果缺少 triggerKind,则假定值为 DebugConfigurationProviderTriggerKind.Initial

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

移除断点。

参数描述
breakpoints: readonly Breakpoint[]

要移除的断点。

返回描述
void

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

参数描述
folder: WorkspaceFolder

用于查找命名配置和解析变量的 工作区文件夹,或者对于非文件夹设置,则为 undefined

nameOrConfiguration: string | DebugConfiguration

调试或复合配置的名称,或者一个 DebugConfiguration 对象。

parentSessionOrOptions?: DebugSession | DebugSessionOptions

调试会话选项。当传递父 调试会话时,假定选项仅包含此父会话。

返回描述
Thenable<boolean>

一个可等待对象,当调试可以成功启动时解析。

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

参数描述
session?: DebugSession

要停止的调试会话;如果省略,则停止所有会话。

返回描述
Thenable<void>

一个可等待对象,当会话已停止时解析。

环境

描述编辑器运行环境的命名空间。

变量

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

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

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

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

系统剪贴板。

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

指示用户是否已启用遥测。可以观察它以确定扩展程序是否应该发送遥测数据。

表示首选用户语言,例如 de-CHfren-US

编辑器的当前日志级别。

计算机的唯一标识符。

远程的名称。由扩展程序定义,常见的示例是 Windows 子系统 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,如果该 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 时,将使编辑器打开工作区。

参数描述
target: Uri
返回描述
Thenable<Uri>

可以在客户端计算机上使用的 URI。

创建一个新的 遥测记录器

参数描述
sender: TelemetrySender

遥测记录器使用的遥测发送器。

options?: TelemetryLoggerOptions

遥测记录器的选项。

返回描述
TelemetryLogger

一个新的遥测记录器

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

  • 浏览器 (http:, https:)
  • 邮件客户端 (mailto:)
  • VSCode 本身 (来自 vscode.env.uriSchemevscode:)

请注意showTextDocument 是在编辑器内部打开文本文件的正确方法,而不是此函数。

参数描述
target: Uri

应该打开的 URI。

返回描述
Thenable<boolean>

一个指示打开是否成功的 Promise。

扩展

用于处理已安装扩展的命名空间。扩展程序由 Extension 接口表示,该接口可以对其进行反射。

扩展程序编写者可以通过从 activate 调用返回其 API 公开表面来向其他扩展程序提供 API。

export function activate(context: vscode.ExtensionContext) {
  let api = {
    sum(a, b) {
      return a + b;
    },
    mul(a, b) {
      return a * b;
    }
  };
  // 'export' public api-surface
  return api;
}

当依赖另一个扩展程序的 API 时,请将 extensionDependencies 条目添加到 package.json,并使用 getExtension 函数和 exports 属性,如下所示

let mathExt = extensions.getExtension('genius.math');
let importedApi = mathExt.exports;

console.log(importedApi.mul(42, 1));

变量

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

事件

extensions.all 更改时触发的事件。当扩展程序安装、卸载、启用或禁用时,可能会发生这种情况。

函数

通过其完整标识符(形式为:publisher.name)获取扩展程序。

参数描述
extensionId: string

扩展程序标识符。

返回描述
Extension<T> | undefined

扩展程序或 undefined

本地化

扩展 API 中用于本地化相关功能的命名空间。要正确使用此功能,您必须在扩展清单中定义 l10n 并具有 bundle.l10n。.json 文件。有关如何生成 bundle.l10n 的更多信息。.json 文件,请查看 vscode-l10n 存储库

注意:内置扩展程序(例如,Git、TypeScript 语言功能、GitHub 身份验证)不包括在 l10n 属性要求中。换句话说,它们不需要在扩展清单中指定 l10n,因为它们的翻译字符串来自语言包。

变量

已为扩展加载的本地化字符串捆绑包。如果没有加载捆绑包,则为 undefined。如果未找到捆绑包或当使用默认语言运行时,通常不加载捆绑包。

已为扩展加载的本地化捆绑包的 URI。如果没有加载捆绑包,则为 undefined。如果未找到捆绑包或当使用默认语言运行时,通常不加载捆绑包。

函数

标记要本地化的字符串。如果 env.language 指定的语言有可用的本地化捆绑包,并且该捆绑包为此消息具有本地化值,则将返回该本地化值(对于任何模板值,都注入了 args 值)。

示例

l10n.t('Hello {0}!', 'World');
参数描述
message: string

要本地化的消息。支持索引模板,其中像 {0}{1} 这样的字符串将替换为 args 数组中该索引处的项。

...args: Array<string | number | boolean>

要在本地化字符串中使用的参数。参数的索引用于匹配本地化字符串中的模板占位符。

返回描述
string

带有注入参数的本地化字符串。

标记要本地化的字符串。如果 env.language 指定的语言有可用的本地化捆绑包,并且该捆绑包为此消息具有本地化值,则将返回该本地化值(对于任何模板值,都注入了 args 值)。

示例

l10n.t('Hello {name}', { name: 'Erich' });
参数描述
message: string

要本地化的消息。支持命名模板,其中像 {foo}{bar} 这样的字符串将替换为该键(foo、bar 等)的 Record 中的值。

args: Record<string, any>

要在本地化字符串中使用的参数。记录中键的名称用于匹配本地化字符串中的模板占位符。

返回描述
string

带有注入参数的本地化字符串。

标记要本地化的字符串。如果 env.language 指定的语言有可用的本地化捆绑包,并且该捆绑包为此消息具有本地化值,则将返回该本地化值(对于任何模板值,都注入了 args 值)。

参数描述
options: {args: Array<string | number | boolean> | Record<string, any>, comment: string | string[], message: string}

本地化消息时要使用的选项。

返回描述
string

带有注入参数的本地化字符串。

语言

用于参与特定语言编辑器功能(如 IntelliSense、代码操作、诊断等)的命名空间。

存在许多编程语言,并且在语法、语义和范例方面存在巨大差异。尽管如此,自动单词补全、代码导航或代码检查等功能已在不同编程语言的不同工具中变得流行。

编辑器提供了一个 API,通过使所有 UI 和操作都已就位,并允许您仅通过提供数据来参与,从而可以轻松提供此类常见功能。例如,要贡献悬停,您只需提供一个可以使用 TextDocumentPosition 调用的函数,该函数返回悬停信息。其余部分(例如跟踪鼠标、定位悬停、保持悬停稳定等)由编辑器处理。

languages.registerHoverProvider('javascript', {
  provideHover(document, position, token) {
    return new Hover('I am a hover!');
  }
});

注册使用文档选择器完成,文档选择器可以是诸如 javascript 的语言 ID,也可以是更复杂的过滤器,例如 { language: 'typescript', scheme: 'file' }。将文档与此类选择器进行匹配会产生一个分数,该分数用于确定是否以及如何使用提供程序。当分数相等时,最后一个出现的提供程序胜出。对于允许完全元数的功能,例如悬停,仅检查分数是否 >0。对于其他功能,例如IntelliSense,该分数用于确定请求提供程序参与的顺序。

事件

当全局诊断集发生更改时触发的事件。这包括新添加的和移除的诊断。

函数

创建一个诊断集合。

参数描述
name?: string

集合的名称

返回描述
DiagnosticCollection

一个新的诊断集合。

创建一个新的语言状态项

参数描述
id: string

项的标识符。

selector: DocumentSelector

定义该项在哪些编辑器中显示的文档选择器。

返回描述
LanguageStatusItem

一个新的语言状态项。

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

参数描述
resource: Uri

一个资源

返回描述
Diagnostic[]

诊断对象数组或空数组。

获取所有诊断。

参数描述
返回描述
Array<[Uri, Diagnostic[]]>

uri-诊断元组数组或空数组。

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

参数描述
返回描述
Thenable<string[]>

解析为标识符字符串数组的 Promise。

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

根据以下规则计算匹配度:

  1. DocumentSelector是一个数组时,计算每个包含的 DocumentFilter 或语言标识符的匹配度,并取最大值。
  2. 字符串将被解糖为DocumentFilterlanguage 部分,因此 "fooLang" 类似于 { language: "fooLang" }
  3. 通过将其各个部分与文档进行比较,将DocumentFilter与文档进行匹配。适用以下规则:
    1. DocumentFilter 为空时({}),结果为 0
    2. 当定义了 schemelanguagepatternnotebook 但其中一个不匹配时,结果为 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
参数描述
selector: DocumentSelector

文档选择器。

document: TextDocument

文本文档。

返回描述
number

当选择器匹配时,数字 >0;当选择器不匹配时,数字为 0

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: CallHierarchyProvider

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

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: CodeActionProvider<CodeAction>

一个代码操作提供程序。

metadata?: CodeActionProviderMetadata

有关提供程序提供的代码操作类型的信息。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: CodeLensProvider<CodeLens>

一个代码镜头提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个颜色提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentColorProvider

一个颜色提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个完成提供程序。

可以为一种语言注册多个提供程序。在这种情况下,提供程序会按照他们的分数进行排序,并且会按顺序请求完成项。当一组提供程序中的一个或多个返回结果时,该过程停止。失败的提供程序(被拒绝的 Promise 或异常)不会导致整个操作失败。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: CompletionItemProvider<CompletionItem>

一个完成提供程序。

...triggerCharacters: string[]

当用户输入其中一个字符时触发完成。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个声明提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DeclarationProvider

一个声明提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个定义提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DefinitionProvider

一个定义提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个新的 DocumentDropEditProvider

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用的文档。

provider: DocumentDropEditProvider

一个拖放提供程序。

返回描述
Disposable

一个 Disposable,当被释放时取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentFormattingEditProvider

一个文档格式化编辑提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

可以为一种语言注册多个提供程序。在这种情况下,提供程序按其 得分 排序,并按顺序要求提供文档高亮。当提供程序返回 非假非失败 结果时,该过程停止。

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentHighlightProvider

一个文档高亮提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentLinkProvider<DocumentLink>

一个文档链接提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentRangeFormattingEditProvider

一个文档范围格式化编辑提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

为文档范围注册一个语义标记提供程序。

注意:如果文档同时具有 DocumentSemanticTokensProviderDocumentRangeSemanticTokensProvider,则仅在初始时调用范围提供程序,即在完整文档提供程序解析第一个请求的时间内。一旦完整文档提供程序解析了第一个请求,通过范围提供程序提供的语义标记将被丢弃,并且从那时起,将仅使用文档提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentRangeSemanticTokensProvider

一个文档范围语义标记提供程序。

legend: SemanticTokensLegend
返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentSemanticTokensProvider

一个文档语义标记提供程序。

legend: SemanticTokensLegend
返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: DocumentSymbolProvider

一个文档符号提供程序。

metaData?: DocumentSymbolProviderMetadata

关于提供程序的元数据

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: EvaluatableExpressionProvider

一个可求值表达式提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: FoldingRangeProvider

一个折叠范围提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个悬停提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: HoverProvider

一个悬停提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个实现提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: ImplementationProvider

一个实现提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: InlayHintsProvider<InlayHint>

一个内嵌提示提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个内联补全提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: InlineCompletionItemProvider

一个内联补全提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: InlineValuesProvider

一个内联值提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: LinkedEditingRangeProvider

一个链接编辑范围提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: OnTypeFormattingEditProvider

一个在输入时格式化编辑提供器。

firstTriggerCharacter: string

一个应该触发格式化的字符,例如 }

...moreTriggerCharacter: string[]

更多触发字符。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个引用提供器。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: ReferenceProvider

一个引用提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个重命名提供器。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: RenameProvider

一个重命名提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个选择范围提供器。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: SelectionRangeProvider

一个选择范围提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个签名帮助提供器。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: SignatureHelpProvider

一个签名帮助提供器。

...triggerCharacters: string[]

当用户键入一个字符(如 ,()时触发签名帮助。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: SignatureHelpProvider

一个签名帮助提供器。

metadata: SignatureHelpProviderMetadata

有关提供程序的信息。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个类型定义提供器。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: TypeDefinitionProvider

一个类型定义提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

参数描述
selector: DocumentSelector

一个选择器,定义此提供程序适用于哪些文档。

provider: TypeHierarchyProvider

一个类型层次结构提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

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

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

参数描述
provider: WorkspaceSymbolProvider<SymbolInformation>

一个工作区符号提供器。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

为一种语言设置语言配置

参数描述
language: string

一个语言标识符,如 typescript

configuration: LanguageConfiguration

语言配置。

返回描述
Disposable

一个 Disposable,用于取消设置此配置。

设置(和更改)与给定文档关联的语言

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

参数描述
document: TextDocument

要更改语言的文档。

languageId: string

新的语言标识符。

返回描述
Thenable<TextDocument>

一个可解析为更新文档的 Thenable。

语言模型

用于语言模型相关功能的命名空间。

变量

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

事件

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

函数

通过名称调用 lm.tools 中列出的工具,并提供给定的输入。输入将根据工具声明的模式进行验证。

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

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

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

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

参数描述
name: string

要调用的工具的名称。

options: LanguageModelToolInvocationOptions<object>

调用工具时要使用的选项。

token?: CancellationToken

一个取消令牌。有关如何创建取消令牌,请参阅 CancellationTokenSource

返回描述
Thenable<LanguageModelToolResult>

工具调用的结果。

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

参数描述
name: string
tool: LanguageModelTool<T>
返回描述
Disposable

一个 Disposable 对象,在释放时取消注册该工具。

通过 选择器 选择聊天模型。这可能会产生多个或零个聊天模型,扩展必须优雅地处理这些情况,尤其是在不存在聊天模型时。

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

参数描述
selector?: LanguageModelChatSelector

聊天模型选择器。如果省略,则返回所有聊天模型。

返回描述
Thenable<LanguageModelChat[]>

聊天模型数组,可以为空!

笔记本

笔记本的命名空间。

笔记本功能由三个松散耦合的组件组成

  1. NotebookSerializer 使编辑器能够打开、显示和保存笔记本
  2. NotebookController 拥有笔记本的执行权,例如,它们从代码单元格创建输出。
  3. NotebookRenderer 在编辑器中呈现笔记本输出。它们在单独的上下文中运行。

函数

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

参数描述
id: string

控制器的标识符。每个扩展必须是唯一的。

notebookType: string

此控制器适用的笔记本类型。

label: string

控制器的标签。

handler?: (cells: NotebookCell[], notebook: NotebookDocument, controller: NotebookController) => void | Thenable<void>

控制器的执行处理程序。

返回描述
NotebookController

一个新的笔记本控制器。

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

  • 注意 1: 扩展只能创建在它们的 package.json 文件中定义的渲染器
  • 注意 2: 如果其 notebookRenderer 贡献中的 requiresMessaging 设置为 alwaysoptional,则渲染器只能访问消息传递。
参数描述
rendererId: string

要与之通信的渲染器 ID

返回描述
NotebookRendererMessaging

一个新的笔记本渲染器消息传递对象。

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

参数描述
notebookType: string

要注册的笔记本类型。

provider: NotebookCellStatusBarItemProvider

单元格状态栏提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

源代码管理

用于源代码控制管理的命名空间。

变量

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

  • 已弃用 - 请改用 SourceControl.inputBox

函数

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

参数描述
id: string

源代码控制的 id。简短的内容,例如:git

label: string

源代码控制的人类可读字符串。例如:Git

rootUri?: Uri

源代码控制根目录的可选 Uri。例如:Uri.parse(workspaceRoot)

返回描述
SourceControl

源代码控制的实例。

任务

用于任务功能的命名空间。

变量

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

事件

在任务结束时触发。

当基础进程结束时触发。对于不执行基础进程的任务,此事件不会触发。

在任务开始时触发。

当基础进程已启动时触发。对于不执行基础进程的任务,此事件不会触发。

函数

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

  • 抛出 - 当在无法启动新进程的环境中运行 ShellExecution 或 ProcessExecution 任务时。在这种环境中,只能运行 CustomExecution 任务。
参数描述
task: Task

要执行的任务

返回描述
Thenable<TaskExecution>

一个 thenable 对象,它解析为任务执行。

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

参数描述
filter?: TaskFilter

可选的过滤器,用于选择特定类型或版本的任务。

返回描述
Thenable<Task[]>

一个 thenable 对象,它解析为一个任务数组。

注册一个任务提供程序。

参数描述
type: string

此提供程序注册的任务类型。

provider: TaskProvider<Task>

一个任务提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

测试

用于测试功能的命名空间。通过注册 TestController 实例,然后添加 TestItems 来发布测试。控制器还可以通过创建一个或多个 TestRunProfile 实例来描述如何运行测试。

函数

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

参数描述
id: string

控制器的标识符,必须是全局唯一的。

label: string

控制器的人类可读标签。

返回描述
TestController

TestController 的一个实例。

窗口

用于处理编辑器当前窗口的命名空间。即可见和活动的编辑器,以及显示消息、选择和请求用户输入的 UI 元素。

变量

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

当前活动的 笔记本编辑器,如果不存在则为 undefined。活动编辑器是当前具有焦点的编辑器,或者在没有焦点时,是最近更改输入的编辑器。

当前活动的终端,如果不存在则为 undefined。活动终端是当前具有焦点的终端,或者最近具有焦点的终端。

当前活动的编辑器,如果不存在则为 undefined。活动编辑器是当前具有焦点的编辑器,或者在没有焦点时,是最近更改输入的编辑器。

表示当前窗口的状态。

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

当前打开的终端,如果没有则为空数组。

当前可见的 笔记本编辑器,如果没有则为空数组。

当前可见的编辑器,如果没有则为空数组。

事件

当活动颜色主题更改或发生变化时触发的 Event

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

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

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

笔记本编辑器选择 更改时触发的 Event

笔记本编辑器可见范围 更改时触发的 Event

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

终端状态 更改时触发的 Event

当编辑器的选项更改时触发的 Event

当编辑器中的选择更改时触发的 Event

当编辑器的视图列更改时触发的 Event

当编辑器的可见范围更改时触发的 Event

可见笔记本编辑器 更改时触发的 Event

可见编辑器 的数组更改时触发的 Event

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

当终端被释放时触发的 Event

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

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

当终端命令开始时,将触发此事件。此事件仅在终端激活 shell 集成时触发。

函数

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

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

参数描述
返回描述
InputBox

一个新的 InputBox

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

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

参数描述
name: string

人类可读的字符串,将在 UI 中用于表示通道。

languageId?: string

与通道关联的语言标识符。

返回描述
OutputChannel

一个新的输出通道。

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

参数描述
name: string

人类可读的字符串,将在 UI 中用于表示通道。

options: {log: true}

日志输出通道的选项。

返回描述
LogOutputChannel

一个新的日志输出通道。

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

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

参数描述
返回描述
QuickPick<T>

一个新的 QuickPick

创建一个状态栏 项目

参数描述
id: string

项目的标识符。在扩展中必须是唯一的。

alignment?: StatusBarAlignment

项目的对齐方式。

priority?: number

项目的优先级。较高的值表示该项目应更靠左显示。

返回描述
StatusBarItem

一个新的状态栏项目。

创建一个状态栏 项目

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

参数描述
alignment?: StatusBarAlignment

项目的对齐方式。

priority?: number

项目的优先级。较高的值表示该项目应更靠左显示。

返回描述
StatusBarItem

一个新的状态栏项目。

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

  • 抛出 - 在无法启动新进程的环境中运行时。
参数描述
name?: string

可选的人类可读字符串,将在 UI 中用于表示终端。

shellPath?: string

要用于终端的可选自定义 shell 可执行文件的路径。

shellArgs?: string | readonly string[]

自定义 shell 可执行文件的可选参数。字符串只能在 Windows 上使用,它允许以 命令行格式指定 shell 参数。

返回描述
Terminal

一个新的终端。

创建一个具有后备 shell 进程的 Terminal

  • 抛出 - 在无法启动新进程的环境中运行时。
参数描述
options: TerminalOptions

描述新终端特征的 TerminalOptions 对象。

返回描述
Terminal

一个新的终端。

创建一个由扩展控制其输入和输出的 Terminal

参数描述
options: ExtensionTerminalOptions

一个 ExtensionTerminalOptions 对象,描述新终端的特征。

返回描述
Terminal

一个新的终端。

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

参数描述
options: DecorationRenderOptions

装饰类型的呈现选项。

返回描述
TextEditorDecorationType

一个新的装饰类型实例。

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

参数描述
viewId: string

使用扩展点 views 贡献的视图的 ID。

options: TreeViewOptions<T>

用于创建 TreeView 的选项。

返回描述
TreeView<T>

一个 TreeView

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

参数描述
viewType: string

标识 webview 面板的类型。

title: string

面板的标题。

showOptions: ViewColumn | {preserveFocus: boolean, viewColumn: ViewColumn}

在编辑器中显示 webview 的位置。如果设置了 preserveFocus,则新的 webview 将不会获得焦点。

options?: WebviewPanelOptions & WebviewOptions

新面板的设置。

返回描述
WebviewPanel

新的 webview 面板。

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

当打开自定义编辑器时,会触发 onCustomEditor:viewType 激活事件。作为激活的一部分,您的扩展必须为 viewType 注册 CustomTextEditorProviderCustomReadonlyEditorProviderCustomEditorProvider

参数描述
viewType: string

自定义编辑器提供程序的唯一标识符。它应该与 customEditors 贡献点中的 viewType 匹配。

provider: CustomTextEditorProvider | CustomReadonlyEditorProvider<CustomDocument> | CustomEditorProvider<CustomDocument>

解析自定义编辑器的提供程序。

options?: {supportsMultipleEditorsPerDocument: boolean, webviewOptions: WebviewPanelOptions}

提供程序的选项。

返回描述
Disposable

用于注销提供程序的可释放对象。

注册文件装饰提供程序。

参数描述
provider: FileDecorationProvider
返回描述
Disposable

一个用于注销提供程序的 Disposable 对象。

注册一个提供程序,该提供程序允许检测和处理终端内的链接。

参数描述
provider: TerminalLinkProvider<TerminalLink>

提供终端链接的提供程序。

返回描述
Disposable

用于注销提供程序的可释放对象。

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

参数描述
id: string

贡献的终端配置文件的 ID。

provider: TerminalProfileProvider

终端配置文件提供程序。

返回描述
Disposable

一个用于注销提供程序的 disposable 对象。

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

注意: 要访问 TreeView 并对其执行操作,请使用 createTreeView

参数描述
viewId: string

使用扩展点 views 贡献的视图的 ID。

treeDataProvider: TreeDataProvider<T>

为视图提供树数据的 TreeDataProvider

返回描述
Disposable

一个用于注销 TreeDataProviderdisposable 对象。

注册一个能够处理系统范围 uriuri 处理程序。如果有多个窗口打开,最顶层的窗口将处理 uri。uri 处理程序的范围限定为它贡献自的扩展;它只能处理指向扩展本身的 uri。uri 必须遵守以下规则

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

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

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

  • 注意: 当指向当前扩展的 uri 即将被处理时,会触发激活事件 onUri
参数描述
handler: UriHandler

要为此扩展注册的 uri 处理程序。

返回描述
Disposable

一个用于注销处理程序的 disposable 对象。

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

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

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

参数描述
viewType: string

可以序列化的 webview 面板的类型。

serializer: WebviewPanelSerializer<unknown>

Webview 序列化器。

返回描述
Disposable

一个用于注销序列化器的 disposable 对象。

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

参数描述
viewId: string

视图的唯一 ID。它应该与 package.json 中 views 贡献中的 id 匹配。

provider: WebviewViewProvider

webview 视图的提供程序。

options?: {webviewOptions: {retainContextWhenHidden: boolean}}
返回描述
Disposable

用于注销提供程序的可释放对象。

在状态栏中设置消息。这是功能更强大的状态栏 items 的简写。

参数描述
text: string

要显示的消息,支持状态栏 items 中的图标替换。

hideAfterTimeout: number

消息将被处置的超时时间(以毫秒为单位)。

返回描述
Disposable

一个用于隐藏状态栏消息的可释放对象。

在状态栏中设置消息。这是功能更强大的状态栏 items 的简写。

参数描述
text: string

要显示的消息,支持状态栏 items 中的图标替换。

hideWhenDone: Thenable<any>

在其完成(解决或拒绝)时将处置消息的 Thenable。

返回描述
Disposable

一个用于隐藏状态栏消息的可释放对象。

在状态栏中设置消息。这是功能更强大的状态栏 items 的简写。

注意,状态栏消息会堆叠,并且在不再使用时必须处置它们。

参数描述
text: string

要显示的消息,支持状态栏 items 中的图标替换。

返回描述
Disposable

一个用于隐藏状态栏消息的可释放对象。

显示错误消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示错误消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示错误消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示错误消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

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

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

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

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示一条信息消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示一条信息消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

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

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

参数描述
options?: InputBoxOptions

配置输入框的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回描述
Thenable<string | undefined>

一个 Promise,它解析为用户提供的字符串,或者在取消的情况下解析为 undefined

notebook 编辑器中显示给定的 NotebookDocument

参数描述
document: NotebookDocument

要显示的文本文档。

options?: NotebookDocumentShowOptions

编辑器选项,用于配置 notebook 编辑器的显示行为。

返回描述
Thenable<NotebookEditor>

一个 Promise,它解析为 notebook 编辑器

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

参数描述
options?: OpenDialogOptions

控制对话框的选项。

返回描述
Thenable<Uri[] | undefined>

一个 Promise,它解析为选定的资源或 undefined

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

参数描述
items: readonly string[] | Thenable<readonly string[]>

字符串数组,或解析为字符串数组的 Promise。

options: QuickPickOptions & {canPickMany: true}

配置选择列表的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回描述
Thenable<string[] | undefined>

一个 Promise,它解析为选定的项目或 undefined

显示一个选择列表。

参数描述
items: readonly string[] | Thenable<readonly string[]>

字符串数组,或解析为字符串数组的 Promise。

options?: QuickPickOptions

配置选择列表的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回描述
Thenable<string | undefined>

一个 Promise,它解析为选择或 undefined

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

参数描述
items: readonly T[] | Thenable<readonly T[]>

一个项目数组,或解析为项目数组的 Promise。

options: QuickPickOptions & {canPickMany: true}

配置选择列表的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回描述
Thenable<T[] | undefined>

一个 Promise,它解析为选定的项目或 undefined

显示一个选择列表。

参数描述
items: readonly T[] | Thenable<readonly T[]>

一个项目数组,或解析为项目数组的 Promise。

options?: QuickPickOptions

配置选择列表的行为。

token?: CancellationToken

一个可用于发出取消信号的令牌。

返回描述
Thenable<T | undefined>

一个 Promise,它解析为选定的项目或 undefined

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

参数描述
options?: SaveDialogOptions

控制对话框的选项。

返回描述
Thenable<Uri | undefined>

一个 Promise,它解析为选定的资源或 undefined

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

参数描述
document: TextDocument

要显示的文本文档。

column?: ViewColumn

应在其中显示 编辑器的视图列。 默认值为 活动列。不存在的列将根据需要创建,最多可达 ViewColumn.Nine。使用 ViewColumn.Beside 将编辑器打开到当前活动编辑器的侧面。

preserveFocus?: boolean

如果为 true,则编辑器不会获取焦点。

返回描述
Thenable<TextEditor>

一个 Promise,它解析为 编辑器

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

参数描述
document: TextDocument

要显示的文本文档。

options?: TextDocumentShowOptions

编辑器选项,用于配置显示编辑器的行为。

返回描述
Thenable<TextEditor>

一个 Promise,它解析为 编辑器

openTextDocument(uri).then(document => showTextDocument(document, options)) 的简写形式。

另请参阅 workspace.openTextDocument

参数描述
uri: Uri

资源标识符。

options?: TextDocumentShowOptions

编辑器选项,用于配置显示编辑器的行为。

返回描述
Thenable<TextEditor>

一个 Promise,它解析为 编辑器

显示警告消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示警告消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示警告消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示警告消息。

另请参阅 showInformationMessage

参数描述
message: string

要显示的消息。

options: MessageOptions

配置消息的行为。

...items: T[]

一组将在消息中呈现为操作的项。

返回描述
Thenable<T | undefined>

一个 thenable,它解析为选定的项,或者在被关闭时解析为 undefined

显示一个可供选择的工作区文件夹列表。如果未打开任何文件夹,则返回 undefined

参数描述
options?: WorkspaceFolderPickOptions

配置工作区文件夹列表的行为。

返回描述
Thenable<WorkspaceFolder | undefined>

一个解析为工作区文件夹或 undefined 的 Promise。

在编辑器中显示进度。在运行给定的回调函数并且其返回的 Promise 未解析或拒绝时,将显示进度。应显示进度的位置(以及其他详细信息)通过传递的 ProgressOptions 定义。

参数描述
options: ProgressOptions

一个 ProgressOptions 对象,描述了用于显示进度的选项,例如其位置

task: (progress: Progress<{increment: number, message: string}>, token: CancellationToken) => Thenable<R>

一个返回 Promise 的回调函数。可以使用提供的 Progress 对象报告进度状态。

要报告离散进度,请使用 increment 来指示已完成的工作量。每次调用 increment 值都会被累加,并反映为总体进度,直到达到 100%(例如,值 10 表示已完成 10% 的工作)。请注意,目前只有 ProgressLocation.Notification 能够显示离散进度。

要监视操作是否已被用户取消,请使用提供的 CancellationToken。请注意,目前只有 ProgressLocation.Notification 支持显示取消按钮来取消长时间运行的操作。

返回描述
Thenable<R>

任务回调函数返回的 thenable 对象。

在运行给定的回调函数并且其返回的 Promise 未解析或拒绝时,在源代码管理视图中显示进度。

  • 已弃用 - 请改用 withProgress
参数描述
task: (progress: Progress<number>) => Thenable<R>

一个返回 Promise 的回调函数。可以使用提供的 Progress 对象报告进度增量。

返回描述
Thenable<R>

任务返回的 thenable 对象。

工作区

用于处理当前工作区的命名空间。工作区是在编辑器窗口(实例)中打开的一个或多个文件夹的集合。

也可以在没有工作区的情况下打开编辑器。例如,当您从平台的“文件”菜单中选择一个文件来打开新的编辑器窗口时,您将不会位于工作区中。在这种模式下,编辑器的某些功能会减少,但您仍然可以打开文本文件并对其进行编辑。

有关工作区概念的更多信息,请参阅 https://vscode.js.cn/docs/editor/workspaces

工作区提供了对 监听文件系统事件和查找文件的支持。两者都运行良好,并在编辑器进程外部运行,因此应始终使用它们而不是 nodejs 的等效项。

变量

一个 文件系统实例,允许与本地和远程文件进行交互,例如 vscode.workspace.fs.readDirectory(someUri) 允许检索目录的所有条目,或者 vscode.workspace.fs.stat(anotherUri) 返回文件的元数据。

当为 true 时,用户已明确信任工作区的内容。

工作区的名称。如果未打开任何工作区,则为 undefined

有关工作区概念的更多信息,请参阅 https://vscode.js.cn/docs/editor/workspaces

编辑器当前已知的所有笔记本文档。

workspaceFolders 的第一个条目的 uri,类型为 string。如果没有第一个条目,则为 undefined

有关工作区的更多信息,请参阅 https://vscode.js.cn/docs/editor/workspaces

编辑器当前已知的所有文本文档。

工作区文件的位置,例如

file:///Users/name/Development/myProject.code-workspace

untitled:1555503116870

对于未命名且尚未保存的工作区。

根据打开的工作区,该值将为

  • 未打开任何工作区时为 undefined
  • 否则为工作区文件的路径,类型为 Uri。如果工作区是未命名的,则返回的 URI 将使用 untitled: 方案

例如,该位置可以与 vscode.openFolder 命令一起使用,以便在工作区关闭后再次打开它。

示例

vscode.commands.executeCommand('vscode.openFolder', uriOfWorkspace);

有关工作区概念的更多信息,请参阅 https://vscode.js.cn/docs/editor/workspaces

注意:不建议使用 workspace.workspaceFile 将配置数据写入文件。您可以使用 workspace.getConfiguration().update() 来达到此目的,它在打开单个文件夹以及未命名或已保存的工作区时都有效。

在编辑器中打开的工作区文件夹列表(0-N)。如果未打开任何工作区,则为 undefined

有关工作区的更多信息,请参阅 https://vscode.js.cn/docs/editor/workspaces

事件

配置更改时发出的事件。

笔记本 发生更改时触发的事件。

文本文档 发生更改时触发的事件。这通常在 内容 更改时发生,但也包括 状态等其他更改。

当添加或删除工作区文件夹时触发的事件。

注意:如果添加、删除或更改第一个工作区文件夹,则不会触发此事件,因为在这种情况下,当前正在执行的扩展(包括监听此事件的扩展)将被终止并重新启动,以便将(已弃用的)rootPath 属性更新为指向第一个工作区文件夹。

笔记本 被释放时触发的事件。

注意 1: 不能保证关闭编辑器选项卡时会触发此事件。

注意 2: 笔记本可以打开但不在编辑器中显示,这意味着此事件可以针对未在编辑器中显示的笔记本触发。

文本文档 被释放或文本文档的语言 ID 被更改时触发的事件。

注意 1: 不能保证关闭编辑器选项卡时会触发此事件,请使用 onDidChangeVisibleTextEditors 事件来了解编辑器何时更改。

注意 2: 文档可以打开但不在编辑器中显示,这意味着此事件可以针对未在编辑器中显示的文档触发。

当创建文件时触发的事件。

注意: 此事件由用户操作触发,例如从资源管理器创建文件,或从 workspace.applyEdit API 创建文件,但当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

当删除文件时触发的事件。

注意 1: 此事件由用户操作触发,例如从资源管理器删除文件,或从 workspace.applyEdit API 删除文件,但当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

注意 2: 删除带有子项的文件夹时,只会触发一个事件。

当当前工作区被信任时触发的事件。

笔记本 打开时触发的事件。

文本文档 打开或文本文档的语言 ID 被更改时触发的事件。

要在可见文本文档打开时添加事件侦听器,请使用 window 命名空间中的 TextEditor 事件。请注意,

当文件被重命名时触发的事件。

注意 1: 此事件由用户操作触发,例如从资源管理器重命名文件,以及从 workspace.applyEdit API 重命名文件,但当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

注意 2: 重命名带有子项的文件夹时,只会触发一个事件。

笔记本 被保存时触发的事件。

文本文档 保存到磁盘时触发的事件。

当文件正在创建时触发的事件。

注意 1: 此事件由用户操作触发,例如从资源管理器创建文件,或从 workspace.applyEdit API 创建文件。当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

注意 2: 当触发此事件时,无法应用对正在创建的文件的编辑。

当文件正在删除时触发的事件。

注意 1: 此事件由用户操作触发,例如从资源管理器删除文件,或从 workspace.applyEdit API 删除文件,但当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

注意 2: 删除带有子项的文件夹时,只会触发一个事件。

当文件正在重命名时触发的事件。

注意 1: 此事件由用户操作触发,例如从资源管理器重命名文件,以及从 workspace.applyEdit API 重命名文件,但当磁盘上的文件更改时,不会 触发此事件,例如由另一个应用程序触发,或使用 workspace.fs API 时。

注意 2: 重命名带有子项的文件夹时,只会触发一个事件。

笔记本文档 将要保存到磁盘时触发的事件。

注意 1: 订阅者可以通过注册异步工作来延迟保存。为了数据完整性,编辑器可能会在不触发此事件的情况下保存。例如,在关闭具有脏文件的情况下。

注意 2: 订阅者按顺序调用,他们可以通过注册异步工作来延迟保存。防止行为不当的侦听器的保护实现如下:

  • 所有侦听器共享一个总的时间预算,如果该预算用完,则不会调用进一步的侦听器
  • 长时间运行或频繁产生错误的侦听器将不再被调用

当前的阈值是 1.5 秒作为总的时间预算,并且侦听器在被忽略之前最多可以出现 3 次行为不当的情况。

文本文档 将要保存到磁盘时触发的事件。

注意 1: 订阅者可以通过注册异步工作来延迟保存。为了数据完整性,编辑器可能会在不触发此事件的情况下保存。例如,在关闭具有脏文件的情况下。

注意 2: 订阅者按顺序调用,他们可以通过注册异步工作来延迟保存。防止行为不当的侦听器的保护实现如下:

  • 所有侦听器共享一个总的时间预算,如果该预算用完,则不会调用进一步的侦听器
  • 长时间运行或频繁产生错误的侦听器将不再被调用

当前的阈值是 1.5 秒作为总的时间预算,并且侦听器在被忽略之前最多可以出现 3 次行为不当的情况。

函数

根据给定的 工作区编辑 的定义,对一个或多个资源进行更改,或创建、删除和重命名资源。

工作区编辑的所有更改都按照添加的顺序应用。如果在同一位置进行多个文本插入,则这些字符串将按照 '插入' 的顺序出现在生成的文本中,除非它们与资源编辑交错。诸如 '删除文件 a' -> '在文件 a 中插入文本' 之类的无效序列会导致操作失败。

当应用仅包含文本编辑的工作区编辑时,将使用 '全有或全无' 策略。具有资源创建或删除的工作区编辑将中止操作,例如,当单个编辑失败时,不会尝试连续编辑。

参数描述
edit: WorkspaceEdit

一个工作区编辑。

metadata?: WorkspaceEditMetadata

编辑的可选 元数据

返回描述
Thenable<boolean>

一个在编辑可以应用时解析的 thenable 对象。

返回一个相对于工作区文件夹或多个文件夹的路径。

当没有 工作区文件夹 或路径不包含在其中时,将返回输入。

参数描述
pathOrUri: string | Uri

路径或 URI。当给定 URI 时,将使用其 fsPath

includeWorkspaceFolder?: boolean

当为 true 且给定路径包含在工作区文件夹内时,将预先添加工作区的名称。当有多个工作区文件夹时,默认为 true,否则为 false

返回描述
string

相对于根目录或输入的路径。

创建一个文件系统监视器,该监视器会根据提供的参数,在文件事件(创建、更改、删除)时收到通知。

默认情况下,将递归监视所有打开的 工作区文件夹 中的文件更改。

可以通过提供具有要监视的 base 路径的 RelativePattern 来添加其他路径以进行文件监视。如果路径是文件夹且 pattern 很复杂(例如,包含 ** 或路径段),则将递归监视该路径,否则将非递归监视(即,只会报告对路径的第一级的更改)。

注意,文件系统中不存在的路径将延迟监视,直到创建后才会根据提供的参数进行监视。如果删除受监视的路径,则监视器将暂停且不会报告任何事件,直到再次创建该路径。

如果可能,请尽量减少递归监视器的使用,因为递归文件监视会占用大量资源。

string 作为 globPattern 提供,可作为监视所有打开的工作区文件夹中的文件事件的便捷方法。它不能用于添加更多文件监视文件夹,也不会报告来自不属于打开的工作区文件夹的任何文件夹中的文件事件。

可以选择提供忽略某些类型事件的标志。

要停止侦听事件,必须处置监视器。

注意,递归文件监视器的文件事件可能会根据用户配置而被排除。设置 files.watcherExclude 有助于减少已知会一次产生许多文件更改的文件夹(例如 .git 文件夹)的文件事件开销。因此,强烈建议使用不需要递归监视器的简单模式进行监视,在这种情况下,排除设置将被忽略,并且您可以完全控制事件。

注意,除非要监视的路径本身是符号链接,否则不会自动跟踪符号链接以进行文件监视。

注意,报告为已更改的文件路径与不区分大小写的平台(通常是 macOS 和 Windows,而不是 Linux)上的磁盘上的实际大小写相比,可能具有不同的大小写。我们允许用户以任何所需路径大小写打开工作区文件夹,并尝试保留该大小写。这意味着

  • 如果路径在任何工作区文件夹内,则该路径的大小写将与路径中该部分的工作区文件夹的大小写匹配,并与子项的磁盘上的大小写匹配
  • 如果路径在任何工作区文件夹之外,则大小写将与为监视提供的路径的大小写匹配。同样,符号链接也会保留,即文件事件将报告符号链接的路径,因为它是为监视提供的,而不是目标。

示例

文件监视器的基本结构如下

const watcher = vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(<folder>, <pattern>));

watcher.onDidChange(uri => { ... }); // listen to files being changed
watcher.onDidCreate(uri => { ... }); // listen to files/folders being created
watcher.onDidDelete(uri => { ... }); // listen to files/folders getting deleted

watcher.dispose(); // dispose after usage

工作区文件监视

如果您只关心特定工作区文件夹中的文件事件

vscode.workspace.createFileSystemWatcher(
  new vscode.RelativePattern(vscode.workspace.workspaceFolders[0], '**/*.js')
);

如果您要监视所有打开的工作区文件夹中的文件事件

vscode.workspace.createFileSystemWatcher('**/*.js');

注意: 如果未打开任何工作区(空窗口),则工作区文件夹数组可以为空。

工作区外文件监视

要监视工作区外部的文件夹中 *.js 文件的更改(非递归),请将 Uri 传递到该文件夹

vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(vscode.Uri.file(<path to folder outside workspace>), '*.js'));

并使用复杂的 glob 模式进行递归监视

vscode.workspace.createFileSystemWatcher(new vscode.RelativePattern(vscode.Uri.file(<path to folder outside workspace>), '**/*.js'));

这是监视活动编辑器以进行文件更改的示例

vscode.workspace.createFileSystemWatcher(
  new vscode.RelativePattern(vscode.window.activeTextEditor.document.uri, '*')
);
参数描述
globPattern: GlobPattern

一个 glob 模式,用于控制监视器应报告哪些文件事件。

ignoreCreateEvents?: boolean

忽略何时创建文件。

ignoreChangeEvents?: boolean

忽略何时更改文件。

ignoreDeleteEvents?: boolean

忽略何时删除文件。

返回描述
FileSystemWatcher

一个新的文件系统监视器实例。不再需要时必须处置。

在工作区中的所有 工作区文件夹 中查找文件。

示例

findFiles('**/*.js', '**/node_modules/**', 10);
参数描述
include: GlobPattern

一个 glob 模式,用于定义要搜索的文件。glob 模式将与相对于其工作区的匹配结果的文件路径进行匹配。使用 相对模式 将搜索结果限制为 工作区文件夹

exclude?: GlobPattern

一个 glob 模式,用于定义要排除的文件和文件夹。glob 模式将与相对于其工作区的匹配结果的文件路径进行匹配。当为 undefined 时,将应用默认文件排除(例如,files.exclude 设置,但不是 search.exclude)。当为 null 时,将不应用任何排除。

maxResults?: number

结果的上限。

token?: CancellationToken

可用于向基础搜索引擎发出取消信号的令牌。

返回描述
Thenable<Uri[]>

一个可解析为资源标识符数组的 thenable。如果未打开任何 工作区文件夹,则将不返回任何结果。

获取工作区配置对象。

当提供节标识符时,仅返回该部分配置。节标识符中的点将被解释为子访问权限,例如 { myExt: { setting: { doIt: true }}}getConfiguration('myExt.setting').get('doIt') === true

当提供范围时,将返回限制为该范围的配置。范围可以是资源或语言标识符,或两者兼有。

参数描述
section?: string

一个点分隔的标识符。

scope?: ConfigurationScope

请求配置的范围。

返回描述
WorkspaceConfiguration

完整配置或子集。

返回包含给定 URI 的 工作区文件夹

  • 当给定 URI 与任何工作区文件夹都不匹配时,返回 undefined
  • 当给定 URI 本身是工作区文件夹时,返回输入
参数描述
uri: Uri

一个 URI。

返回描述
WorkspaceFolder | undefined

一个工作区文件夹或 undefined

打开笔记本。如果此笔记本已 加载,将提前返回。否则,将加载笔记本并触发 onDidOpenNotebookDocument 事件。

注意,返回的笔记本的生命周期由编辑器拥有,而不是由扩展程序拥有。这意味着在打开笔记本后,可能会随时发生 onDidCloseNotebookDocument 事件。

注意,打开笔记本不会显示笔记本编辑器。此函数仅返回一个笔记本文档,该文档可以在笔记本编辑器中显示,但也可以用于其他用途。

参数描述
uri: Uri

要打开的资源。

返回描述
Thenable<NotebookDocument>

一个解析为 笔记本 的 Promise

打开一个未命名的笔记本。当要保存文档时,编辑器将提示用户输入文件路径。

另请参阅 workspace.openNotebookDocument

参数描述
notebookType: string

应使用的笔记本类型。

content?: NotebookData

笔记本的初始内容。

返回描述
Thenable<NotebookDocument>

一个解析为 笔记本 的 Promise。

打开一个文档。如果此文档已打开,将提前返回。否则,将加载文档并触发 didOpen 事件。

该文档由 Uri 表示。根据 scheme,以下规则适用

  • file-scheme:打开磁盘上的文件 (openTextDocument(Uri.file(path)))。如果文件不存在或无法加载,将被拒绝。
  • untitled-scheme:打开一个空白的未命名文件并关联路径 (openTextDocument(Uri.file(path).with({ scheme: 'untitled' })))。语言将从文件名派生。
  • 对于所有其他方案,将咨询贡献的 文本文档内容提供程序文件系统提供程序

注意,返回的文档的生命周期由编辑器拥有,而不是由扩展程序拥有。这意味着在打开文档后,可能会随时发生 onDidClose 事件。

参数描述
uri: Uri

标识要打开的资源。

返回描述
Thenable<TextDocument>

一个解析为 文档 的 Promise。

openTextDocument(Uri.file(path)) 的简写。

另请参阅 workspace.openTextDocument

参数描述
path: string

磁盘上文件的路径。

返回描述
Thenable<TextDocument>

一个解析为 文档 的 Promise。

打开一个无标题的文本文档。当文档要保存时,编辑器会提示用户输入文件路径。options 参数允许指定文档的语言和/或内容

参数描述
options?: {content: string, language: string}

控制如何创建文档的选项。

返回描述
Thenable<TextDocument>

一个解析为 文档 的 Promise。

为给定的方案注册文件系统提供程序,例如 ftp

每个方案只能有一个提供程序,当方案已被另一个提供程序声明或被保留时,会抛出错误。

参数描述
scheme: string

提供程序注册的 uri-方案

provider: FileSystemProvider

文件系统提供程序。

options?: {isCaseSensitive: boolean, isReadonly: boolean | MarkdownString}

关于提供程序的不可变元数据。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个 笔记本序列化器

笔记本序列化器必须通过 notebooks 扩展点进行贡献。当打开一个笔记本文件时,编辑器将发送 onNotebook:<notebookType> 激活事件,扩展必须返回注册其序列化器。

参数描述
notebookType: string

一个笔记本。

serializer: NotebookSerializer

一个笔记本序列化器。

options?: NotebookDocumentContentOptions

可选的上下文选项,用于定义应持久化笔记本的哪些部分

返回描述
Disposable

一个 Disposable,当被释放时,会注销此序列化器。

注册一个任务提供程序。

  • 已弃用 - 请改用 tasks 命名空间上的相应函数
参数描述
type: string

此提供程序注册的任务类型。

provider: TaskProvider<Task>

一个任务提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

注册一个文本文档内容提供程序。

每个方案只能注册一个提供程序。

参数描述
scheme: string

要注册的 uri 方案。

provider: TextDocumentContentProvider

一个内容提供程序。

返回描述
Disposable

一个 Disposable,当被处置时会取消注册此提供程序。

保存由给定资源标识的编辑器,并返回结果资源。如果保存不成功或未找到具有给定资源的编辑器,则返回 undefined

注意,必须打开具有提供的资源的编辑器才能保存。

参数描述
uri: Uri

要保存的已打开编辑器的关联 uri。

返回描述
Thenable<Uri | undefined>

当保存操作完成时解析的 thenable。

保存所有脏文件。

参数描述
includeUntitled?: boolean

也保存在此会话期间创建的文件。

返回描述
Thenable<boolean>

一个 thenable,当文件保存时解析。对于任何未能保存的文件,将返回 false

将由给定资源标识的编辑器保存到用户提供的新文件名,并返回结果资源。如果保存不成功、取消或未找到具有给定资源的编辑器,则返回 undefined

注意,必须打开具有提供的资源的编辑器才能另存为。

参数描述
uri: Uri

要另存为的已打开编辑器的关联 uri。

返回描述
Thenable<Uri | undefined>

当另存为操作完成时解析的 thenable。

此方法在 vscode.workspace.workspaceFolders 数组中,从索引 start 开始,用可选的 workspaceFoldersToAdd 集合替换 deleteCount工作区文件夹。这种“拼接”行为可用于在单个操作中添加、删除和更改工作区文件夹。

注意:在某些情况下,调用此方法可能会导致当前正在执行的扩展(包括调用此方法的扩展)被终止并重新启动。例如,当添加、删除或更改第一个工作区文件夹时,(已弃用的)rootPath 属性将更新为指向第一个工作区文件夹。另一种情况是从空或单文件夹工作区转换为多文件夹工作区(另请参见:https://vscode.js.cn/docs/editor/workspaces)。

当工作区文件夹更新时,请使用 onDidChangeWorkspaceFolders() 事件接收通知。

示例:在工作区文件夹的末尾添加新的工作区文件夹

workspace.updateWorkspaceFolders(workspace.workspaceFolders ? workspace.workspaceFolders.length : 0, null, { uri: ...});

示例:删除第一个工作区文件夹

workspace.updateWorkspaceFolders(0, 1);

示例:用新的工作区文件夹替换现有工作区文件夹

workspace.updateWorkspaceFolders(0, 1, { uri: ...});

删除现有工作区文件夹并再次添加它,并使用不同的名称来重命名该文件夹是有效的。

注意:多次调用 updateWorkspaceFolders() 而不等待 onDidChangeWorkspaceFolders() 触发是无效的。

参数描述
start: number

当前打开的 工作区文件夹 列表中从零开始的位置,从中开始删除工作区文件夹。

deleteCount: number

要删除的可选工作区文件夹数量。

...workspaceFoldersToAdd: Array<{name: string, uri: Uri}>

要添加到已删除文件夹的可选工作区文件夹变量集。每个工作区都必须使用 URI 标识,并且可以使用可选的名称。

返回描述
布尔值

如果操作成功启动,则为 true;否则如果使用的参数导致无效的工作区文件夹状态(例如,2 个文件夹具有相同的 URI),则为 false。

AccessibilityInformation

辅助功能信息,用于控制屏幕阅读器行为。

属性

项目获得焦点后由屏幕阅读器读出的标签。

小部件的角色,定义屏幕阅读器如何与之交互。当例如树状元素表现得像复选框时,应在特殊情况下设置角色。如果未指定角色,则编辑器将自动选择适当的角色。有关 aria 角色的更多信息,请访问 https://w3c.github.io/aria/#widget_roles

AuthenticationForceNewSessionOptions

使用标志 forceNewSession 调用 authentication.getSession 时使用的可选选项。

属性

一个可选的消息,当要求重新验证身份时将显示给用户。提供有关为什么要求用户重新验证身份的其他上下文可以帮助增加他们接受的可能性。

AuthenticationGetSessionOptions

AuthenticationProvider 获取 AuthenticationSession 时使用的选项。

属性

您希望获取会话的帐户。它会传递到身份验证提供程序,用于创建正确的会话。

是否应清除现有的会话偏好设置。

对于支持同时登录多个帐户的身份验证提供程序,当调用 getSession 时,将提示用户选择要使用的帐户。此偏好设置将被记住,直到使用此标志调用 getSession

注意:该偏好设置是扩展特定的。因此,如果一个扩展调用 getSession,它不会影响另一个调用 getSession 的扩展的会话偏好设置。此外,该偏好设置是为当前工作区和全局设置的。这意味着新的工作区将首先使用“全局”值,然后当提供此标志时,可以为该工作区设置新值。这也意味着,如果新的工作区设置此标志,则预先存在的工作区不会丢失其偏好设置。

默认为 false。

如果没有匹配的会话,是否应该执行登录。

如果为 true,将显示一个模态对话框,要求用户登录。如果为 false,则会在帐户活动栏图标上显示一个编号的徽章。扩展的条目将添加到菜单下以进行登录。这允许静默地提示用户登录。

如果存在匹配的会话,但扩展程序尚未被授予访问权限,则将此设置为 true 也会导致立即显示模态对话框,而设置为 false 将在帐户图标上添加一个编号的徽章。

默认为 false。

注意:您不能将此选项与 silent 一起使用。

即使已经有可用的会话,是否应尝试重新进行身份验证。

如果为 true,将显示一个模态对话框,要求用户再次登录。这主要用于令牌需要重新生成的情况,因为它失去了一些授权。

如果没有现有会话并且 forceNewSession 为 true,则其行为将与 createIfNone 相同。

默认为 false。

是否应在“帐户”菜单中显示登录指示。

如果为 false,则会在“帐户”菜单上向用户显示一个徽章,其中包含扩展的登录选项。如果为 true,则不会显示任何指示。

默认为 false。

注意:您不能将此选项与任何其他提示用户的选项(如 createIfNone)一起使用。

AuthenticationProvider

用于对服务执行身份验证的提供程序。

事件

当会话数组已更改或会话内的数据已更改时触发的 事件

方法

提示用户登录。

如果登录成功,则应触发 onDidChangeSessions 事件。

如果登录失败,则应返回拒绝的 promise。

如果提供程序已指定它不支持多个帐户,则如果已经存在与这些范围匹配的会话,则永远不应调用此方法。

参数描述
scopes: readonly string[]

新会话应使用创建的范围、权限列表。

options: AuthenticationProviderSessionOptions

用于创建会话的其他选项。

返回描述
Thenable<AuthenticationSession>

一个 promise,解析为身份验证会话。

获取会话列表。

参数描述
scopes: readonly string[]

范围的可选列表。如果提供,则返回的会话应匹配这些权限,否则应返回所有会话。

options: AuthenticationProviderSessionOptions

用于获取会话的其他选项。

返回描述
Thenable<AuthenticationSession[]>

一个 promise,解析为身份验证会话数组。

删除与会话 ID 对应的会话。

如果删除成功,则应触发 onDidChangeSessions 事件。

如果无法删除会话,则提供程序应拒绝并显示错误消息。

参数描述
sessionId: string

要删除的会话的 ID。

返回描述
Thenable<void>

AuthenticationProviderAuthenticationSessionsChangeEvent

当添加、删除或更改 AuthenticationSession 时触发的 事件

属性

已更改的 AuthenticationProviderAuthenticationSessions。当会话的数据(不包括 ID)更新时,会话将更改。例如,会话刷新会导致为会话设置新的访问令牌。

AuthenticationProviderInformation

有关 AuthenticationProvider 的基本信息

属性

身份验证提供程序的唯一标识符。

身份验证提供程序的易读名称。

AuthenticationProviderOptions

用于创建 AuthenticationProvider 的选项。

属性

是否可以使用此提供程序同时登录到多个帐户。如果未指定,则默认为 false。

AuthenticationProviderSessionOptions

属性

正在询问的帐户。如果传入此项,则提供程序应尝试返回仅与此帐户相关的会话。

AuthenticationSession

表示当前已登录用户的会话。

属性

访问令牌。

与会话关联的帐户。

身份验证会话的标识符。

会话访问令牌授予的权限。可用的范围由 AuthenticationProvider 定义。

AuthenticationSessionAccountInformation

AuthenticationSession 关联的帐户信息。

属性

帐户的唯一标识符。

帐户的易读名称。

AuthenticationSessionsChangeEvent

当添加、删除或更改 AuthenticationSession 时触发的 事件

属性

会话发生更改的 AuthenticationProvider

AutoClosingPair

描述字符串对,当键入开始字符串时,将自动插入结束字符串。

属性

键入开始字符串时将自动插入的结束字符串。

不应自动关闭此字符串对的标记集合。

将触发自动插入结束字符串的字符串。

BranchCoverage

包含 StatementCoverage 的分支的覆盖率信息。

构造函数

参数描述
executed: number | boolean

此分支的执行次数,如果确切计数未知,则为指示是否已执行的布尔值。如果为零或 false,则该分支将标记为未覆盖。

location?: Range | Position

分支位置。

label?: string
返回描述
BranchCoverage

属性

此分支的执行次数,如果确切计数未知,则为指示是否已执行的布尔值。如果为零或 false,则该分支将标记为未覆盖。

分支的标签,例如,用于“未采用 ${label} 分支”的上下文。

分支位置。

Breakpoint

所有断点类型的基类。

构造函数

创建新断点

参数描述
enabled?: boolean

是否启用断点。

condition?: string

条件断点的表达式

hitCondition?: string

控制忽略多少次断点命中的表达式

logMessage?: string

命中断点时要显示的日志消息

返回描述
Breakpoint

属性

条件断点的可选表达式。

是否启用断点。

控制忽略多少次断点命中的可选表达式。

断点的唯一 ID。

命中此断点时记录的可选消息。{} 内的嵌入表达式由调试适配器进行插值。

BreakpointsChangeEvent

一个描述 断点 集更改的事件。

属性

添加的断点。

已更改的断点。

已删除的断点。

CallHierarchyIncomingCall

表示传入调用,例如,方法或构造函数的调用方。

构造函数

创建新的调用对象。

参数描述
item: CallHierarchyItem

发出调用的项。

fromRanges: Range[]

调用出现的位置。

返回描述
CallHierarchyIncomingCall

属性

发出调用的项。

调用出现的范围。这是相对于 this.from 表示的调用方的。

CallHierarchyItem

表示调用层次结构上下文中诸如函数或构造函数之类的编程构造。

构造函数

创建新的调用层次结构项。

参数描述
kind: SymbolKind
name: string
detail: string
uri: Uri
range: Range
selectionRange: Range
返回描述
CallHierarchyItem

属性

此项的更多详细信息,例如函数的签名。

此项的种类。

此项的名称。

封闭此符号的范围,不包括开头/结尾的空格,但包括所有其他内容,例如注释和代码。

选择和显示此符号时应该选择和显示的范围,例如函数的名称。必须包含在 range 中。

此项的标签。

此项的资源标识符。

CallHierarchyOutgoingCall

表示传出调用,例如,从方法调用 getter 或从构造函数调用方法等。

构造函数

创建新的调用对象。

参数描述
item: CallHierarchyItem

被调用的项

fromRanges: Range[]

调用出现的位置。

返回描述
CallHierarchyOutgoingCall

属性

调用此项的范围。这是相对于调用方的范围,例如传递给 provideCallHierarchyOutgoingCalls 的项,而不是 this.to

被调用的项。

CallHierarchyProvider

调用层级提供程序接口描述了扩展与调用层级功能之间的约定,该功能允许浏览函数、方法、构造函数等的调用和调用方。

方法

通过返回给定文档和位置所表示的项来引导调用层级。此项将用作调用图的入口。当给定位置没有项时,提供程序应返回 undefinednull

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<CallHierarchyItem | CallHierarchyItem[]>

一个或多个调用层级项,或者解析为此类项的可 thenable 对象。可以通过返回 undefinednull 或空数组来表示缺少结果。

为项提供所有传入调用,例如方法的所有调用方。在图论中,这描述了调用图中带注释的有向边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: CallHierarchyItem

应为其计算传入调用的层级项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<CallHierarchyIncomingCall[]>

一组传入调用或解析为此类调用的可 thenable 对象。可以通过返回 undefinednull 来表示缺少结果。

为项提供所有传出调用,例如从给定项调用函数、方法或构造函数。在图论中,这描述了调用图中带注释的有向边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: CallHierarchyItem

应为其计算传出调用的层级项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<CallHierarchyOutgoingCall[]>

一组传出调用或解析为此类调用的可 thenable 对象。可以通过返回 undefinednull 来表示缺少结果。

CancellationError

一种错误类型,应用于指示操作已取消。

取消令牌 被取消时,或者当操作正在被该操作的执行者取消时,可以使用此类型。

构造函数

创建一个新的取消错误。

参数描述
返回描述
CancellationError

CancellationToken

取消令牌被传递到异步或长时间运行的操作以请求取消,例如取消对完成项的请求,因为用户继续键入。

要获取 CancellationToken 的实例,请使用 CancellationTokenSource

属性

当令牌已取消时为 true,否则为 false

取消时触发的 事件

CancellationTokenSource

取消源创建并控制取消令牌

构造函数

参数描述
返回描述
CancellationTokenSource

属性

此源的取消令牌。

方法

在令牌上发出取消信号。

参数描述
返回描述
void

处置对象并释放资源。

参数描述
返回描述
void

CharacterPair

一对字符,如一对开括号和闭括号。

ChatContext

传递给参与者的额外上下文。

属性

当前聊天会话中到目前为止的所有聊天消息。目前,仅包含当前参与者的聊天消息。

ChatErrorDetails

表示聊天请求的错误结果。

属性

向用户显示的错误消息。

如果设置为 true,则响应将部分模糊。

ChatFollowup

参与者建议的后续问题。

属性

默认情况下,后续问题转到相同的参与者/命令。但是,可以设置此属性来调用不同的命令。

要向用户显示的标题。如果未指定,则默认显示提示。

默认情况下,后续问题转到相同的参与者/命令。但是,可以设置此属性以通过 ID 调用不同的参与者。后续问题只能调用由同一扩展贡献的参与者。

要发送到聊天的消息。

ChatFollowupProvider

每次请求后都会调用一次,以获取建议的后续问题以向用户显示。用户可以单击后续问题以将其发送到聊天。

方法

为给定结果提供后续问题。

参数描述
result: ChatResult

此对象具有与参与者回调返回的结果相同的属性,包括 metadata,但不是同一实例。

context: ChatContext

传递给参与者的额外上下文。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<ChatFollowup[]>

ChatLanguageModelToolReference

用户手动附加到其请求的工具的引用,可以使用内联的 # 语法,也可以通过回形针按钮作为附件。

属性

工具名称。 指的是 lm.tools 中列出的工具。

prompt 中引用的起始和结束索引。 当未定义时,表示引用不属于提示文本的一部分。

注意,索引会考虑前导的 # 字符,这意味着它们可以直接用于修改提示。

ChatParticipant

聊天会话中,用户可以使用 前缀调用聊天参与者。当被调用时,它会处理聊天请求,并全权负责向用户提供响应。ChatParticipant 使用 chat.createChatParticipant 创建。

事件

每当收到结果的反馈时触发的事件,例如当用户对结果进行向上或向下投票时。

传递的 result 保证与此聊天参与者的处理程序先前返回的结果具有相同的属性。

属性

每次请求后,将调用此提供程序来检索建议的后续问题。

UI 中显示的参与者图标。

此参与者的唯一 ID。

此参与者的请求处理程序。

方法

释放此参与者并释放资源。

参数描述
返回描述
void

ChatParticipantToolToken

在处理聊天请求时调用工具时,可以传递给 lm.invokeTool 的令牌。

ChatPromptReference

用户添加到其聊天请求中的值的引用。

属性

此类型引用的唯一标识符。

可在 LLM 提示中使用的此值的描述。

prompt 中引用的起始和结束索引。 当未定义时,表示引用不属于提示文本的一部分。

注意,索引会考虑前导的 # 字符,这意味着它们可以直接用于修改提示。

此引用的值。 现在使用 string | Uri | Location 类型,但将来可能会扩展。

ChatRequest

对聊天参与者的请求。

属性

为此请求选择的 [ChatCommand 命令](#ChatCommand 命令)的名称。

这是当前在 UI 中选择的模型。 扩展可以使用此模型,也可以使用 chat.selectChatModels 来选择其他模型。 不要在此请求的生命周期之后保留此模型。

用户输入的提示。

有关此请求中使用的引用的信息存储在 ChatRequest.references 中。

注意,参与者的 [ChatParticipant.name 名称](#ChatParticipant.name 名称)和 [ChatCommand.name 命令](#ChatCommand.name 命令)不属于提示的一部分。

提示中引用的引用及其值的列表。

注意,提示包含按原样编写的引用,并且由参与者进一步修改提示,例如通过内联引用值或创建指向包含已解析值的标题的链接。 引用按其在提示中的范围的反向顺序排序。 这意味着提示中的最后一个引用是此列表中的第一个。 这简化了提示的字符串操作。

在处理聊天请求时调用工具时,可以传递给 lm.invokeTool 的令牌。 这会将工具调用与聊天会话关联起来。

用户附加到其请求的工具列表。

当存在工具引用时,聊天参与者应使用 LanguageModelChatToolMode.Required 发出聊天请求,以强制语言模型为工具生成输入。 然后,参与者可以使用 lm.invokeTool 来使用该工具,并将结果附加到其对用户提示的请求中。 该工具可能为用户的请求提供有用的额外上下文。

ChatRequestHandler

ChatRequestTurn

表示聊天历史记录中的用户请求。

属性

为此请求选择的 [ChatCommand 命令](#ChatCommand 命令)的名称。

此请求指向的聊天参与者的 ID。

用户输入的提示。

有关此请求中使用的引用的信息存储在 ChatRequestTurn.references 中。

注意,参与者的 [ChatParticipant.name 名称](#ChatParticipant.name 名称)和 [ChatCommand.name 命令](#ChatCommand.name 命令)不属于提示的一部分。

此消息中使用的引用。

附加到此请求的工具列表。

ChatResponseAnchorPart

表示聊天响应的一部分,该部分是锚点,呈现为指向目标的链接。

构造函数

创建一个新的 ChatResponseAnchorPart。

参数描述
value: Uri | Location

一个 URI 或位置。

title?: string

一个可选的标题,与值一起呈现。

返回描述
ChatResponseAnchorPart

属性

一个可选的标题,与值一起呈现。

此锚点的目标。

ChatResponseCommandButtonPart

表示聊天响应的一部分,该部分是一个执行命令的按钮。

构造函数

创建一个新的 ChatResponseCommandButtonPart。

参数描述
value: Command

单击按钮时将执行的命令。

返回描述
ChatResponseCommandButtonPart

属性

单击按钮时将执行的命令。

ChatResponseFileTree

表示聊天响应中的文件树结构。

属性

如果当前文件树是目录,则为子文件树的数组。

文件或目录的名称。

ChatResponseFileTreePart

表示聊天响应的一部分,该部分是一个文件树。

构造函数

创建一个新的 ChatResponseFileTreePart。

参数描述
value: ChatResponseFileTree[]

文件树数据。

baseUri: Uri

此文件树相对于的基础 URI。

返回描述
ChatResponseFileTreePart

属性

此文件树相对于的基础 URI

文件树数据。

ChatResponseMarkdownPart

表示聊天响应的一部分,该部分格式化为 Markdown。

构造函数

创建一个新的 ChatResponseMarkdownPart。

参数描述
value: string | MarkdownString

一个 Markdown 字符串或应解释为 Markdown 的字符串。不支持 MarkdownString.isTrusted 的布尔形式。

返回描述
ChatResponseMarkdownPart

属性

一个 Markdown 字符串或应解释为 Markdown 的字符串。

ChatResponsePart

表示不同的聊天响应类型。

ChatResponseProgressPart

表示聊天响应的一部分,该部分是进度消息。

构造函数

创建一个新的 ChatResponseProgressPart。

参数描述
value: string

进度消息

返回描述
ChatResponseProgressPart

属性

进度消息

ChatResponseReferencePart

表示聊天响应的一部分,该部分是一个引用,与内容分开呈现。

构造函数

创建一个新的 ChatResponseReferencePart。

参数描述
value: Uri | Location

一个 URI 或位置

iconPath?: IconPath

UI 中显示的引用的图标

返回描述
ChatResponseReferencePart

属性

引用的图标。

引用的目标。

ChatResponseStream

ChatResponseStream 是参与者如何将内容返回到聊天视图的方式。它提供了几种流式传输不同类型内容的方法,这些内容将以适当的方式在聊天视图中呈现。参与者可以使用其要返回的内容类型的辅助方法,也可以实例化一个 ChatResponsePart 并使用通用的 ChatResponseStream.push 方法返回它。

方法

将锚点部分推送到此流。是 push(new ChatResponseAnchorPart(value, title)) 的简写。锚点是对某种类型资源的内联引用。

参数描述
value: Uri | Location

一个 URI 或位置。

title?: string

一个可选的标题,与值一起呈现。

返回描述
void

将命令按钮部分推送到此流。是 push(new ChatResponseCommandButtonPart(value, title)) 的简写。

参数描述
command: Command

单击按钮时将执行的命令。

返回描述
void

将文件树部分推送到此流。是 push(new ChatResponseFileTreePart(value)) 的简写。

参数描述
value: ChatResponseFileTree[]

文件树数据。

baseUri: Uri

此文件树相对于的基础 URI。

返回描述
void

将 markdown 部分推送到此流。是 push(new ChatResponseMarkdownPart(value)) 的简写。

另请参阅 ChatResponseStream.push

参数描述
value: string | MarkdownString

一个 Markdown 字符串或应解释为 Markdown 的字符串。不支持 MarkdownString.isTrusted 的布尔形式。

返回描述
void

将进度部分推送到此流。是 push(new ChatResponseProgressPart(value)) 的简写。

参数描述
value: string

进度消息

返回描述
void

将一个部分推送到此流。

参数描述
part: ChatResponsePart

响应部分,呈现或元数据

返回描述
void

将引用推送到此流。是 push(new ChatResponseReferencePart(value)) 的简写。

注意 引用不会与响应内联呈现。

参数描述
value: Uri | Location

一个 URI 或位置

iconPath?: IconPath

UI 中显示的引用的图标

返回描述
void

ChatResponseTurn

表示聊天参与者在聊天历史记录中的响应。

属性

此响应来自的命令的名称。

此响应来自的聊天参与者的 ID。

从聊天参与者收到的内容。仅表示代表实际内容(而非元数据)的流部分。

从聊天参与者收到的结果。

ChatResult

聊天请求的结果。

属性

如果请求导致错误,此属性定义错误详细信息。

此结果的任意元数据。可以是任何内容,但必须可 JSON 字符串化。

ChatResultFeedback

表示用户对结果的反馈。

属性

收到的反馈类型。

用户提供反馈的 ChatResult。此对象具有与从参与者回调返回的结果相同的属性,包括 metadata,但不是同一实例。

ChatResultFeedbackKind

表示收到的用户反馈类型。

枚举成员

用户将结果标记为无用。

用户将结果标记为有用。

Clipboard

剪贴板提供对系统剪贴板的读写访问。

方法

将当前剪贴板内容读取为文本。

参数描述
返回描述
Thenable<string>

一个 thenable,解析为字符串。

将文本写入剪贴板。

参数描述
value: string
返回描述
Thenable<void>

一个 thenable,在写入发生时解析。

CodeAction

代码操作表示可以在代码中执行的更改,例如修复问题或重构代码。

CodeAction 必须设置 edit 和/或 command。如果同时提供两者,则先应用 edit,然后执行命令。

构造函数

创建新的代码操作。

代码操作必须至少具有 titleedits 和/或 command

参数描述
title: string

代码操作的标题。

kind?: CodeActionKind

代码操作的种类。

返回描述
CodeAction

属性

此代码操作执行的 Command

如果此命令引发异常,编辑器会在当前光标位置向用户显示异常消息。

此代码操作解决的 Diagnostics

标记该代码操作当前无法应用。

  • 禁用的代码操作不会在自动 灯泡 代码操作菜单中显示。

  • 当用户请求更具体的代码操作类型(例如重构)时,禁用的操作会在代码操作菜单中显示为灰色。

  • 如果用户有 快捷键 自动应用代码操作并且仅返回禁用的代码操作,则编辑器会在编辑器中向用户显示包含 reason 的错误消息。

参数描述
reason: string

有关当前禁用代码操作原因的人类可读描述。

这会在代码操作 UI 中显示。

此代码操作执行的 工作区编辑

将此标记为首选操作。首选操作由 auto fix 命令使用,并且可以由快捷键定位。

如果快速修复程序能够正确解决根本错误,则应将其标记为首选。如果重构是采取操作的最合理选择,则应将其标记为首选。

代码操作的 Kind

用于筛选代码操作。

此代码操作的简短、人类可读标题。

CodeActionContext

包含有关运行 代码操作 的上下文的附加诊断信息。

属性

诊断数组。

要返回的请求操作类型。

灯泡 显示之前,会筛选掉不属于此类型的操作。

请求代码操作的原因。

CodeActionKind

代码操作的种类。

种类是按 . 分隔的分层标识符列表,例如 "refactor.extract.function"

编辑器将代码操作种类用于 UI 元素,例如重构上下文菜单。用户还可以使用 editor.action.codeAction 命令触发特定种类的代码操作。

静态

空种类。

应用于整个笔记本范围的所有代码操作的基本种类。使用此项的 CodeActionKinds 应始终以 notebook. 开头。

这要求为其创建新的 CodeAction 并通过扩展进行贡献。预先存在的种类不能仅在其中添加新的 notebook. 前缀,因为该功能对于完整的笔记本范围来说是唯一的。

笔记本 CodeActionKinds 可以初始化为以下任一形式(都将生成 notebook.source.xyz

  • const newKind = CodeActionKind.Notebook.append(CodeActionKind.Source.append('xyz').value)
  • const newKind = CodeActionKind.Notebook.append('source.xyz')

种类/操作示例

  • notebook.source.organizeImports(可能会将所有导入移动到新的顶部单元格)
  • notebook.source.normalizeVariableNames(可能会将所有变量重命名为标准化的 casing 格式)

快速修复操作的基本种类:quickfix

快速修复操作解决代码中的问题,并显示在普通的代码操作上下文菜单中。

重构操作的基本种类:refactor

重构操作显示在重构上下文菜单中。

用于重构提取操作的基本类型:refactor.extract

提取操作示例

  • 提取方法
  • 提取函数
  • 提取变量
  • 从类中提取接口
  • ...

用于重构内联操作的基本类型:refactor.inline

内联操作示例

  • 内联函数
  • 内联变量
  • 内联常量
  • ...

用于重构移动操作的基本类型:refactor.move

移动操作示例

  • 将函数移动到新文件
  • 在类之间移动属性
  • 将方法移动到基类
  • ...

用于重构重写操作的基本类型:refactor.rewrite

重写操作示例

  • 将 JavaScript 函数转换为类
  • 添加或删除参数
  • 封装字段
  • 将方法设为静态
  • ...

用于源操作的基本类型:source

源代码操作应用于整个文件。它们必须被显式请求,并且不会在普通的灯泡菜单中显示。源代码操作可以使用 editor.codeActionsOnSave 在保存时运行,也会在 source 上下文菜单中显示。

用于自动修复源操作的基本类型:source.fixAll

“全部修复”操作会自动修复具有明确修复方案且不需要用户输入的错误。它们不应抑制错误或执行不安全修复,例如生成新的类型或类。

用于组织导入源操作的基本类型:source.organizeImports

构造函数

私有构造函数,使用静态 CodeActionKind.XYZ 从现有的代码操作类型派生。

参数描述
value: string

类型的取值,例如 refactor.extract.function

返回描述
CodeActionKind

属性

类型的字符串值,例如 "refactor.extract.function"

方法

通过将更具体的选择器附加到当前类型来创建新的类型。

不修改当前类型。

参数描述
parts: string
返回描述
CodeActionKind

检查 other 是否为该 CodeActionKind 的子类型。

例如,类型 "refactor.extract" 包含 "refactor.extract""refactor.extract.function",但不包含 "unicorn.refactor.extract""refactor.extractAll"refactor

参数描述
other: CodeActionKind

要检查的类型。

返回描述
布尔值

检查此代码操作类型是否与 other 相交。

例如,类型 "refactor.extract"refactor"refactor.extract""refactor.extract.function" 相交,但不与 "unicorn.refactor.extract""refactor.extractAll" 相交。

参数描述
other: CodeActionKind

要检查的类型。

返回描述
布尔值

CodeActionProvider<T>

为代码提供上下文操作。代码操作通常修复问题或美化/重构代码。

代码操作以几种不同的方式呈现给用户

  • 灯泡功能,它在当前光标位置显示代码操作列表。灯泡的操作列表包括快速修复和重构。
  • 作为用户可以运行的命令,例如 Refactor。用户可以从命令面板或使用快捷键运行这些命令。
  • 作为源操作,例如 Organize Imports
  • 快速修复显示在“问题”视图中。
  • 通过 editor.codeActionsOnSave 设置在保存时应用更改。

方法

获取文档中给定范围的代码操作。

仅返回与请求范围的用户相关的代码操作。还要记住返回的代码操作将如何在 UI 中显示。例如,灯泡小部件和 Refactor 命令将返回的代码操作显示为列表,因此不要返回大量代码操作,以免让用户感到不知所措。

参数描述
document: TextDocument

调用命令的文档。

range: Range | Selection

调用命令的选择器或范围。如果操作是在当前活动的编辑器中请求的,则这始终是一个选择

context: CodeActionContext

提供有关正在请求哪些代码操作的附加信息。您可以使用此信息来查看编辑器正在请求哪种特定类型的代码操作,以便返回更相关的操作,并避免返回编辑器将丢弃的不相关的代码操作。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Array<Command | T>>

代码操作数组,例如快速修复或重构。可以通过返回 undefinednull 或空数组来表示缺少结果。

出于遗留原因,我们也支持返回 Command,但是所有新的扩展都应改为返回 CodeAction 对象。

给定代码操作,填充其 edit 属性。对所有其他属性(例如标题)的更改将被忽略。具有编辑的代码操作将不会被解析。

注意,返回命令而不是代码操作的代码操作提供程序无法成功实现此函数。返回命令已弃用,应改为返回代码操作。

参数描述
codeAction: T

代码操作。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

已解析的代码操作或解析为此操作的 thenable。返回给定的 item 是可以的。当没有返回结果时,将使用给定的 item

CodeActionProviderMetadata

有关 CodeActionProvider 提供的代码操作类型元数据。

属性

代码操作类的静态文档。

如果以下任一情况成立,则会在代码操作菜单中显示提供程序的文档:

  • 编辑器请求了 kind 的代码操作。在这种情况下,编辑器将显示与请求的代码操作类型最匹配的文档。例如,如果提供程序同时具有 RefactorRefactorExtract 的文档,当用户请求 RefactorExtract 的代码操作时,编辑器将使用 RefactorExtract 的文档,而不是 Refactor 的文档。

  • 提供程序返回了 kind 的任何代码操作。

每个提供程序最多显示一个文档条目。

CodeActionProvider 可以返回的 CodeActionKinds 列表。

此列表用于确定是否应调用给定的 CodeActionProvider。为避免不必要的计算,每个 CodeActionProvider 都应列出 providedCodeActionKinds。类型列表可以是通用的,例如 [CodeActionKind.Refactor],也可以列出提供的每个类型,例如 [CodeActionKind.Refactor.Extract.append('function'), CodeActionKind.Refactor.Extract.append('constant'), ...]

CodeActionTriggerKind

请求代码操作的原因。

枚举成员

代码操作是由用户或扩展显式请求的。

代码操作是自动请求的。

这通常在文件中当前选区更改时发生,但也可能在文件内容更改时触发。

代码镜头

代码镜头表示一个 命令,该命令应与源代码文本一起显示,例如引用次数、运行测试的方法等。

当没有命令与之关联时,代码镜头是未解析的。出于性能考虑,代码镜头的创建和解析应分两个阶段完成。

另请参阅

构造函数

创建一个新的代码镜头对象。

参数描述
range: Range

此代码镜头应用到的范围。

command?: Command

与此代码镜头关联的命令。

返回描述
CodeLens

属性

此代码镜头表示的命令。

当有关联的命令时为 true

此代码镜头有效的范围。应仅跨越单行。

CodeLensProvider<T>

代码镜头提供程序将 命令 添加到源代码文本。命令将显示在源代码文本之间的专用水平线上。

事件

一个可选事件,用于发出此提供程序的代码镜头已更改的信号。

方法

计算 镜头 列表。此调用应尽可能快地返回,如果计算命令的成本很高,则实现者应仅返回设置了范围的代码镜头对象,并实现 resolve

参数描述
document: TextDocument

调用命令的文档。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

代码镜头的数组或解析为此数组的 thenable。可以通过返回 undefinednull 或空数组来指示缺少结果。

将为每个可见的代码镜头调用此函数,通常是在滚动时以及调用 compute-lenses 之后。

参数描述
codeLens: T

必须解析的代码镜头。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

给定的、已解析的代码镜头或解析为该镜头的 thenable。

颜色

表示 RGBA 空间中的颜色。

构造函数

创建一个新的颜色实例。

参数描述
red: number

红色分量。

green: number

绿色分量。

blue: number

蓝色分量。

alpha: number

Alpha 分量。

返回描述
颜色

属性

此颜色的 Alpha 分量,范围为 [0-1]

此颜色的蓝色分量,范围为 [0-1]

此颜色的绿色分量,范围为 [0-1]

此颜色的红色分量,范围为 [0-1]

颜色信息

表示文档中的颜色范围。

构造函数

创建一个新的颜色范围。

参数描述
range: Range

颜色出现的范围。不能为 empty。

color: Color

颜色的值。

返回描述
颜色信息

属性

此颜色范围的实际颜色值。

此颜色在文档中出现的范围。

颜色表示

颜色表示对象描述 颜色 应如何表示为文本,以及从源代码引用它需要进行哪些编辑。

对于某些语言,一种颜色可以有多种表示形式,例如,css 可以用常量 Red、十六进制值 #ff0000 或 rgba 和 hsla 形式来表示红色。在 csharp 中,其他表示形式适用,例如 System.Drawing.Color.Red

构造函数

创建一个新的颜色表示。

参数描述
label: string

此颜色表示的标签。

返回描述
颜色表示

属性

在选择此颜色表示时应用的附加 文本编辑 的可选数组。编辑不得与主 edit 或其自身重叠。

此颜色表示的标签。它将显示在颜色选择器标题上。默认情况下,这也是选择此颜色表示时插入的文本。

当选择此颜色的表示时应用于文档的 编辑。当为 falsy 时,使用 label

颜色主题

表示颜色主题。

属性

此颜色主题的种类:浅色、深色、高对比度深色和高对比度浅色。

颜色主题种类

表示颜色主题种类。

枚举成员

浅色颜色主题。

深色颜色主题。

深色高对比度颜色主题。

浅色高对比度颜色主题。

命令

表示对命令的引用。提供一个标题,该标题将用于在 UI 中表示命令,并且可以选择提供一个参数数组,这些参数将在调用时传递给命令处理函数。

属性

应该使用哪些参数来调用命令处理程序。

实际命令处理程序的标识符。

另请参阅 commands.registerCommand

命令的标题,如 save

当在 UI 中表示时,命令的工具提示。

Comment

注释会显示在编辑器或“注释”面板中,具体取决于其提供方式。

属性

注释的作者信息

人类可读的注释正文

注释的上下文值。这可以用于贡献特定于注释的操作。例如,一个注释的上下文值被设置为 editable。当使用 menus 扩展点为 comments/comment/title 贡献操作时,你可以在 when 表达式中为键 comment 指定上下文值,例如 comment == editable

    "contributes": {
        "menus": {
            "comments/comment/title": [
                {
                    "command": "extension.deleteComment",
                    "when": "comment == editable"
                }
            ]
        }
    }

这将仅为 contextValueeditable 的注释显示操作 extension.deleteComment

描述注释的可选标签。如果存在,标签将在 authorName 旁边呈现。

注释的注释模式

注释的可选反应

可选的时间戳,将在注释中显示。日期将根据用户的区域设置和设置进行格式化。

CommentAuthorInformation

注释的作者信息

属性

作者的可选图标路径

注释作者的显示名称

CommentController

注释控制器能够为编辑器提供注释支持,并为用户提供与注释交互的各种方式。

属性

可选的注释范围提供程序。为任何给定的资源 uri 提供支持注释的范围列表。

如果未提供,则用户无法留下任何注释。

此注释控制器的 id。

此注释控制器的人类可读标签。

注释控制器选项

用于在注释上创建和删除反应的可选反应处理程序。

参数描述
comment: Comment
reaction: CommentReaction
返回描述
Thenable<void>

方法

创建注释线程。注释线程将在创建后显示在可见的文本编辑器(如果资源匹配)和“注释”面板中。

参数描述
uri: Uri

在其上创建线程的文档的 uri。

range: Range

注释线程位于文档中的范围。

comments: readonly Comment[]

线程的排序注释。

返回描述
CommentThread

处置此注释控制器。

一旦处置,由此注释控制器创建的所有注释线程也将从编辑器和“注释”面板中删除。

参数描述
返回描述
void

CommentingRangeProvider

注释控制器的注释范围提供程序。

方法

提供允许创建新注释线程的范围列表,或为给定文档提供 null

参数描述
document: TextDocument
token: CancellationToken
返回描述
ProviderResult<Range[]>

CommentMode

注释的注释模式

枚举成员

显示注释编辑器

显示注释的预览

CommentOptions

属性

一个可选的字符串,在注释输入框获得焦点时显示为占位符。

一个可选的字符串,在注释输入框折叠时显示。

CommentReaction

注释的反应

属性

注释的作者是否对此反应做出了反应

对此反应做出反应的用户数

UI 中显示的反应图标。

反应的人类可读标签

CommentReply

comments/commentThread/context 中注册的动作的命令参数。

属性

评论编辑器中的值

活动的评论线程

CommentRule

描述一种语言的评论如何工作。

属性

块注释字符对,例如 /* 块注释 */

行注释标记,例如 // 这是一个注释

CommentThread

评论的集合,表示文档中特定范围内的对话。

属性

该线程是否支持回复。默认为 true。

在打开文档时,线程应该折叠还是展开。默认为折叠。

线程的排序注释。

评论线程的上下文值。这可以用于贡献特定于线程的操作。例如,评论线程被赋予上下文值 editable。当使用 menus 扩展点将操作贡献给 comments/commentThread/title 时,您可以在 when 表达式中为键 commentThread 指定上下文值,例如 commentThread == editable

"contributes": {
  "menus": {
    "comments/commentThread/title": [
      {
        "command": "extension.deleteCommentThread",
        "when": "commentThread == editable"
      }
    ]
  }
}

这将仅对 contextValueeditable 的评论线程显示操作 extension.deleteCommentThread

可选的人类可读标签,描述评论线程

评论线程在文档中的位置范围。线程图标将显示在范围的最后一行。

评论线程的可选状态,可能会影响评论的显示方式。

在其上创建线程的文档的 uri。

方法

释放此评论线程。

一旦释放,此评论线程将从可见编辑器和评论面板中删除(如果适用)。

参数描述
返回描述
void

CommentThreadCollapsibleState

评论线程的折叠状态

枚举成员

确定项是否已折叠

确定项是否已展开

CommentThreadState

评论线程的状态。

枚举成员

未解决的线程状态

已解决的线程状态

CompletionContext

包含有关触发补全提供程序的上下文的其他信息。

属性

触发补全项提供程序的字符。

如果提供程序不是由字符触发的,则为 undefined

触发补全提供程序时,触发字符已在文档中。

补全是如何触发的。

CompletionItem

补全项表示一个文本片段,用于建议补全正在键入的文本。

仅从标签创建补全项就足够了。在这种情况下,补全项将用给定的标签或insertText替换光标之前的单词。否则,将使用给定的编辑

当在编辑器中选择补全项时,其定义或合成的文本编辑将应用于所有光标/选择,而additionalTextEdits将按提供的应用。

另请参阅

构造函数

创建一个新的补全项。

补全项必须至少具有一个标签,然后该标签将用作插入文本,以及用于排序和过滤。

参数描述
label: string | CompletionItemLabel

补全的标签。

kind?: CompletionItemKind

补全的种类

返回描述
CompletionItem

属性

选择此补全时应用的可选的附加文本编辑数组。编辑不能与主编辑或彼此重叠。

插入此补全之后执行的可选命令请注意,对当前文档的附加修改应使用additionalTextEdits属性描述。

一组可选的字符,当在激活此补全时按下这些字符时,将首先接受它,然后键入该字符。请注意,所有提交字符都应具有 length=1,并且多余的字符将被忽略。

一个人类可读的字符串,包含有关此项的附加信息,例如类型或符号信息。

一个人类可读的字符串,表示文档注释。

在过滤一组补全项时应使用的字符串。当为 falsy 时,使用label

请注意,筛选文本是根据由range属性定义的引导词(前缀)匹配的。

一个字符串或代码片段,应在选择此补全时插入到文档中。当为 falsy 时,使用label

保持 insertText 中的空格不变。默认情况下,编辑器会调整新行的前导空格,使其与接受项的行的缩进匹配 - 将此设置为 true 将阻止这种情况发生。

此补全项的种类。编辑器会根据种类选择图标。

此补全项的标签。默认情况下,这也是选择此补全时插入的文本。

显示时选择此项。请注意,只能选择一个补全项,并且编辑器会决定选择哪个项。规则是选择匹配度最高的项中的第一个项。

一个范围或一个插入和替换范围,选择应该被此补全项替换的文本。

省略时,当前单词的范围用作替换范围,而从当前单词的开头到当前位置的范围用作插入范围。

注意 1: 范围必须是单行,并且必须包含请求补全的位置注意 2: 插入范围必须是替换范围的前缀,这意味着它必须被包含并且从相同的位置开始。

当将此项与其他项进行比较时应使用的字符串。当为 falsy 时,将使用标签

请注意,sortText 仅用于补全项的初始排序。当有一个前导词(前缀)时,排序基于补全与该前缀的匹配程度,只有当补全匹配程度相同时才使用初始排序。前缀由 range 属性定义,因此每个补全都可能不同。

此补全项的标签。

  • 已弃用 - 请改用 CompletionItem.insertTextCompletionItem.range

选择此补全时应用于文档的编辑。当提供编辑时,insertText 的值将被忽略。

编辑的 范围 必须是单行的,并且在请求补全的同一行位置上。

CompletionItemKind

补全项的种类。

枚举成员

Text 补全项种类。

Method 补全项种类。

Function 补全项种类。

Constructor 补全项种类。

Field 补全项种类。

Variable 补全项种类。

Class 补全项种类。

Interface 补全项种类。

Module 补全项种类。

Property 补全项种类。

Unit 补全项种类。

Value 补全项种类。

Enum 补全项种类。

Keyword 补全项种类。

Snippet 补全项种类。

Color 补全项种类。

File 补全项种类。

Reference 补全项种类。

Folder 补全项种类。

EnumMember 补全项种类。

Constant 补全项种类。

Struct 补全项种类。

Event 补全项种类。

Operator 补全项种类。

TypeParameter 补全项种类。

User 补全项种类。

Issue 补全项种类。

CompletionItemLabel

补全项的结构化标签。

属性

一个可选的字符串,在 CompletionItemLabel.detail 之后以不太突出的方式呈现。应使用完全限定的名称或文件路径。

一个可选的字符串,在 label 之后立即以不太突出的方式呈现,没有任何空格。应使用函数签名或类型注释。

此补全项的标签。

默认情况下,这也是选择此补全时插入的文本。

CompletionItemProvider<T>

补全项提供程序接口定义了扩展程序和 IntelliSense 之间的约定。

提供程序可以通过实现 resolveCompletionItem 函数来延迟计算 detaildocumentation 属性。但是,初始排序和筛选所需的属性,例如 sortTextfilterTextinsertTextrange,在解析期间不得更改。

在用户显式手势或(取决于配置)在键入单词或触发字符时,会要求提供程序进行补全。

方法

为给定的位置和文档提供补全项。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

context: CompletionContext

补全是如何触发的。

返回描述
ProviderResult<CompletionList<T> | T[]>

补全项数组、补全列表,或一个解析为其中任一类型的 thenable。可以通过返回 undefinednull 或空数组来表示没有结果。

给定一个补全项,填充更多数据,例如文档注释详细信息

编辑器只会解析一个补全项一次。

注意,此函数在补全项已在 UI 中显示或已选择要插入的项时调用。因此,任何会更改展示(标签、排序、过滤等)或(主要)插入行为(insertText)的属性都不能更改。

此函数可以填充additionalTextEdits。但是,这意味着项可能在解析完成之前被插入,在这种情况下,编辑器将尽力仍然应用这些额外的文本编辑。

参数描述
item: T

当前在 UI 中处于活动状态的补全项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

已解析的补全项或一个解析为此项的 thenable。返回给定的 item 是可以的。当未返回结果时,将使用给定的 item

CompletionItemTag

补全项标签是对补全项渲染进行调整的额外注释。

枚举成员

将补全项渲染为已过时,通常使用删除线。

CompletionList<T>

表示要在编辑器中展示的 补全项 的集合。

构造函数

创建一个新的补全列表。

参数描述
items?: T[]

补全项。

isIncomplete?: boolean

列表不完整。

返回描述
CompletionList<T>

属性

此列表不完整。进一步输入应导致重新计算此列表。

补全项。

CompletionTriggerKind

如何触发补全提供程序

枚举成员

补全被正常触发。

补全由触发字符触发。

当当前补全列表不完整时,补全被重新触发

ConfigurationChangeEvent

描述配置更改的事件

方法

检查给定的部分是否已更改。如果提供了作用域,则检查该部分是否在给定作用域下的资源发生了更改。

参数描述
section: string

配置名称,支持点号名称。

scope?: ConfigurationScope

要检查的作用域。

返回描述
布尔值

如果给定的部分已更改,则为true

ConfigurationScope

配置作用域,可以是“资源”或 languageId 或两者,或者 'TextDocument' 或 'WorkspaceFolder'

ConfigurationTarget

配置目标

枚举成员

全局配置

工作区配置

工作区文件夹配置

CustomDocument

表示 CustomEditorProvider 使用的自定义文档。

自定义文档仅在给定的 CustomEditorProvider 中使用。CustomDocument 的生命周期由编辑器管理。当不再有对 CustomDocument 的引用时,它将被释放。

属性

此文档的关联 uri。

方法

释放自定义文档。

当不再有对给定的 CustomDocument 的引用时(例如,当与文档关联的所有编辑器都已关闭时),编辑器会调用此方法。

参数描述
返回描述
void

CustomDocumentBackup

CustomDocument 的备份。

属性

备份的唯一标识符。

当从备份打开自定义编辑器时,此 id 会在 openCustomDocument 中传递回你的扩展。

方法

删除当前备份。

当很明显不再需要当前备份时,编辑器会调用此方法,例如,当创建新备份或保存文件时。

参数描述
返回描述
void

CustomDocumentBackupContext

用于实现 CustomDocumentBackup 的附加信息。

属性

写入新备份的建议文件位置。

请注意,你的扩展可以自由忽略此位置并使用其自己的备份策略。

如果编辑器用于当前工作区中的资源,则 destination 将指向 ExtensionContext.storagePath 内的文件。destination 的父文件夹可能不存在,因此请确保在将备份写入此位置之前创建它。

CustomDocumentContentChangeEvent<T>

扩展触发的事件,向编辑器发出信号,表明 CustomDocument 的内容已更改。

另请参阅 CustomEditorProvider.onDidChangeCustomDocument

属性

更改所针对的文档。

CustomDocumentEditEvent<T>

扩展触发的事件,向编辑器发出信号,表明在 CustomDocument 上发生了编辑。

另请参阅 CustomEditorProvider.onDidChangeCustomDocument

属性

编辑所针对的文档。

描述编辑的显示名称。

这将会在撤销/重做操作的用户界面中显示给用户。

方法

重做编辑操作。

当用户重做此编辑时,编辑器会调用此方法。要实现 redo,你的扩展应将文档和编辑器恢复到通过 onDidChangeCustomDocument 将此编辑添加到编辑器的内部编辑堆栈后它们所处的状态。

参数描述
返回描述
void | Thenable<void>

撤销编辑操作。

当用户撤销此编辑时,编辑器会调用此方法。要实现 undo,你的扩展应将文档和编辑器恢复到通过 onDidChangeCustomDocument 将此编辑添加到编辑器的内部编辑堆栈之前它们所处的状态。

参数描述
返回描述
void | Thenable<void>

CustomDocumentOpenContext

有关打开自定义文档的其他信息。

属性

用于恢复文档的备份 ID,如果没有备份,则为 undefined

如果提供了此项,你的扩展应从备份中恢复编辑器,而不是从用户工作区读取文件。

如果 URI 是未命名文件,则此项将填充该文件的字节数据

如果提供了此项,你的扩展应使用此字节数据,而不是对传入的 URI 执行 fs API

CustomEditorProvider<T>

使用自定义文档模型的、可编辑的自定义编辑器的提供程序。

自定义编辑器使用 CustomDocument 作为其文档模型,而不是 TextDocument。 这使得扩展可以完全控制编辑、保存和备份等操作。

在处理二进制文件或更复杂的场景时,应使用此类型的自定义编辑器。对于简单的基于文本的文档,请改用 CustomTextEditorProvider

事件

发出自定义编辑器内发生编辑的信号。

每当自定义编辑器中发生编辑时,你的扩展都必须触发此事件。编辑可以是从更改某些文本到裁剪图像再到重新排序列表的任何操作。你的扩展可以自由定义什么是编辑以及每个编辑上存储了哪些数据。

触发 onDidChange 会将编辑器标记为已更改。当用户保存或还原文件时,此标记将被清除。

支持撤销/重做的编辑器必须在发生编辑时触发 CustomDocumentEditEvent。 这允许用户使用编辑器的标准键盘快捷键撤销和重做编辑。如果用户撤销对上次保存状态的所有编辑,编辑器还将编辑器标记为不再更改。

支持编辑但不能使用编辑器的标准撤销/重做机制的编辑器必须触发 CustomDocumentContentChangeEvent。用户清除不支持撤销/重做的编辑器的更改状态的唯一方法是 saverevert 文件。

编辑器应该只触发 CustomDocumentEditEvent 事件,或者只触发 CustomDocumentContentChangeEvent 事件。

方法

备份已更改的自定义文档。

备份用于热退出并防止数据丢失。你的 backup 方法应将其当前状态(即已应用编辑)下的资源持久化。最常见的情况是将资源保存到 ExtensionContext.storagePath 中的磁盘。当编辑器重新加载并且为资源打开你的自定义编辑器时,你的扩展应首先检查该资源是否存在任何备份。如果有备份,你的扩展应从那里加载文件内容,而不是从工作区中的资源加载。

在用户停止编辑文档大约一秒钟后,将触发 backup。如果用户快速编辑文档,则只有在编辑停止后才会调用 backup

启用 auto save 时不会调用 backup(因为自动保存已经持久保存资源)。

参数描述
document: T

要备份的文档。

context: CustomDocumentBackupContext

可用于备份文档的信息。

cancellation: CancellationToken

指示当前备份的标记,因为新的备份即将到来。你的扩展程序可以决定如何响应取消。例如,如果你的扩展程序正在备份一个大型文件,该操作需要时间才能完成,则你的扩展程序可能会决定完成正在进行的备份,而不是取消该备份,以确保编辑器具有某些有效的备份。

返回描述
Thenable<CustomDocumentBackup>

为给定资源创建新的文档。

第一次打开给定资源的编辑器时,将调用 openCustomDocument。然后,打开的文档将传递到 resolveCustomEditor,以便可以将编辑器显示给用户。

如果用户打开其他编辑器,则会重复使用已打开的 CustomDocument。当关闭给定资源的所有编辑器时,将处理掉 CustomDocument。此时打开编辑器将触发对 openCustomDocument 的另一次调用。

参数描述
uri: Uri

要打开的文档的 URI。

openContext: CustomDocumentOpenContext

有关打开自定义文档的其他信息。

token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
T | Thenable<T>

自定义文档。

为给定的资源解析自定义编辑器。

每当用户为此 CustomEditorProvider 打开新编辑器时,都会调用此方法。

参数描述
document: T

要解析的资源的文档。

webviewPanel: WebviewPanel

用于为此资源显示编辑器 UI 的 webview 面板。

在解析期间,提供程序必须填充内容 webview 面板的初始 html,并挂钩其感兴趣的所有事件侦听器。 提供程序还可以保留 WebviewPanel 以供以后在命令中使用。 有关其他详细信息,请参阅 WebviewPanel

token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
void | Thenable<void>

可选的 thenable,指示已解析自定义编辑器。

将自定义文档还原到其上次保存的状态。

当用户在自定义编辑器中触发 File: Revert File 时,编辑器会调用此方法。(请注意,这仅在使用编辑器的 File: Revert File 命令时使用,而不适用于文件的 git revert)。

要实现 revert,实现者必须确保 document 的所有编辑器实例(webview)都以保存状态显示文档。这通常意味着从工作区重新加载文件。

参数描述
document: T

要还原的文档。

cancellation: CancellationToken

表示不再需要回滚的标记。

返回描述
Thenable<void>

表示更改已完成的 Thenable。

保存自定义文档。

当用户保存自定义编辑器时,编辑器会调用此方法。 这可能发生在用户在自定义编辑器处于活动状态时触发保存,通过诸如 全部保存 之类的命令,或者在启用自动保存时发生。

要实现 save,实现者必须持久化自定义编辑器。 这通常意味着将自定义文档的文件数据写入磁盘。在 save 完成后,任何关联的编辑器实例都将不再标记为脏。

参数描述
document: T

要保存的文档。

cancellation: CancellationToken

表示不再需要保存的标记(例如,如果触发了另一次保存)。

返回描述
Thenable<void>

表示保存已完成的 Thenable。

将自定义文档保存到不同的位置。

当用户在自定义编辑器上触发“另存为”时,编辑器会调用此方法。实现者必须将自定义编辑器持久化到 destination

当用户接受另存为时,当前编辑器将被新保存的文件的非脏编辑器替换。

参数描述
document: T

要保存的文档。

destination: Uri

要保存到的位置。

cancellation: CancellationToken

表示不再需要保存的标记。

返回描述
Thenable<void>

表示保存已完成的 Thenable。

CustomExecution

用于将扩展回调作为任务执行的类。

构造函数

构造一个 CustomExecution 任务对象。当任务运行时,将执行回调,此时扩展应返回它将“运行在其中”的 Pseudoterminal。在调用 Pseudoterminal.open 之前,任务应等待执行进一步的操作。应使用 Pseudoterminal.close 处理任务取消。当任务完成时,触发 Pseudoterminal.onDidClose

参数描述
callback: (resolvedDefinition: TaskDefinition) => Thenable<Pseudoterminal>

当用户启动任务时将调用的回调。任务定义中的任何 ${} 样式变量都将被解析,并作为 resolvedDefinition 传递给回调。

返回描述
CustomExecution

CustomReadonlyEditorProvider<T>

用于使用自定义文档模型的只读自定义编辑器的提供程序。

自定义编辑器使用 CustomDocument 作为其文档模型,而不是 TextDocument

在处理二进制文件或更复杂的场景时,应使用此类型的自定义编辑器。对于简单的基于文本的文档,请改用 CustomTextEditorProvider

方法

为给定资源创建新的文档。

第一次打开给定资源的编辑器时,将调用 openCustomDocument。然后,打开的文档将传递到 resolveCustomEditor,以便可以将编辑器显示给用户。

如果用户打开其他编辑器,则会重复使用已打开的 CustomDocument。当关闭给定资源的所有编辑器时,将处理掉 CustomDocument。此时打开编辑器将触发对 openCustomDocument 的另一次调用。

参数描述
uri: Uri

要打开的文档的 URI。

openContext: CustomDocumentOpenContext

有关打开自定义文档的其他信息。

token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
T | Thenable<T>

自定义文档。

为给定的资源解析自定义编辑器。

每当用户为此 CustomEditorProvider 打开新编辑器时,都会调用此方法。

参数描述
document: T

要解析的资源的文档。

webviewPanel: WebviewPanel

用于为此资源显示编辑器 UI 的 webview 面板。

在解析期间,提供程序必须填充内容 webview 面板的初始 html,并挂钩其感兴趣的所有事件侦听器。 提供程序还可以保留 WebviewPanel 以供以后在命令中使用。 有关其他详细信息,请参阅 WebviewPanel

token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
void | Thenable<void>

可选的 thenable,指示已解析自定义编辑器。

CustomTextEditorProvider

基于文本的自定义编辑器的提供程序。

基于文本的自定义编辑器使用 TextDocument 作为其数据模型。 这大大简化了自定义编辑器的实现,因为它允许编辑器处理许多常见操作,如撤消和备份。 提供程序负责在 Webview 和 TextDocument 之间同步文本更改。

方法

为给定的文本资源解析自定义编辑器。

当用户首次打开 CustomTextEditorProvider 的资源时,或者如果他们使用此 CustomTextEditorProvider 重新打开现有编辑器时,将调用此方法。

参数描述
document: TextDocument

要解析的资源的文档。

webviewPanel: WebviewPanel

用于为此资源显示编辑器 UI 的 webview 面板。

在解析期间,提供程序必须填充内容 webview 面板的初始 html,并挂钩其感兴趣的所有事件侦听器。 提供程序还可以保留 WebviewPanel 以供以后在命令中使用。 有关其他详细信息,请参阅 WebviewPanel

token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
void | Thenable<void>

表示自定义编辑器已解析的 Thenable。

DataTransfer

一个映射,其中包含相应传输数据的 MIME 类型映射。

实现 handleDrag 的拖放控制器可以将其他 MIME 类型添加到数据传输中。 当拖动是从同一拖放控制器中的元素发起时,这些额外的 MIME 类型只会包含在 handleDrop 中。

构造函数

参数描述
返回描述
DataTransfer

方法

获取一个新的迭代器,其中包含此数据传输中每个元素的 [mime, item] 对。

参数描述
返回描述
IterableIterator<[mimeType: string, item: DataTransferItem]>

允许遍历数据传输项。

参数描述
callbackfn: (item: DataTransferItem, mimeType: string, dataTransfer: DataTransfer) => void

遍历数据传输项的回调。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
void

检索给定 MIME 类型的数据传输项。

参数描述
mimeType: string

要获取数据传输项的 MIME 类型,例如 text/plainimage/png。MIME 类型查找不区分大小写。

特殊 MIME 类型

  • text/uri-list — 一个字符串,其中包含由 \r\n 分隔的 toString() ed Uri。 要在文件中指定光标位置,请将 Uri 的片段设置为 L3,5,其中 3 是行号,5 是列号。
返回描述
DataTransferItem

设置 MIME 类型到数据传输项的映射。

参数描述
mimeType: string

要设置数据的 MIME 类型。MIME 类型以小写形式存储,查找不区分大小写。

value: DataTransferItem

给定 MIME 类型的数据传输项。

返回描述
void

DataTransferFile

DataTransferItem 关联的文件。

此类型的实例只能由编辑器创建,而不能由扩展创建。

属性

文件的名称。

文件的完整文件路径。

在 Web 上可能为 undefined

方法

文件的完整文件内容。

参数描述
返回描述
Thenable<Uint8Array>

DataTransferItem

封装在拖放操作期间传输的数据。

构造函数

参数描述
value: any

此项存储的自定义数据。可以使用 DataTransferItem.value 来检索。

返回描述
DataTransferItem

属性

此项存储的自定义数据。

您可以使用 value 在操作之间共享数据。只要创建 DataTransferItem 的扩展在同一扩展主机中运行,就可以检索到原始对象。

方法

尝试获取与此数据传输项关联的文件

请注意,文件对象仅在拖放操作的范围内有效。

参数描述
返回描述
DataTransferFile

数据传输的文件,如果该项不是文件或无法访问文件数据,则为 undefined

获取此项的字符串表示形式。

如果 DataTransferItem.value 是一个对象,则这将返回 JSON 字符串化的 DataTransferItem.value 值的结果。

参数描述
返回描述
Thenable<string>

DebugAdapter

如果实现了 DebugAdapter 接口,则可以将实现调试适配器协议的调试适配器注册到编辑器。

事件

调试适配器向编辑器发送调试适配器协议消息后触发的事件。消息可以是请求、响应或事件。

方法

释放此对象。

参数描述
返回描述
any

处理调试适配器协议消息。消息可以是请求、响应或事件。结果或错误通过 onSendMessage 事件返回。

参数描述
message: DebugProtocolMessage

调试适配器协议消息

返回描述
void

DebugAdapterDescriptor

表示不同类型的调试适配器

DebugAdapterDescriptorFactory

一个调试适配器工厂,用于创建 调试适配器描述符

方法

在调试会话开始时调用 'createDebugAdapterDescriptor',以提供有关要使用的调试适配器的详细信息。这些详细信息必须作为 DebugAdapterDescriptor 类型的对象返回。当前支持两种类型的调试适配器

  • 调试适配器可执行文件被指定为命令路径和参数(请参阅 DebugAdapterExecutable),
  • 可通过通信端口访问的调试适配器服务器(请参阅 DebugAdapterServer)。如果未实现该方法,则默认行为如下:createDebugAdapter(session: DebugSession, executable: DebugAdapterExecutable) { if (typeof session.configuration.debugServer === 'number') { return new DebugAdapterServer(session.configuration.debugServer); } return executable; }
参数描述
session: DebugSession

要使用调试适配器的 调试会话

executable: DebugAdapterExecutable

package.json 中指定的调试适配器的可执行文件信息(如果不存在此类信息,则为 undefined)。

返回描述
ProviderResult<DebugAdapterDescriptor>

调试适配器描述符或 undefined。

DebugAdapterExecutable

表示调试适配器可执行文件以及传递给它的可选参数和运行时选项。

构造函数

基于可执行程序创建调试适配器的描述。

参数描述
command: string

实现调试适配器的命令或可执行文件路径。

args?: string[]

要传递给命令或可执行文件的可选参数。

options?: DebugAdapterExecutableOptions

启动命令或可执行文件时要使用的可选选项。

返回描述
DebugAdapterExecutable

属性

传递给调试适配器可执行文件的参数。默认为空数组。

调试适配器可执行文件的命令或路径。命令必须是可执行文件的绝对路径,或者是要通过 PATH 环境变量查找的命令的名称。特殊值“node”将映射到编辑器的内置 Node.js 运行时。

启动调试适配器时要使用的可选选项。默认为 undefined。

DebugAdapterExecutableOptions

调试适配器可执行文件的选项。

属性

执行的调试适配器的当前工作目录。

执行的程序或 shell 的附加环境。如果省略,则使用父进程的环境。如果提供,则将其与父进程的环境合并。

DebugAdapterInlineImplementation

内联实现的调试适配器描述符。

构造函数

创建调试适配器内联实现的描述符。

参数描述
implementation: DebugAdapter
返回描述
DebugAdapterInlineImplementation

DebugAdapterNamedPipeServer

表示作为基于命名管道(在 Windows 上)/UNIX 域套接字(在非 Windows 上)的服务器运行的调试适配器。

构造函数

创建作为基于命名管道(在 Windows 上)/UNIX 域套接字(在非 Windows 上)的服务器运行的调试适配器的描述。

参数描述
path: string
返回描述
DebugAdapterNamedPipeServer

属性

命名管道/UNIX 域套接字的路径。

DebugAdapterServer

表示作为基于套接字的服务器运行的调试适配器。

构造函数

创建作为基于套接字的服务器运行的调试适配器的描述。

参数描述
port: number
host?: string
返回描述
DebugAdapterServer

属性

主机。

端口。

DebugAdapterTracker

调试适配器跟踪器是一种跟踪编辑器和调试适配器之间通信的方法。

事件

调试适配器已向编辑器发送调试适配器协议消息。

参数描述
message: any
返回描述
void

调试适配器即将从编辑器接收调试适配器协议消息。

参数描述
message: any
返回描述
void

即将启动与调试适配器的会话。

参数描述
返回描述
void

调试适配器会话即将停止。

参数描述
返回描述
void

方法

调试适配器发生错误。

参数描述
error: Error
返回描述
void

调试适配器已退出,并带有给定的退出代码或信号。

参数描述
code: number
signal: string
返回描述
void

DebugAdapterTrackerFactory

一个调试适配器工厂,用于创建 调试适配器跟踪器

方法

在调试会话开始时调用 'createDebugAdapterTracker' 方法,以返回一个“跟踪器”对象,该对象提供对编辑器和调试适配器之间通信的读取访问权限。

参数描述
session: DebugSession

将使用调试适配器跟踪器的 调试会话

返回描述
ProviderResult<DebugAdapterTracker>

一个 调试适配器跟踪器 或 undefined。

DebugConfiguration

调试会话的配置。

属性

调试会话的名称。

调试会话的请求类型。

调试会话的类型。

DebugConfigurationProvider

调试配置提供程序允许向调试服务添加调试配置,并在调试会话开始之前解析启动配置。 调试配置提供程序通过 debug.registerDebugConfigurationProvider 注册。

方法

向调试服务提供 调试配置。 如果为同一类型注册了多个调试配置提供程序,则调试配置会以任意顺序连接。

参数描述
folder: WorkspaceFolder

使用配置的工作区文件夹,或者对于无文件夹设置,则为 undefined

token?: CancellationToken

取消令牌。

返回描述
ProviderResult<DebugConfiguration[]>

调试配置 的数组。

通过填充缺少的值或添加/更改/删除属性来解析 调试配置。 如果为同一类型注册了多个调试配置提供程序,则 resolveDebugConfiguration 调用会以任意顺序链接,并且初始调试配置会通过该链传递。 返回值 'undefined' 会阻止调试会话启动。 返回值 'null' 会阻止调试会话启动,并打开基础调试配置。

参数描述
folder: WorkspaceFolder

配置的源工作区文件夹,对于无文件夹设置,则为 undefined

debugConfiguration: DebugConfiguration

要解析的 调试配置

token?: CancellationToken

取消令牌。

返回描述
ProviderResult<DebugConfiguration>

解析的调试配置或 undefined 或 null。

此钩子在 'resolveDebugConfiguration' 之后直接调用,但所有变量都已替换。 它可以通过填充缺少的值或添加/更改/删除属性来解析或验证 调试配置。 如果为同一类型注册了多个调试配置提供程序,则 'resolveDebugConfigurationWithSubstitutedVariables' 调用会以任意顺序链接,并且初始调试配置会通过该链传递。 返回值 'undefined' 会阻止调试会话启动。 返回值 'null' 会阻止调试会话启动,并打开基础调试配置。

参数描述
folder: WorkspaceFolder

配置的源工作区文件夹,对于无文件夹设置,则为 undefined

debugConfiguration: DebugConfiguration

要解析的 调试配置

token?: CancellationToken

取消令牌。

返回描述
ProviderResult<DebugConfiguration>

解析的调试配置或 undefined 或 null。

DebugConfigurationProviderTriggerKind

DebugConfigurationProviderTriggerKind 指定何时触发 DebugConfigurationProviderprovideDebugConfigurations 方法。 目前有两种情况:为新创建的 launch.json 提供初始调试配置,或在用户通过 UI 请求(例如,通过“选择并开始调试”命令)时提供动态生成的调试配置。 在使用 debug.registerDebugConfigurationProvider 注册 DebugConfigurationProvider 时,会使用触发器类型。

枚举成员

调用 DebugConfigurationProvider.provideDebugConfigurations 以便为新创建的 launch.json 提供初始调试配置。

当用户通过 UI 请求时(例如,通过“选择并开始调试”命令),调用 DebugConfigurationProvider.provideDebugConfigurations 以提供动态生成的调试配置。

DebugConsole

表示调试控制台。

方法

将给定的值附加到调试控制台。

参数描述
value: string

字符串,虚值将不会打印。

返回描述
void

将给定的值和一个换行符附加到调试控制台。

参数描述
value: string

字符串,虚值将被打印。

返回描述
void

DebugConsoleMode

调试会话使用的调试控制台模式,请参阅 选项

枚举成员

调试会话应具有单独的调试控制台。

调试会话应与其父会话共享调试控制台。 此值对于没有父会话的会话不起作用。

DebugProtocolBreakpoint

DebugProtocolBreakpoint 是 调试适配器协议中定义的 断点类型的不可见占位符类型。

DebugProtocolMessage

DebugProtocolMessage 是 调试适配器协议中定义的 ProtocolMessage 类型的不可见占位符类型。

DebugProtocolSource

DebugProtocolSource 是 调试适配器协议中定义的 类型的不可见占位符类型。

DebugSession

调试会话。

属性

此会话的“已解析”调试配置。“已解析”意味着

  • 已替换所有变量,并且
  • 特定于平台的属性部分已针对匹配的平台“展平”,并已针对不匹配的平台删除。

此调试会话的唯一 ID。

调试会话的名称最初取自 调试配置。 任何更改都将在 UI 中正确反映。

此调试会话的父会话(如果它是作为子项创建的)。

另请参阅 DebugSessionOptions.parentSession

调试会话的类型,来自 调试配置

此会话的工作区文件夹,对于无文件夹设置,则为 undefined

方法

向调试适配器发送自定义请求。

参数描述
command: string
args?: any
返回描述
Thenable<any>

将编辑器中的断点映射到相应的调试适配器协议 (DAP) 断点,该断点由调试会话的调试适配器管理。如果不存在 DAP 断点(要么是因为编辑器断点尚未注册,要么是因为调试适配器对该断点不感兴趣),则返回 undefined 值。

参数描述
breakpoint: Breakpoint

编辑器中的 Breakpoint

返回描述
Thenable<DebugProtocolBreakpoint>

一个 Promise,它解析为调试适配器协议断点或 undefined

DebugSessionCustomEvent

调试会话接收的自定义调试适配器协议事件。

属性

事件特定信息。

事件类型。

接收到自定义事件的 调试会话

DebugSessionOptions

启动调试会话的选项。

属性

控制是否在“调用堆栈”视图中显示调试会话的父会话,即使它只有一个子会话。默认情况下,调试会话永远不会隐藏其父会话。如果 compact 为 true,则在“调用堆栈”视图中隐藏具有单个子项的调试会话,以使树更紧凑。

控制此会话是否应具有单独的调试控制台或与父会话共享它。对于没有父会话的会话不起作用。默认为“单独”。

控制是否将诸如“重新启动”之类的生命周期请求发送到新创建的会话或其父会话。默认情况下(如果该属性为 false 或缺失),生命周期请求将发送到新会话。如果该会话没有父会话,则忽略此属性。

控制此会话是否应在不调试的情况下运行,从而忽略断点。如果未指定此属性,则使用父会话中的值(如果有)。

指定后,新创建的调试会话将注册为此“父”调试会话的“子”会话。

如果为 true,则此会话不会更改窗口状态栏颜色。

如果为 true,则此会话不会显示调试工具栏。

如果为 true,则此会话不会自动显示调试视图。

如果为 true,则启动调试会话时,不会为打开的编辑器触发保存,而不管 debug.saveBeforeStart 设置的值如何。

向编辑器发出信号,表明调试会话是从测试运行请求启动的。这用于链接调试会话的生命周期和 UI 操作中的测试运行。

DebugStackFrame

表示调试会话中的堆栈帧。

属性

调试协议中堆栈帧的 ID。

线程的调试会话。

调试协议中关联线程的 ID。

DebugThread

表示调试会话中的线程。

属性

线程的调试会话。

调试协议中关联线程的 ID。

Declaration

符号声明表示为一个或多个 位置位置链接

DeclarationCoverage

包含声明的覆盖率信息。根据报告器和语言,这可能是函数、方法或命名空间等类型。

构造函数

参数描述
name: string
executed: number | boolean

此声明执行的次数,或一个布尔值,指示是否在不知道确切计数的情况下执行了该声明。如果为零或 false,则该声明将被标记为未覆盖。

location: Range | Position

声明位置。

返回描述
DeclarationCoverage

属性

此声明执行的次数,或一个布尔值,指示是否在不知道确切计数的情况下执行了该声明。如果为零或 false,则该声明将被标记为未覆盖。

声明位置。

声明的名称。

DeclarationProvider

声明提供程序接口定义了扩展与转到声明功能之间的协定。

方法

提供给定位置和文档处符号的声明。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Declaration>

声明或解析为声明的 thenable。可以通过返回 undefinednull 来表示缺少结果。

DecorationInstanceRenderOptions

表示装饰实例的渲染选项。请参阅 DecorationOptions.renderOptions

属性

定义插入到装饰文本之后的附件的渲染选项。

定义插入到装饰文本之前的附件的渲染选项。

深色主题的覆盖选项。

浅色主题的覆盖选项。

DecorationOptions

表示装饰集中特定装饰的选项。

属性

当悬停在装饰上时应呈现的消息。

应用此装饰的范围。范围不能为空。

应用于当前装饰的渲染选项。出于性能原因,请保持装饰特定选项的数量较少,并尽可能使用装饰类型。

DecorationRangeBehavior

描述在边缘进行键入/编辑时装饰的行为。

枚举成员

当在开始或结束位置发生编辑时,装饰的范围将扩大。

当在开始或结束位置发生编辑时,装饰的范围不会扩大。

当在开始位置发生编辑时,装饰的范围将扩大,但在结束位置不会扩大。

当在结束位置发生编辑时,装饰的范围将扩大,但在开始位置不会扩大。

DecorationRenderOptions

表示文本编辑器装饰的渲染样式。

属性

定义插入到装饰文本之后的附件的渲染选项。

装饰的背景颜色。使用 rgba() 并定义透明背景颜色以与其他装饰良好配合。或者,可以引用颜色注册表中的颜色。

定义插入到装饰文本之前的附件的渲染选项。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

深色主题的覆盖选项。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

要在装订线中呈现的图像的绝对路径或 URI。

指定装订线图标的大小。可用值包括“auto”、“contain”、“cover”和任何百分比值。有关详细信息:https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx

装饰是否也应在行文本之后的空格上呈现。默认为 false

将应用于装饰所包围的文本的 CSS 样式属性。

浅色主题的覆盖选项。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

概览标尺中装饰的颜色。使用 rgba() 并定义透明颜色以与其他装饰良好配合。

应在概览标尺中呈现装饰的位置。

自定义当在装饰范围的边缘发生编辑时装饰的增长行为。默认为 DecorationRangeBehavior.OpenOpen

将应用于装饰所包围的文本的 CSS 样式属性。

Definition

符号的定义表示为一个或多个位置。对于大多数编程语言,符号只有一个定义位置。

有关符号定义位置的信息。

在普通的位置定义之上提供额外的元数据,包括定义符号的范围

DefinitionProvider

定义提供程序接口定义了扩展和转到定义和查看定义功能之间的协定。

方法

提供给定位置和文档中符号的定义。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Definition | LocationLink[]>

一个定义,或一个可以解析为该定义的 Promise。 返回 undefinednull 可以表示没有结果。

Diagnostic

表示一个诊断信息,例如编译器错误或警告。诊断对象仅在文件范围内有效。

构造函数

创建一个新的诊断对象。

参数描述
range: Range

此诊断信息所应用的范围。

message: string

人类可读的消息。

severity?: DiagnosticSeverity

严重程度,默认为 error

返回描述
Diagnostic

属性

此诊断信息的代码或标识符。应在后续处理中使用,例如提供 代码操作 时。

人类可读的消息。

此诊断信息所应用的范围。

相关诊断信息的数组,例如,当作用域内的符号名称冲突时,可以通过此属性标记所有定义。

严重程度,默认为 error

描述此诊断信息来源的人类可读字符串,例如“typescript”或“super lint”。

关于诊断信息的其他元数据。

DiagnosticChangeEvent

当诊断信息更改时触发的事件。

属性

诊断信息已更改的资源的数组。

DiagnosticCollection

诊断集合是一个管理一组 诊断信息 的容器。诊断信息始终限定于诊断集合和资源。

要获取 DiagnosticCollection 的实例,请使用 createDiagnosticCollection

属性

此诊断集合的名称,例如 typescript。来自此集合的每个诊断信息都将与此名称相关联。此外,任务框架在定义 问题匹配器 时使用此名称。

方法

从此集合中删除所有诊断信息。与调用 #set(undefined) 相同;

参数描述
返回描述
void

从此集合中删除属于提供的 uri 的所有诊断信息。与 #set(uri, undefined) 相同。

参数描述
uri: Uri

资源标识符。

返回描述
void

释放并释放相关资源。调用 clear

参数描述
返回描述
void

迭代此集合中的每个条目。

参数描述
callback: (uri: Uri, diagnostics: readonly Diagnostic[], collection: DiagnosticCollection) => any

为每个条目执行的函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
void

获取给定资源的诊断信息。注意,您不能修改从此调用返回的诊断信息数组。

参数描述
uri: Uri

资源标识符。

返回描述
readonly Diagnostic[]

一个不可变的 诊断信息 数组或 undefined

检查此集合是否包含给定资源的诊断信息。

参数描述
uri: Uri

资源标识符。

返回描述
布尔值

如果此集合具有给定资源的诊断信息,则返回 true

为给定资源分配诊断信息。将替换该资源的现有诊断信息。

参数描述
uri: Uri

资源标识符。

diagnostics: readonly Diagnostic[]

诊断信息数组或 undefined

返回描述
void

替换此集合中多个资源的诊断信息。

注意,同一个 URI 的多个元组将被合并,例如 [[file1, [d1]], [file1, [d2]]] 等效于 [[file1, [d1, d2]]]。 如果诊断信息项为 undefined,如 [file1, undefined] 中所示,则会删除所有之前的诊断信息,但不删除后续的诊断信息。

参数描述
entries: ReadonlyArray<[Uri, readonly Diagnostic[]]>

元组数组,例如 [[file1, [d1, d2]], [file2, [d3, d4, d5]]]undefined

返回描述
void

DiagnosticRelatedInformation

表示诊断信息的相关消息和源代码位置。这应该用于指向导致诊断信息或与之相关的代码位置,例如,在作用域中复制符号时。

构造函数

创建一个新的相关诊断信息对象。

参数描述
location: Location

位置。

message: string

消息。

返回描述
DiagnosticRelatedInformation

属性

此相关诊断信息的位置。

此相关诊断信息的消息。

DiagnosticSeverity

表示诊断信息的严重程度。

枚举成员

语言或其他方式的规则不允许的内容。

可疑但允许的内容。

要告知的内容,但不是问题。

提示更好的做法,例如建议重构。

DiagnosticTag

关于诊断信息类型的其他元数据。

枚举成员

未使用或不必要的代码。

带有此标签的诊断信息会以淡出的方式呈现。淡出的程度由 "editorUnnecessaryCode.opacity" 主题颜色控制。例如,"editorUnnecessaryCode.opacity": "#000000c0" 将以 75% 的不透明度渲染代码。对于高对比度主题,请使用 "editorUnnecessaryCode.border" 主题颜色来为不必要的代码添加下划线,而不是淡出显示。

已弃用或过时的代码。

带有此标签的诊断信息会以删除线的方式呈现。

Disposable

表示可以释放资源(例如事件侦听或计时器)的类型。

静态

将多个类似 disposable 的对象合并为一个。当拥有具有 dispose 函数但不是 Disposable 实例的对象时,可以使用此方法。

参数描述
...disposableLikes: Array<{dispose: () => any}>

具有至少一个 dispose 函数成员的对象。请注意,异步 dispose 函数不会被等待。

返回描述
Disposable

返回一个新的 disposable,该 disposable 在 dispose 时将 dispose 所有提供的 disposables。

构造函数

创建一个新的 disposable,该 disposable 在 dispose 时调用提供的函数。

注意,异步函数不会被等待。

参数描述
callOnDispose: () => any

用于释放某些内容的函数。

返回描述
Disposable

方法

释放此对象。

参数描述
返回描述
any

DocumentColorProvider

文档颜色提供程序定义了扩展与编辑器中选取和修改颜色功能之间的约定。

方法

为颜色提供 表示

参数描述
color: Color

要显示和插入的颜色。

context: {document: TextDocument, range: Range}

包含附加信息的上下文对象

token: CancellationToken

取消令牌。

返回描述
ProviderResult<ColorPresentation[]>

颜色表示形式的数组,或可解析为此数组的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

为给定的文档提供颜色。

参数描述
document: TextDocument

调用命令的文档。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<ColorInformation[]>

一个 颜色信息 数组,或可解析为此数组的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

DocumentDropEdit

drop 操作 时应用的编辑操作。

构造函数

参数描述
insertText: string | SnippetString

要在 drop 位置插入的文本或代码片段。

返回描述
DocumentDropEdit

属性

要在 drop 时应用的 optional 附加编辑。

要在 drop 位置插入的文本或代码片段。

DocumentDropEditProvider

处理将资源拖放到文本编辑器的提供程序。

这允许用户将资源(包括来自外部应用程序的资源)拖放到编辑器中。在拖放文件时,用户可以按住 shift 键将文件拖放到编辑器中,而不是打开它。需要启用 editor.dropIntoEditor.enabled

方法

提供将拖放内容插入文档的编辑。

参数描述
document: TextDocument

发生 drop 操作的文档。

position: Position

文档中发生 drop 操作的位置。

dataTransfer: DataTransfer

一个 DataTransfer 对象,其中包含有关正在拖放内容的数据。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<DocumentDropEdit>

一个 DocumentDropEdit 或可解析为此对象的 thenable。可以通过返回 undefinednull 来表示缺少结果。

DocumentFilter

文档过滤器通过不同的属性(如 语言、资源的 scheme 或应用于 路径 的 glob 模式)来表示文档。

示例 一个适用于磁盘上 typescript 文件的语言过滤器

{ language: 'typescript', scheme: 'file' }

示例 一个适用于所有 package.json 路径的语言过滤器

{ language: 'json', pattern: '**/package.json' }

属性

一个语言 ID,例如 typescript

笔记本的 类型,例如 jupyter-notebook。这允许缩小 单元格文档 所属的笔记本类型。

注意,设置 notebookType 属性会更改 schemepattern 的解释方式。设置后,它们将针对 笔记本 URI 进行评估,而不是文档 URI。

示例 匹配 Jupyter 笔记本中尚未存储的 (untitled) Python 文档

{ language: 'python', notebookType: 'jupyter-notebook', scheme: 'untitled' }

一个 glob 模式,它与文档的绝对路径匹配。使用 相对模式 将文档过滤到 工作区文件夹

一个 Uri scheme,例如 fileuntitled

DocumentFormattingEditProvider

文档格式设置提供程序接口定义了扩展与格式设置功能之间的约定。

方法

为整个文档提供格式设置编辑。

参数描述
document: TextDocument

调用命令的文档。

options: FormattingOptions

控制格式设置的选项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或可解析为此的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

DocumentHighlight

文档高亮是文本文档中值得特别关注的范围。通常,文档高亮通过更改其范围的背景颜色来可视化。

构造函数

创建一个新的文档高亮对象。

参数描述
range: Range

高亮应用的范围。

kind?: DocumentHighlightKind

高亮的种类,默认为 text

返回描述
DocumentHighlight

属性

高亮的种类,默认为 text

此高亮应用的范围。

DocumentHighlightKind

文档高亮的种类。

枚举成员

文本出现。

符号的读取访问,例如读取变量。

符号的写入访问,例如写入变量。

DocumentHighlightProvider

文档高亮提供程序接口定义了扩展和单词高亮功能之间的约定。

方法

提供一组文档高亮,例如变量的所有出现或函数的所有退出点。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<DocumentHighlight[]>

文档高亮的数组或解析为此的 thenable。缺少结果可以通过返回 undefinednull 或空数组来表示。

文档链接是文本文档中链接到内部或外部资源(例如另一个文本文档或网站)的范围。

构造函数

创建一个新的文档链接。

参数描述
range: Range

文档链接应用的范围。不能为空。

target?: Uri

文档链接指向的 URI。

返回描述
DocumentLink

属性

此链接应用的范围。

此链接指向的 URI。

鼠标悬停在此链接上时显示的工具提示文本。

如果提供了工具提示,它将显示在一个包含如何触发链接的说明的字符串中,例如 {0} (ctrl + click)。具体说明因操作系统、用户设置和本地化而异。

DocumentLinkProvider<T>

文档链接提供程序定义了扩展和在编辑器中显示链接的功能之间的约定。

方法

为给定文档提供链接。请注意,编辑器附带一个默认提供程序,可检测 http(s)file 链接。

参数描述
document: TextDocument

调用命令的文档。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

文档链接的数组或解析为此的 thenable。缺少结果可以通过返回 undefinednull 或空数组来表示。

给定一个链接,填充其 target。当在 UI 中选择一个不完整的链接时,会调用此方法。提供程序可以实现此方法,并从 provideDocumentLinks 方法返回不完整的链接(没有目标),这通常有助于提高性能。

参数描述
link: T

要解析的链接。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

DocumentRangeFormattingEditProvider

文档格式设置提供程序接口定义了扩展与格式设置功能之间的约定。

方法

为文档中的范围提供格式化编辑。

给定的范围是一个提示,提供程序可以决定格式化较小或较大的范围。通常,这是通过将范围的开始和结束调整到完整的语法节点来完成的。

参数描述
document: TextDocument

调用命令的文档。

range: Range

应格式化的范围。

options: FormattingOptions

控制格式设置的选项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或可解析为此的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

为文档中的多个范围提供格式化编辑。

此函数是可选的,但允许格式化程序在仅格式化修改过的范围或格式化大量选择时更快地执行。

给定的范围是提示,提供程序可以决定格式化较小或较大的范围。通常,这是通过将范围的开始和结束调整到完整的语法节点来完成的。

参数描述
document: TextDocument

调用命令的文档。

ranges: Range[]

应格式化的范围。

options: FormattingOptions

控制格式设置的选项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或可解析为此的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

DocumentRangeSemanticTokensProvider

文档范围语义标记提供程序接口定义了扩展和语义标记之间的约定。

方法

参数描述
document: TextDocument
range: Range
token: CancellationToken
返回描述
ProviderResult<SemanticTokens>

DocumentSelector

语言选择器是一个或多个语言标识符和语言过滤器的组合。

请注意,仅是语言标识符的文档选择器会选择所有文档,即使那些未保存在磁盘上的文档也是如此。仅当功能在没有进一步上下文的情况下工作时才使用此类选择器,例如,不需要解析相关“文件”。

示例

let sel: DocumentSelector = { scheme: 'file', language: 'typescript' };

DocumentSemanticTokensProvider

文档语义标记提供程序接口定义了扩展和语义标记之间的契约。

事件

一个可选事件,用于发出此提供程序的语义标记已更改的信号。

方法

文件中的标记表示为一个整数数组。每个标记的位置是相对于它之前的标记表示的,因为当在文件中进行编辑时,大多数标记彼此之间保持稳定。


简而言之,每个标记需要 5 个整数来表示,因此文件中特定的标记 i 由以下数组索引组成

  • 在索引 5*i 处 - deltaLine:标记的行号,相对于上一个标记
  • 在索引 5*i+1 处 - deltaStart:标记的起始字符,相对于上一个标记(如果它们在同一行上,则相对于 0 或上一个标记的起始字符)
  • 在索引 5*i+2 处 - length:标记的长度。标记不能是多行的。
  • 在索引 5*i+3 处 - tokenType:将在 SemanticTokensLegend.tokenTypes 中查找。我们目前要求 tokenType < 65536。
  • 在索引 5*i+4 处 - tokenModifiers:每个设置的位将在 SemanticTokensLegend.tokenModifiers 中查找

如何编码标记

这是一个在 uint32 数组中编码具有 3 个标记的文件的示例

   { line: 2, startChar:  5, length: 3, tokenType: "property",  tokenModifiers: ["private", "static"] },
   { line: 2, startChar: 10, length: 4, tokenType: "type",      tokenModifiers: [] },
   { line: 5, startChar:  2, length: 7, tokenType: "class",     tokenModifiers: [] }
  1. 首先,必须设计一个图例。必须预先提供此图例,并捕获所有可能的标记类型。对于此示例,我们将选择以下图例,该图例必须在注册提供程序时传入
   tokenTypes: ['property', 'type', 'class'],
   tokenModifiers: ['private', 'static']
  1. 第一个转换步骤是使用图例将 tokenTypetokenModifiers 编码为整数。标记类型按索引查找,因此 tokenType 值为 1 表示 tokenTypes[1]。可以通过使用位标志设置多个标记修饰符,因此 tokenModifier3 首先被视为二进制 0b00000011,这意味着 [tokenModifiers[0], tokenModifiers[1]],因为设置了位 0 和 1。使用此图例,现在的标记是
   { line: 2, startChar:  5, length: 3, tokenType: 0, tokenModifiers: 3 },
   { line: 2, startChar: 10, length: 4, tokenType: 1, tokenModifiers: 0 },
   { line: 5, startChar:  2, length: 7, tokenType: 2, tokenModifiers: 0 }
  1. 下一步是表示文件中相对于上一个标记的每个标记。在这种情况下,第二个标记与第一个标记在同一行上,因此第二个标记的 startChar 相对于第一个标记的 startChar,因此它将是 10 - 5。第三个标记与第二个标记在不同的行上,因此第三个标记的 startChar 不会改变
   { deltaLine: 2, deltaStartChar: 5, length: 3, tokenType: 0, tokenModifiers: 3 },
   { deltaLine: 0, deltaStartChar: 5, length: 4, tokenType: 1, tokenModifiers: 0 },
   { deltaLine: 3, deltaStartChar: 2, length: 7, tokenType: 2, tokenModifiers: 0 }
  1. 最后,最后一步是将标记的 5 个字段中的每一个都内联到一个数组中,这是一个内存友好的表示形式
   // 1st token,  2nd token,  3rd token
   [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]

另请参阅 SemanticTokensBuilder,它是一个用于将标记编码为整数的助手。注意:在进行编辑时,可能会发生多次编辑,直到编辑器决定调用语义标记提供程序。注意:如果提供程序暂时无法计算语义标记,它可以通过抛出消息为“Busy”的错误来指示这一点。

参数描述
document: TextDocument
token: CancellationToken
返回描述
ProviderResult<SemanticTokens>

`DocumentSemanticTokensProvider` 可以实现此方法 ( `provideDocumentSemanticTokensEdits` ),而不是总是返回文件中的所有标记,然后返回先前提供的语义标记的增量更新。


当文档更改时,标记如何更改

假设 provideDocumentSemanticTokens 先前返回了以下语义标记

   // 1st token,  2nd token,  3rd token
   [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]

还假设在进行一些编辑之后,文件中新的语义标记是

   // 1st token,  2nd token,  3rd token
   [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ]

可以用应用于先前标记的编辑来表达这些新标记

   [  2,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // old tokens
   [  3,5,3,0,3,  0,5,4,1,0,  3,2,7,2,0 ] // new tokens

   edit: { start:  0, deleteCount: 1, data: [3] } // replace integer at offset 0 with 3

注意:如果提供程序无法计算 SemanticTokensEdits,它可以“放弃”并再次返回文档中的所有标记。注意SemanticTokensEdits 中的所有编辑都包含旧整数数组中的索引,因此它们都引用先前的结果状态。

参数描述
document: TextDocument
previousResultId: string
token: CancellationToken
返回描述
ProviderResult<SemanticTokens | SemanticTokensEdits>

DocumentSymbol

表示文档中出现的编程构造,如变量、类、接口等。文档符号可以是分层的,并且它们有两个范围:一个范围包围其定义,另一个范围指向其最有趣的范围,例如标识符的范围。

构造函数

创建一个新的文档符号。

参数描述
name: string

符号的名称。

detail: string

符号的详细信息。

kind: SymbolKind

符号的种类。

range: Range

符号的完整范围。

selectionRange: Range

应该显示的范围。

返回描述
DocumentSymbol

属性

此符号的子项,例如类的属性。

此符号的更多详细信息,例如函数的签名。

此符号的种类。

此符号的名称。

封闭此符号的范围,不包括开头/结尾的空格,但包括所有其他内容,例如注释和代码。

当选择此符号时,应该选择和显示的范围,例如函数的名称。必须包含在 range 中。

此符号的标签。

DocumentSymbolProvider

文档符号提供程序接口定义了扩展和 转到符号 功能之间的契约。

方法

为给定的文档提供符号信息。

参数描述
document: TextDocument

调用命令的文档。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<DocumentSymbol[] | SymbolInformation[]>

文档高亮的数组或解析为此的 thenable。缺少结果可以通过返回 undefinednull 或空数组来表示。

DocumentSymbolProviderMetadata

关于文档符号提供程序的元数据。

属性

当一个文档显示多个大纲树时显示的人类可读的字符串。

EndOfLine

表示 文档 中的行尾字符序列。

枚举成员

换行符 \n 字符。

回车换行符 \r\n 序列。

EnterAction

描述按下 Enter 键时执行的操作。

属性

描述在新行和缩进之后要附加的文本。

描述如何处理缩进。

描述要从新行的缩进中删除的字符数。

EnvironmentVariableCollection

扩展可以应用于进程环境的突变集合。

属性

环境变体集合的描述,这将用于描述 UI 中的更改。

是否应该为工作区缓存集合,并在窗口重新加载时将其应用于终端。如果为 true,则集合将在窗口重新加载后立即激活。此外,如果存在缓存版本,此 API 将返回缓存版本。当扩展被卸载或集合被清除时,集合将失效。默认为 true。

方法

向环境变量追加一个值。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要追加到的变量。

value: string

要追加到变量的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

从此集合中清除所有 mutator。

参数描述
返回描述
void

删除此集合中某个变量的 mutator。

参数描述
variable: string

要删除 mutator 的变量。

返回描述
void

遍历此集合中的每个 mutator。

参数描述
callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any

为每个条目执行的函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
void

获取此集合应用于变量的 mutator(如果有)。

参数描述
variable: string

要获取 mutator 的变量。

返回描述
EnvironmentVariableMutator

将一个值添加到环境变量的前面。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要添加到前面的变量。

value: string

要添加到变量前面的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

用一个值替换环境变量。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要替换的变量。

value: string

用于替换变量的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

EnvironmentVariableMutator

要应用于环境变量的突变类型及其值。

属性

应用于 mutator 的选项。

将对变量发生的突变类型。

用于变量的值。

EnvironmentVariableMutatorOptions

应用于 mutator 的选项。

属性

在创建进程之前将其应用于环境。默认为 false。

在 shell 集成脚本中应用于环境。请注意,如果 shell 集成被禁用或由于某些原因不起作用,则此操作不会应用 mutator。默认为 false。

EnvironmentVariableMutatorType

可以应用于环境变量的突变类型。

枚举成员

替换变量的现有值。

追加到变量现有值的末尾。

添加到变量现有值的开头。

EnvironmentVariableScope

环境变数集合应用到的作用域对象。

属性

要获取集合的任何特定工作区文件夹。

EvaluatableExpression

EvaluatableExpression 表示文档中可以由活动的调试器或运行时评估的表达式。此评估的结果显示在类似工具提示的小部件中。如果仅指定了范围,则将从基础文档中提取表达式。可以使用可选的表达式来覆盖提取的表达式。在这种情况下,范围仍然用于突出显示文档中的范围。

构造函数

创建一个新的可评估表达式对象。

参数描述
range: Range

从中提取可评估表达式的基础文档中的范围。

expression?: string

如果指定,则覆盖提取的表达式。

返回描述
EvaluatableExpression

属性

EvaluatableExpressionProvider

可评估表达式提供程序接口定义了扩展程序和调试悬停之间的约定。在此约定中,提供程序为文档中的给定位置返回一个可评估表达式,并且编辑器在活动调试会话中评估此表达式,并在调试悬停中显示结果。

方法

为给定的文档和位置提供一个可评估的表达式。编辑器将在活动调试会话中评估此表达式,并在调试悬停中显示结果。该表达式可以由基础文档中的范围隐式指定,也可以通过显式返回表达式来指定。

参数描述
document: TextDocument

即将显示调试悬停的文档。

position: Position

文档中即将显示调试悬停的行和字符位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<EvaluatableExpression>

一个 EvaluatableExpression 或一个 thenable,它解析为这样一个表达式。可以通过返回 undefinednull 来表示缺少结果。

Event<T>

表示一个类型化的事件。

一个函数,表示一个事件,您可以通过调用它并传入一个监听器函数作为参数来订阅该事件。

示例

item.onDidChange(function(event) {
  console.log('Event happened: ' + event);
});

一个函数,表示一个事件,您可以通过调用它并传入一个监听器函数作为参数来订阅该事件。

参数描述
listener: (e: T) => any

当事件发生时,将调用监听器函数。

thisArgs?: any

调用事件监听器时将使用的 this 参数。

disposables?: Disposable[]

一个数组,其中将添加一个 Disposable

返回描述
Disposable

一个可释放对象,用于取消订阅事件监听器。

EventEmitter<T>

事件发射器可用于创建和管理一个 Event,供其他人订阅。一个发射器始终拥有一个事件。

如果您想从您的扩展程序内部提供事件,例如在 TextDocumentContentProvider 中,或者在向其他扩展程序提供 API 时,请使用此类。

构造函数

参数描述
返回描述
EventEmitter<T>

属性

事件监听器可以订阅的事件。

方法

释放此对象并释放资源。

参数描述
返回描述
void

通知 event 的所有订阅者。一个或多个监听器失败不会导致此函数调用失败。

参数描述
data: T

事件对象。

返回描述
void

Extension<T>

表示一个扩展。

要获取 Extension 的实例,请使用 getExtension

属性

此扩展程序导出的公共 API(activate 的返回值)。在此扩展程序激活之前访问此字段是无效的操作。

扩展类型描述扩展程序是在 UI 运行时还是在远程扩展主机运行时运行。扩展类型在扩展程序的 package.json 文件中定义,也可以通过 remote.extensionKind 设置进行细化。当不存在远程扩展主机时,该值为 ExtensionKind.UI

包含此扩展程序的目录的绝对文件路径。 Extension.extensionUri.fsPath 的简写表示法(独立于 uri 方案)。

包含扩展的目录的 uri。

规范的扩展标识符,格式为:publisher.name

如果扩展程序已激活,则为 true

扩展的 package.json 的已解析内容。

方法

激活此扩展程序并返回其公共 API。

参数描述
返回描述
Thenable<T>

当此扩展程序已激活时将解析的 Promise。

ExtensionContext

扩展上下文是扩展程序私有的一组实用工具。

ExtensionContext 的实例作为扩展程序的 activate 调用的第一个参数提供。

属性

获取此工作区的扩展的全局环境变量集合,允许将更改应用于终端环境变量。

当前的 Extension 实例。

扩展程序运行的模式。有关可能的值和方案,请参阅 ExtensionMode

包含扩展程序的目录的绝对文件路径。 ExtensionContext.extensionUri.fsPath 的简写表示法(独立于 uri 方案)。

包含扩展的目录的 uri。

一个备忘录对象,用于存储独立于当前打开的 workspace 的状态。

扩展程序可以在其中存储全局状态的绝对文件路径。该目录可能在磁盘上不存在,创建由扩展程序决定。但是,保证父目录存在。

使用 globalState 存储键值数据。

扩展程序可以在其中存储全局状态的目录的 uri。该目录可能在磁盘上不存在,创建由扩展程序决定。但是,保证父目录存在。

使用 globalState 存储键值数据。

另请参阅 workspace.fs,了解如何从 uri 读取和写入文件和文件夹。

一个对象,用于保存有关此扩展程序如何使用语言模型的信息。

另请参阅 LanguageModelChat.sendRequest

扩展程序可以在其中创建日志文件的目录的绝对文件路径。该目录可能在磁盘上不存在,创建由扩展程序决定。但是,保证父目录存在。

  • 已弃用 - 请改用 logUri

扩展程序可以在其中创建日志文件的目录的 uri。该目录可能在磁盘上不存在,创建由扩展程序决定。但是,保证父目录存在。

另请参阅 workspace.fs,了解如何从 uri 读取和写入文件和文件夹。

一个密钥存储对象,用于存储独立于当前打开的 workspace 的状态。

一个特定于工作区的目录的绝对文件路径,扩展程序可以在其中存储私有状态。该目录可能在磁盘上不存在,创建由扩展程序决定。但是,保证父目录存在。

使用 workspaceStateglobalState 存储键值数据。

扩展程序可以存储私有状态的工作区特定目录的 URI。该目录可能不存在,创建与否取决于扩展程序。但是,保证父目录存在。当没有打开任何工作区或文件夹时,该值为 undefined

使用 workspaceStateglobalState 存储键值数据。

另请参阅 workspace.fs,了解如何从 uri 读取和写入文件和文件夹。

一个可以添加 disposable 对象的数组。当此扩展程序被停用时,这些 disposable 对象将被释放。

注意,异步的 dispose 函数不会被等待。

一个 memento 对象,用于存储在当前打开的 工作区 上下文中的状态。

方法

获取扩展程序中包含的资源的绝对路径。

注意,可以使用 Uri.joinPathextensionUri 构建绝对 URI,例如 vscode.Uri.joinPath(context.extensionUri, relativePath);

参数描述
relativePath: string

扩展程序中包含的资源的相对路径。

返回描述
string

资源的绝对路径。

ExtensionKind

在远程窗口中,扩展程序类型描述扩展程序是在 UI(窗口)运行的地方运行,还是在远程运行。

枚举成员

扩展程序在 UI 运行的地方运行。

扩展程序在远程扩展主机运行的地方运行。

ExtensionMode

ExtensionMode 在 ExtensionContext 上提供,指示特定扩展程序运行的模式。

枚举成员

扩展程序在编辑器中正常安装(例如,从 Marketplace 或 VSIX)。

扩展程序从启动编辑器时提供的 --extensionDevelopmentPath 运行。

扩展程序从 --extensionTestsPath 运行,并且扩展主机正在运行单元测试。

ExtensionTerminalOptions

描述虚拟进程终端应使用的选项的值对象。

属性

终端的图标 ThemeColor。建议使用标准的 terminal.ansi* 主题键,以便在所有主题中获得最佳对比度和一致性。

终端的图标路径或 ThemeIcon

选择退出重启和重载时默认的终端持久性。这仅在启用 terminal.integrated.enablePersistentSessions 时生效。

一个人类可读的字符串,用于在 UI 中表示终端。

Pseudoterminal 的实现,允许扩展程序控制终端。

FileChangeEvent

文件系统提供程序必须使用此事件来发出文件更改信号。

属性

更改的类型。

已更改的文件的 URI。

FileChangeType

文件更改类型的枚举。

枚举成员

文件的内容或元数据已更改。

已创建文件。

已删除文件。

FileCoverage

包含文件的覆盖率元数据。

静态

创建 FileCoverage 实例,其中计数从覆盖率详细信息中填充。

参数描述
uri: Uri

覆盖的文件 URI

details: readonly FileCoverageDetail[]
返回描述
FileCoverage

构造函数

参数描述
uri: Uri

覆盖的文件 URI

statementCoverage: TestCoverageCount

语句覆盖率信息。如果报告程序不提供语句覆盖率信息,则可以使用此信息来表示行覆盖率。

branchCoverage?: TestCoverageCount

分支覆盖率信息

declarationCoverage?: TestCoverageCount

声明覆盖率信息

includesTests?: TestItem[]

此覆盖率报告中包含的测试用例,请参阅 includesTests

返回描述
FileCoverage

属性

分支覆盖率信息。

声明覆盖率信息。根据报告程序和语言的不同,这可能是诸如函数、方法或命名空间之类的类型。

在此文件中生成覆盖率的 测试用例列表。如果设置,则还应定义 TestRunProfile.loadDetailedCoverageForTest,以便检索详细的覆盖率信息。

语句覆盖率信息。如果报告程序不提供语句覆盖率信息,则可以使用此信息来表示行覆盖率。

文件 URI。

FileCoverageDetail

TestRunProfile.loadDetailedCoverage 返回的覆盖率详细信息。

FileCreateEvent

在文件创建后触发的事件。

属性

已创建的文件。

FileDecoration

文件装饰表示可以随文件呈现的元数据。

构造函数

创建一个新的装饰。

参数描述
badge?: string

表示装饰的字母。

tooltip?: string

装饰的工具提示。

color?: ThemeColor

装饰的颜色。

返回描述
FileDecoration

属性

一个表示此装饰的非常短的字符串。

此装饰的颜色。

一个标志,表示此装饰应传播到其父级。

此装饰的人类可读工具提示。

FileDecorationProvider

装饰提供程序接口定义了扩展和文件装饰之间的约定。

事件

一个可选事件,用于表示一个或多个文件的装饰已更改。

注意,此事件应用于传播有关子项的信息。

另请参阅 EventEmitter

方法

为给定的 uri 提供装饰。

注意,仅当文件在 UI 中呈现时才调用此函数。这意味着从向下传播的后代装饰必须通过 onDidChangeFileDecorations 事件向编辑器发出信号。

参数描述
uri: Uri

要为其提供装饰的文件的 uri。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<FileDecoration>

一个装饰或一个解析为这种装饰的可 thenable 对象。

FileDeleteEvent

在文件删除后触发的事件。

属性

已删除的文件。

FilePermission

文件的权限。

枚举成员

文件是只读的。

注意: 从使用选项 isReadonly: true 注册的 FileSystemProvider 中的所有 FileStat 将被隐式处理,就像设置了 FilePermission.Readonly 一样。 因此,不可能拥有一个只读文件系统提供程序,其中某些 FileStat 不是只读的。

FileRenameEvent

在文件重命名后触发的事件。

属性

已重命名的文件。

FileStat

FileStat 类型表示有关文件的元数据

属性

自 1970 年 1 月 1 日 00:00:00 UTC 以来经过的创建时间戳(以毫秒为单位)。

自 1970 年 1 月 1 日 00:00:00 UTC 以来经过的修改时间戳(以毫秒为单位)。

注意: 如果文件已更改,则提供从先前值增加的更新的 mtime 非常重要。 否则,可能会存在某些优化,例如,这些优化将不会在编辑器中显示更新的文件内容。

文件的权限,例如,文件是否为只读。

注意: 此值可能是一个位掩码,例如 FilePermission.Readonly | FilePermission.Other

大小(以字节为单位)。

注意: 如果文件已更改,则提供更新的 size 非常重要。 否则,可能会存在某些优化,例如,这些优化将不会在编辑器中显示更新的文件内容。

文件的类型,例如是常规文件、目录还是指向文件的符号链接。

注意: 此值可能是一个位掩码,例如 FileType.File | FileType.SymbolicLink

FileSystem

文件系统接口公开编辑器的内置和贡献的 文件系统提供程序。 它允许扩展使用本地磁盘中的文件以及来自远程位置(如远程扩展主机或 ftp 服务器)的文件。

注意,此接口的实例可用作 workspace.fs

方法

复制文件或文件夹。

参数描述
source: Uri

现有文件。

target: Uri

目标位置。

options?: {overwrite: boolean}

定义是否应覆盖现有文件。

返回描述
Thenable<void>

创建一个新目录(注意,新文件是通过 write 调用创建的)。

注意,缺少目录会自动创建,例如,此调用具有 mkdirp 语义。

参数描述
uri: Uri

新文件夹的 uri。

返回描述
Thenable<void>

删除文件。

参数描述
uri: Uri

要删除的资源。

options?: {recursive: boolean, useTrash: boolean}

定义是否应使用回收站以及文件夹的删除是否为递归。

返回描述
Thenable<void>

检查给定的文件系统是否支持写入文件。

请记住,仅仅因为文件系统支持写入,并不意味着写入总会成功。 可能存在权限问题或其他错误,导致无法写入文件。

参数描述
scheme: string

文件系统的方案,例如 filegit

返回描述
布尔值

如果文件系统支持写入,则为 true;如果不支持写入(即它是只读的),则为 false;如果编辑器不知道该文件系统,则为 undefined

检索目录的所有条目。

参数描述
uri: Uri

文件夹的 URI。

返回描述
Thenable<Array<[string, FileType]>>

名称/类型元组的数组,或解析为此数组的 thenable 对象。

读取文件的全部内容。

参数描述
uri: Uri

文件的 URI。

返回描述
Thenable<Uint8Array>

字节数组,或解析为此数组的 thenable 对象。

重命名文件或文件夹。

参数描述
source: Uri

现有文件。

target: Uri

新的位置。

options?: {overwrite: boolean}

定义是否应覆盖现有文件。

返回描述
Thenable<void>

检索文件的元数据。

参数描述
uri: Uri

要检索元数据的文件的 URI。

返回描述
Thenable<FileStat>

关于该文件的文件元数据。

将数据写入文件,替换其全部内容。

参数描述
uri: Uri

文件的 URI。

content: Uint8Array

文件的新内容。

返回描述
Thenable<void>

FileSystemError

文件系统提供程序应使用的类型,用于发出错误信号。

此类具有常见错误情况的工厂方法,例如当文件或文件夹不存在时,使用 FileNotFound,使用方法如下:throw vscode.FileSystemError.FileNotFound(someUri);

静态

创建一个错误,以指示文件或文件夹已存在,例如在创建但不覆盖文件时。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

创建一个错误,以指示文件是一个文件夹。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

创建一个错误,以指示文件不是文件夹。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

创建一个错误,以指示未找到文件或文件夹。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

创建一个错误,以指示操作缺少必需的权限。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

创建一个错误,以指示文件系统不可用或太忙,无法完成请求。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

构造函数

创建一个新的文件系统错误。

参数描述
messageOrUri?: string | Uri

消息或 URI。

返回描述
FileSystemError

属性

一个标识此错误的代码。

可能的值是错误的名称,如 FileNotFound,或未指定错误的 Unknown

FileSystemProvider

文件系统提供程序定义编辑器需要读取、写入、发现和管理文件和文件夹的内容。它允许扩展从远程位置(如 ftp 服务器)提供文件,并将这些文件无缝集成到编辑器中。

  • 注意 1: 文件系统提供程序 API 使用 URI 并假设分层路径,例如,foo:/my/pathfoo:/my/ 的子级,是 foo:/my/path/deeper 的父级。
  • 注意 2: 当访问文件或文件夹时,会触发激活事件 onFileSystem:<scheme>
  • 注意 3: “文件”一词通常用于表示所有类型的文件,例如文件夹、符号链接和常规文件。

事件

一个事件,用于发出资源已创建、更改或删除的信号。此事件应针对此提供程序的客户端正在监视的资源触发。

注意:重要的是,更改的文件的元数据提供从 stat 中的先前值前进的更新的 mtime 和正确的 size 值。否则,可能会进行优化,例如,不会在编辑器中显示更改。

方法

复制文件或文件夹。实现此函数是可选的,但它会加快复制操作。

  • 抛出 - 当 destination 的父级不存在时,FileNotFound,例如,不需要 mkdirp 逻辑。
  • 抛出 - 当 destination 存在且 overwrite 选项不是 true 时,FileExists
参数描述
source: Uri

现有文件。

destination: Uri

目标位置。

options: {overwrite: boolean}

定义是否应覆盖现有文件。

返回描述
void | Thenable<void>

创建一个新目录(注意,新文件是通过 write 调用创建的)。

  • 抛出 - 当 uri 的父级不存在时,FileNotFound,例如,不需要 mkdirp 逻辑。
参数描述
uri: Uri

新文件夹的 uri。

返回描述
void | Thenable<void>

删除文件。

参数描述
uri: Uri

要删除的资源。

options: {recursive: boolean}

定义文件夹的删除是否为递归。

返回描述
void | Thenable<void>

检索目录的所有条目。

参数描述
uri: Uri

文件夹的 URI。

返回描述
Array<[string, FileType]> | Thenable<Array<[string, FileType]>>

名称/类型元组的数组,或解析为此数组的 thenable 对象。

读取文件的全部内容。

参数描述
uri: Uri

文件的 URI。

返回描述
Uint8Array | Thenable<Uint8Array>

字节数组,或解析为此数组的 thenable 对象。

重命名文件或文件夹。

  • 抛出 - 当 newUri 的父级不存在时,FileNotFound,例如,不需要 mkdirp 逻辑。
  • 抛出 - 当 newUri 存在且 overwrite 选项不是 true 时,FileExists
参数描述
oldUri: Uri

现有文件。

newUri: Uri

新的位置。

options: {overwrite: boolean}

定义是否应覆盖现有文件。

返回描述
void | Thenable<void>

检索文件的元数据。

请注意,符号链接的元数据应该是它们指向的文件的元数据。 此外,除了实际类型之外,还必须使用 SymbolicLink 类型,例如 FileType.SymbolicLink | FileType.Directory

参数描述
uri: Uri

要检索元数据的文件的 URI。

返回描述
FileStat | Thenable<FileStat>

关于该文件的文件元数据。

订阅由 uri 表示的文件或文件夹中的文件更改事件。 对于文件夹,选项 recursive 指示是否也应监视子文件夹、子子文件夹等的文件更改。 使用 recursive: false,只有对文件夹的直接子文件的更改才会触发事件。

excludes 数组用于指示应从文件监视中排除的路径。 它通常派生自用户可配置的 files.watcherExclude 设置。 每个条目可以是:

  • 要排除的绝对路径
  • 要排除的相对路径(例如 build/output
  • 一个简单的 glob 模式(例如 **/buildoutput/**

文件系统提供程序的工作是针对给定这些规则的每次更改调用 onDidChangeFile。 不应为与任何提供的排除项匹配的文件发出任何事件。

参数描述
uri: Uri

要监视的文件或文件夹的 URI。

options: {excludes: readonly string[], recursive: boolean}

配置监视。

返回描述
Disposable

一个可释放对象,告知提供程序停止监视 uri

将数据写入文件,替换其全部内容。

  • 抛出 - 当 uri 不存在且未设置 create 时,抛出 FileNotFound
  • 抛出 - 当 uri 的父级不存在且设置了 create 时,抛出 FileNotFound,例如,不需要 mkdirp 逻辑。
  • 抛出 - 当 uri 已存在,设置了 create 但未设置 overwrite 时,抛出 FileExists
参数描述
uri: Uri

文件的 URI。

content: Uint8Array

文件的新内容。

options: {create: boolean, overwrite: boolean}

定义是否应创建或必须创建缺失的文件。

返回描述
void | Thenable<void>

FileSystemWatcher

文件系统监视器会通知磁盘上或来自其他 FileSystemProvider 的文件和文件夹的更改。

要获取 FileSystemWatcher 的实例,请使用 createFileSystemWatcher

事件

在文件/文件夹更改时触发的事件。

在文件/文件夹创建时触发的事件。

在文件/文件夹删除时触发的事件。

属性

如果此文件系统监视器已创建为忽略更改文件系统事件,则为 true。

如果此文件系统监视器已创建为忽略创建文件系统事件,则为 true。

如果此文件系统监视器已创建为忽略删除文件系统事件,则为 true。

方法

释放此对象。

参数描述
返回描述
any

FileType

文件类型枚举。类型 FileDirectory 也可以是符号链接,在这种情况下,请使用 FileType.File | FileType.SymbolicLinkFileType.Directory | FileType.SymbolicLink

枚举成员

文件类型未知。

一个常规文件。

一个目录。

指向文件的符号链接。

FileWillCreateEvent

即将创建文件时触发的事件。

要在创建文件之前对工作区进行修改,请使用一个解析为 workspace edit 的 thenable 调用 waitUntil 函数。

属性

即将创建的文件。

取消令牌。

方法

允许暂停事件并应用 workspace edit

注意: 此函数只能在事件调度期间调用,而不能以异步方式调用

workspace.onWillCreateFiles(event => {
  // async, will *throw* an error
  setTimeout(() => event.waitUntil(promise));

  // sync, OK
  event.waitUntil(promise);
});
参数描述
thenable: Thenable<WorkspaceEdit>

延迟保存的 thenable。

返回描述
void

允许暂停事件,直到提供的 thenable 解析。

注意: 此函数只能在事件调度期间调用。

参数描述
thenable: Thenable<any>

延迟保存的 thenable。

返回描述
void

FileWillDeleteEvent

即将删除文件时触发的事件。

要在删除文件之前对工作区进行修改,请使用解析为 workspace edit 的 thenable 调用 waitUntil 函数。

属性

即将删除的文件。

取消令牌。

方法

允许暂停事件并应用 workspace edit

注意: 此函数只能在事件调度期间调用,而不能以异步方式调用

workspace.onWillCreateFiles(event => {
  // async, will *throw* an error
  setTimeout(() => event.waitUntil(promise));

  // sync, OK
  event.waitUntil(promise);
});
参数描述
thenable: Thenable<WorkspaceEdit>

延迟保存的 thenable。

返回描述
void

允许暂停事件,直到提供的 thenable 解析。

注意: 此函数只能在事件调度期间调用。

参数描述
thenable: Thenable<any>

延迟保存的 thenable。

返回描述
void

FileWillRenameEvent

即将重命名文件时触发的事件。

要在重命名文件之前对工作区进行修改,请使用解析为 workspace edit 的 thenable 调用 waitUntil 函数。

属性

即将重命名的文件。

取消令牌。

方法

允许暂停事件并应用 workspace edit

注意: 此函数只能在事件调度期间调用,而不能以异步方式调用

workspace.onWillCreateFiles(event => {
  // async, will *throw* an error
  setTimeout(() => event.waitUntil(promise));

  // sync, OK
  event.waitUntil(promise);
});
参数描述
thenable: Thenable<WorkspaceEdit>

延迟保存的 thenable。

返回描述
void

允许暂停事件,直到提供的 thenable 解析。

注意: 此函数只能在事件调度期间调用。

参数描述
thenable: Thenable<any>

延迟保存的 thenable。

返回描述
void

FoldingContext

折叠上下文(供将来使用)

FoldingRange

一个基于行的折叠范围。要有效,起始行和结束行必须大于零且小于文档中的行数。无效的范围将被忽略。

构造函数

创建一个新的折叠范围。

参数描述
start: number

折叠范围的起始行。

end: number

折叠范围的结束行。

kind?: FoldingRangeKind

折叠范围的种类。

返回描述
折叠范围

属性

要折叠的范围的从零开始的结束行。折叠区域以该行的最后一个字符结束。要有效,结束行必须大于等于零,且小于文档中的行数。

描述折叠范围的种类,例如注释区域。该种类用于对折叠范围进行分类,并被诸如“折叠所有注释”之类的命令使用。有关所有种类的枚举,请参见FoldingRangeKind。如果未设置,则该范围源自语法元素。

要折叠的范围的从零开始的起始行。折叠区域从该行的最后一个字符之后开始。要有效,起始行必须大于等于零,且小于文档中的行数。

FoldingRangeKind

特定折叠范围种类的枚举。该种类是FoldingRange的一个可选字段,用于区分特定的折叠范围,例如源自注释的范围。该种类被诸如折叠所有注释折叠所有区域之类的命令使用。如果未在范围上设置种类,则该范围源自除注释、导入或区域标记之外的语法元素。

枚举成员

表示注释的折叠范围的种类。

表示导入的折叠范围的种类。

表示源自诸如#region#endregion之类的折叠标记的区域的折叠范围的种类。

FoldingRangeProvider

折叠范围提供程序接口定义了扩展与编辑器中折叠之间的协定。

事件

一个可选事件,用于指示此提供程序的折叠范围已更改。

方法

返回折叠范围列表;如果提供程序不想参与或已取消,则返回 null 或 undefined。

参数描述
document: TextDocument

调用命令的文档。

context: FoldingContext

附加的上下文信息(供将来使用)

token: CancellationToken

取消令牌。

返回描述
ProviderResult<FoldingRange[]>

FormattingOptions

描述格式设置应使用的选项的值对象。

属性

首选空格而不是制表符。

制表符的大小(以空格为单位)。

FunctionBreakpoint

由函数名称指定的断点。

构造函数

创建一个新的函数断点。

参数描述
functionName: string
enabled?: boolean
condition?: string
hitCondition?: string
logMessage?: string
返回描述
函数断点

属性

条件断点的可选表达式。

是否启用断点。

此断点所附加的函数的名称。

控制忽略多少次断点命中的可选表达式。

断点的唯一 ID。

命中此断点时记录的可选消息。{} 内的嵌入表达式由调试适配器进行插值。

GlobalEnvironmentVariableCollection

扩展可以应用于进程环境的突变集合。应用于所有作用域。

属性

环境变体集合的描述,这将用于描述 UI 中的更改。

是否应该为工作区缓存集合,并在窗口重新加载时将其应用于终端。如果为 true,则集合将在窗口重新加载后立即激活。此外,如果存在缓存版本,此 API 将返回缓存版本。当扩展被卸载或集合被清除时,集合将失效。默认为 true。

方法

向环境变量追加一个值。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要追加到的变量。

value: string

要追加到变量的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

从此集合中清除所有 mutator。

参数描述
返回描述
void

删除此集合中某个变量的 mutator。

参数描述
variable: string

要删除 mutator 的变量。

返回描述
void

遍历此集合中的每个 mutator。

参数描述
callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any

为每个条目执行的函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
void

获取此集合应用于变量的 mutator(如果有)。

参数描述
variable: string

要获取 mutator 的变量。

返回描述
EnvironmentVariableMutator

获取扩展的特定于作用域的环境变量集合。这使得只能在指定作用域内更改终端环境变量,并且是附加在全局集合之后应用的。

通过此方法获取的每个对象都是隔离的,不会影响其他作用域的对象,包括全局集合。

参数描述
scope: EnvironmentVariableScope

环境变量集合应用的作用域。

如果省略了作用域参数,则返回适用于该参数所有相关作用域的集合。例如,如果未指定“workspaceFolder”参数,则将返回适用于所有工作区文件夹的集合。

返回描述
环境变量集合

传递的作用域的环境变量集合。

将一个值添加到环境变量的前面。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要添加到前面的变量。

value: string

要添加到变量前面的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

用一个值替换环境变量。

请注意,一个扩展程序只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要替换的变量。

value: string

用于替换变量的值。

options?: EnvironmentVariableMutatorOptions

应用于 mutator 的选项,如果未提供选项,则默认为 { applyAtProcessCreation: true }

返回描述
void

GlobPattern

用于匹配文件路径的文件 glob 模式。它可以是 glob 模式字符串(例如 **/*.{ts,js}*.{ts,js}),也可以是相对模式

Glob 模式可以具有以下语法

  • * 匹配路径段中的零个或多个字符
  • ? 匹配路径段中的一个字符
  • ** 匹配任意数量的路径段,包括零个
  • {} 用于分组条件(例如,**/*.{ts,js} 匹配所有 TypeScript 和 JavaScript 文件)
  • [] 用于声明要匹配的路径段中的字符范围(例如,example.[0-9] 匹配 example.0example.1 等)
  • [!...] 用于否定要匹配的路径段中的字符范围(例如,example.[!0-9] 匹配 example.aexample.b,但不匹配 example.0

注意:反斜杠 (``) 在 glob 模式中无效。如果您有要匹配的现有文件路径,请考虑使用相对模式支持,该支持负责将任何反斜杠转换为斜杠。否则,请确保在创建 glob 模式时将任何反斜杠转换为斜杠。

Hover

悬停表示符号或单词的附加信息。悬停会在类似工具提示的小部件中呈现。

构造函数

创建一个新的悬停对象。

参数描述
contents: MarkdownString | MarkedString | Array<MarkdownString | MarkedString>

悬停的内容。

range?: Range

悬停应用的范围。

返回描述
悬停

属性

此悬停的内容。

此悬停应用的范围。如果缺失,编辑器将使用当前位置的范围或当前位置本身。

HoverProvider

悬停提供程序接口定义了扩展和悬停功能之间的协定。

方法

为给定位置和文档提供悬停。编辑器将合并同一位置的多个悬停。悬停可以有一个范围,当省略时,该范围默认为该位置的单词范围。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Hover>

一个悬停或一个解析为悬停的 thenable。可以通过返回 undefinednull 来表示缺少结果。

IconPath

表示 UI 中的图标。这可以是 URI、用于浅色和深色主题的单独 URI,或主题图标

ImplementationProvider

实现提供程序接口定义了扩展和“转到实现”功能之间的协定。

方法

提供给定位置和文档中符号的实现。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Definition | LocationLink[]>

一个定义,或一个可以解析为该定义的 Promise。 返回 undefinednull 可以表示没有结果。

IndentAction

描述在按 Enter 键时如何处理缩进。

枚举成员

插入新行并复制上一行的缩进。

插入新行并缩进一次(相对于上一行的缩进)。

插入两行新行

  • 第一行缩进,将包含光标
  • 第二行与相同的缩进级别

插入新行并取消缩进一次(相对于上一行的缩进)。

IndentationRule

描述语言的缩进规则。

属性

如果某一行与此模式匹配,则它之后的所有行都应取消缩进一次(直到另一条规则匹配)。

如果某一行与此模式匹配,则它之后的所有行都应缩进一次(直到另一条规则匹配)。

如果某一行与此模式匹配,则只有下一行应缩进一次。

如果某一行与此模式匹配,则其缩进不应更改,并且不应针对其他规则进行评估。

InlayHint

内嵌提示信息。

构造函数

创建一个新的内嵌提示。

参数描述
position: Position

提示的位置。

label: string | InlayHintLabelPart[]

提示的标签。

kind?: InlayHintKind

提示的种类

返回描述
InlayHint

属性

此提示的种类。内嵌提示种类定义此内嵌提示的外观。

此提示的标签。人类可读的字符串或标签部分的数组。

请注意,字符串和标签部分都不能为空。

在提示之前渲染填充。填充将使用编辑器的背景色,而不是提示本身的背景色。这意味着可以使用填充来视觉对齐/分隔内嵌提示。

在提示之后渲染填充。填充将使用编辑器的背景色,而不是提示本身的背景色。这意味着可以使用填充来视觉对齐/分隔内嵌提示。

此提示的位置。

在接受此内嵌提示时执行的可选文本编辑。接受内嵌提示的默认手势是双击。

请注意,预计编辑会更改文档,以便内嵌提示(或其最接近的变体)现在是文档的一部分,并且内嵌提示本身现在已过时。

请注意,此属性可以在解析内嵌提示期间稍后设置。

当您将鼠标悬停在此项上时显示的工具提示文本。

请注意,此属性可以在解析内嵌提示期间稍后设置。

InlayHintKind

内嵌提示的种类。

内嵌提示的种类定义了其外观,例如将使用相应的前景色和背景色。

枚举成员

用于类型注解的内嵌提示。

用于参数的内嵌提示。

InlayHintLabelPart

内嵌提示标签部分允许内嵌提示的交互式和复合标签。

构造函数

创建一个新的内嵌提示标签部分。

参数描述
value: string

该部分的值。

返回描述
InlayHintLabelPart

属性

此标签部分的可选命令。

编辑器将带有命令的部分渲染为可点击的链接。当标签部分定义了 locationcommand 时,该命令会添加到上下文菜单中。

请注意,此属性可以在解析内嵌提示期间稍后设置。

一个可选的 源代码位置,表示此标签部分。

编辑器将使用此位置进行悬停和代码导航功能:此部分将成为一个可点击的链接,解析为给定位置的符号的定义(不一定是位置本身),它会显示在给定位置显示的悬停,并显示包含进一步代码导航命令的上下文菜单。

请注意,此属性可以在解析内嵌提示期间稍后设置。

当您将鼠标悬停在此标签部分上时显示的工具提示文本。

请注意,此属性可以在解析内嵌提示期间稍后设置。

此标签部分的值。

InlayHintsProvider<T>

内嵌提示提供程序接口定义了扩展与内嵌提示功能之间的约定。

事件

一个可选事件,用于通知此提供程序的内嵌提示已更改。

方法

为给定范围和文档提供内嵌提示。

注意,不被给定范围 包含 的内嵌提示将被忽略。

参数描述
document: TextDocument

调用命令的文档。

range: Range

应计算内嵌提示的范围。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

一个内嵌提示数组,或一个解析为此数组的可 thenable 对象。

给定一个内嵌提示,填写 tooltip文本编辑 或完整的标签 部分

注意,编辑器最多会解析一个内嵌提示一次。

参数描述
hint: T

一个内嵌提示。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

解析后的内嵌提示,或解析为此提示的可 thenable 对象。返回给定的 item 是可以的。当没有返回结果时,将使用给定的 item

InlineCompletionContext

提供有关请求内联完成的上下文的信息。

属性

提供有关自动完成小部件中当前选定项(如果可见)的信息。

如果设置,提供的内联完成必须扩展选定项的文本并使用相同的范围,否则它们不会显示为预览。例如,如果文档文本是 console.,并且选定项是 .log 替换文档中的 .,则内联完成也必须替换 . 并以 .log 开头,例如 .log()

每当选定项更改时,都会再次请求内联完成提供程序。

描述如何触发内联完成。

InlineCompletionItem

内联完成项表示一个文本片段,该片段以行内方式建议,以完成正在键入的文本。

另请参阅 InlineCompletionItemProvider.provideInlineCompletionItems

构造函数

创建一个新的内联完成项。

参数描述
insertText: string | SnippetString

用于替换范围的文本。

range?: Range

要替换的范围。如果未设置,将使用请求位置的单词。

command?: Command

一个可选的 Command,在插入此完成项之后执行。

返回描述
InlineCompletionItem

属性

一个可选的 Command,在插入此完成项之后执行。

用于确定是否应显示此内联完成的文本。当为 falsy 时,将使用 InlineCompletionItem.insertText

如果要替换的文本是筛选文本的前缀,则会显示内联完成。

用于替换范围的文本。必须设置。同时用于预览和接受操作。

要替换的范围。必须在同一行开始和结束。

优先选择替换而不是插入,以便在用户删除键入的文本时提供更好的体验。

InlineCompletionItemProvider

内联完成项提供程序接口定义了扩展与内联完成功能之间的约定。

当用户通过手势显式请求或在键入时隐式请求时,会要求提供程序提供完成项。

方法

为给定位置和文档提供内联完成项。如果启用了内联完成,则每当用户停止键入时,都会调用此方法。当用户显式触发内联完成或显式要求下一个或上一个内联完成时,也会调用此方法。在这种情况下,应返回所有可用的内联完成项。可以使用 context.triggerKind 来区分这些方案。

参数描述
document: TextDocument

请求内联完成的文档。

position: Position

请求内联完成的位置。

context: InlineCompletionContext

包含其他信息的上下文对象。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<InlineCompletionList | InlineCompletionItem[]>

一个完成项数组,或一个解析为完成项数组的可 thenable 对象。

InlineCompletionList

表示要在编辑器中呈现的 内联完成项 的集合。

构造函数

创建一个新的内联完成项列表。

参数描述
items: InlineCompletionItem[]
返回描述
InlineCompletionList

属性

内联完成项。

InlineCompletionTriggerKind

描述如何触发 内联完成提供程序

枚举成员

补全是由用户手势显式触发的。返回多个补全项以支持在它们之间循环切换。

补全是在编辑时自动触发的。在这种情况下,返回单个补全项就足够了。

InlineValue

内联值信息可以通过不同的方式提供

  • 直接作为文本值(类 InlineValueText)。
  • 作为用于变量查找的名称(类 InlineValueVariableLookup)
  • 作为可求值的表达式(类 InlineValueEvaluatableExpression)。InlineValue 类型将所有内联值类型组合成一个类型。

InlineValueContext

一个值对象,包含从 InlineValuesProvider 请求内联值时的上下文信息。

属性

执行停止的堆栈帧(作为 DAP ID)。

执行停止的文档范围。通常,范围的结束位置表示显示内联值的行。

InlineValueEvaluatableExpression

通过表达式求值提供内联值。如果仅指定了一个范围,则将从底层文档中提取表达式。可以使用可选表达式来覆盖提取的表达式。

构造函数

创建一个新的 InlineValueEvaluatableExpression 对象。

参数描述
range: Range

从中提取可评估表达式的基础文档中的范围。

expression?: string

如果指定,则覆盖提取的表达式。

返回描述
InlineValueEvaluatableExpression

属性

如果指定,表达式将覆盖提取的表达式。

内联值适用的文档范围。该范围用于从底层文档中提取可求值的表达式。

InlineValuesProvider

内联值提供程序接口定义了扩展和编辑器调试器内联值功能之间的契约。在此契约中,提供程序返回给定文档范围的内联值信息,编辑器在行末的编辑器中显示此信息。

事件

一个可选事件,用于指示内联值已更改。

另请参阅 EventEmitter

方法

为给定的文档和范围提供“内联值”信息。每当调试在该给定文档中停止时,编辑器都会调用此方法。返回的内联值信息在编辑器中的行末呈现。

参数描述
document: TextDocument

需要内联值信息的文档。

viewPort: Range

应该计算内联值的可见文档范围。

context: InlineValueContext

一个包含上下文信息(如当前位置)的包。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<InlineValue[]>

InlineValueDescriptors 的数组或可解析为该数组的可 thenable 对象。可以通过返回 undefinednull 来表示缺少结果。

InlineValueText

将内联值作为文本提供。

构造函数

创建一个新的 InlineValueText 对象。

参数描述
range: Range

显示内联值的文档行。

text: string

该行要显示的值。

返回描述
InlineValueText

属性

内联值适用的文档范围。

内联值的文本。

InlineValueVariableLookup

通过变量查找提供内联值。如果仅指定了一个范围,则将从底层文档中提取变量名。可以使用可选变量名来覆盖提取的名称。

构造函数

创建一个新的 InlineValueVariableLookup 对象。

参数描述
range: Range

显示内联值的文档行。

variableName?: string

要查找的变量的名称。

caseSensitiveLookup?: boolean

如何执行查找。如果缺少,则查找区分大小写。

返回描述
InlineValueVariableLookup

属性

如何执行查找。

内联值适用的文档范围。该范围用于从底层文档中提取变量名。

如果指定,则为要查找的变量的名称。

InputBox

一个具体的 QuickInput,用于让用户输入文本值。

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

事件

一个事件,指示用户何时表示接受输入值。

一个事件,指示值何时已更改。

一个事件,指示此输入 UI 何时隐藏。

此 UI 可能必须隐藏的原因有多种,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide,用户按 Esc 键,打开其他输入 UI 等。)

一个事件,指示何时触发了按钮。

属性

UI 是否应显示进度指示器。默认为 false。

例如,在加载更多数据或验证用户输入时,将此更改为 true。

UI 中操作的按钮。

UI 是否应允许用户输入。默认为 true。

例如,在验证用户输入或为用户输入的下一步加载数据时,将此更改为 false。

即使失去 UI 焦点,UI 是否也应保持打开状态。默认为 false。此设置在 iPad 上被忽略,并且始终为 false。

如果输入值应该被隐藏。默认为 false。

当没有输入任何值时显示的 可选占位符。

向用户提供一些询问或解释的可选提示文本。

可选的当前步骤计数。

可选的标题。

可选的总步骤计数。

一个可选的验证消息,指示当前输入值存在问题。通过返回一个字符串,InputBox 将使用默认的 InputBoxValidationSeverity 错误级别。返回 undefined 将清除验证消息。

当前的输入值。

输入值中的选择范围。定义为包含两个数字的元组,第一个是包含的起始索引,第二个是排除的结束索引。当 undefined 时,将选择整个预填充值;当为空(起始等于结束)时,仅设置光标;否则,将选择定义的范围。

当用户键入或进行选择时,此属性不会更新,但可以通过扩展程序进行更新。

方法

释放此输入 UI 和任何关联的资源。如果它仍然可见,则首先将其隐藏。在此调用之后,输入 UI 不再起作用,并且不应访问其上的任何其他方法或属性。而是应该创建一个新的输入 UI。

参数描述
返回描述
void

隐藏此输入 UI。 这也会触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

使其当前配置中的输入 UI 可见。任何其他输入 UI 将首先触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

InputBoxOptions

用于配置输入框 UI 行为的选项。

属性

设置为 true 可在焦点移动到编辑器或另一个窗口的另一部分时保持输入框打开。此设置在 iPad 上被忽略,并且始终为 false。

控制是否显示密码输入。密码输入会隐藏键入的文本。

一个可选的字符串,在输入框中显示为占位符,以指导用户输入什么内容。

显示在输入框下方的文本。

表示输入框标题的可选字符串。

要在输入框中预填充的值。

预填充 value 的选择。定义为包含两个数字的元组,第一个是包含的起始索引,第二个是排除的结束索引。当 undefined 时,将选择整个预填充值;当为空(起始等于结束)时,仅设置光标;否则,将选择定义的范围。

方法

一个可选函数,将调用该函数来验证输入并向用户提供提示。

参数描述
value: string

输入框的当前值。

返回描述
string | InputBoxValidationMessage | Thenable<string | InputBoxValidationMessage>

当“value”有效时,要么是一个人类可读的字符串(显示为错误消息),要么是一个 InputBoxValidationMessage(可以提供特定的消息严重性)。当“value”有效时,返回 undefinednull 或空字符串。

InputBoxValidationMessage

用于配置验证消息行为的对象。

属性

要显示的验证消息。

验证消息的严重性。注意:当使用 InputBoxValidationSeverity.Error 时,将不允许用户接受(按 ENTER 键)输入。InfoWarning 仍然允许 InputBox 接受输入。

InputBoxValidationSeverity

输入框验证的严重性级别。

枚举成员

信息严重性级别。

警告严重性级别。

错误严重性级别。

LanguageConfiguration

语言配置接口定义了扩展和各种编辑器功能之间的约定,例如自动括号插入、自动缩进等。

属性

已弃用 请勿使用。

  • 已弃用 - * 请改用语言配置文件中的 autoClosingPairs 属性。
参数描述
autoClosingPairs: Array<{close: string, notIn: string[], open: string}>
  • 已弃用

已弃用 请勿使用。

  • 已弃用 - 将很快被更好的 API 取代。
参数描述
brackets: any

此属性已弃用,并将被编辑器忽略

  • 已弃用
docComment: {close: string, lineStart: string, open: string, scope: string}

此属性已弃用,并且不再完全受编辑器支持(忽略 scope 和 lineStart)。请改用语言配置文件中的 autoClosingPairs 属性。

  • 已弃用

该语言的自动闭合对。

该语言的括号。此配置隐式影响在这些括号周围按 Enter 键。

语言的注释设置。

语言的缩进设置。

按下 Enter 键时要评估的语言规则。

语言的单词定义。如果该语言支持 Unicode 标识符(例如 JavaScript),则最好提供一个使用已知分隔符排除的单词定义。例如:一个正则表达式,它匹配除已知分隔符之外的任何内容(并且允许点号出现在浮点数中)

/(-?\d*\.\d\w*)|([^\`\~\!\\#\%\^\&\*\(\)\-\=\+\[\{\]\}\\\|\;\:\'\"\,\.\<\>/\?\s]+)/g

LanguageModelAccessInformation

表示关于访问语言模型的扩展特定信息。

事件

当访问信息更改时触发的事件。

方法

检查是否可以向语言模型发出请求。

注意 调用此函数不会触发同意 UI,而只是检查持久化的状态。

参数描述
chat: LanguageModelChat

语言模型聊天对象。

返回描述
布尔值

如果可以发出请求,则为 true,如果不能,则为 false,如果语言模型不存在或尚未请求同意,则为 undefined

LanguageModelChat

表示用于发出聊天请求的语言模型。

另请参阅 lm.selectChatModels

属性

语言模型的不透明家族名称。值可能是 gpt-3.5-turbogpt4phi2llama,但它们由贡献语言的扩展定义,并且可能会发生更改。

语言模型的不透明标识符。

在单个请求中可以发送到模型的最大令牌数。

语言模型的人类可读名称。

语言模型供应商的知名标识符。例如 copilot,但值由贡献聊天模型的扩展定义,需要与它们一起查找。

模型的不透明版本字符串。这由贡献语言模型的扩展定义,并且可能会发生更改。

方法

使用模型特定的分词器逻辑计算消息中的令牌数。

参数描述
text: string | LanguageModelChatMessage

字符串或消息实例。

token?: CancellationToken

可选的取消令牌。有关如何创建一个,请参阅 CancellationTokenSource

返回描述
Thenable<number>

一个可解析为令牌数的 thenable 对象。

使用语言模型发出聊天请求。

注意 语言模型的使用可能受到访问限制和用户同意的约束。首次调用此函数(对于扩展)将向用户显示一个同意对话框,因此该函数必须仅在响应用户操作时调用! 扩展可以使用 LanguageModelAccessInformation.canSendRequest 来检查它们是否具有发出请求的必要权限。

如果无法向语言模型发出请求,此函数将返回一个拒绝的 promise。原因可能是

  • 未获得用户同意,请参阅 NoPermissions
  • 模型已不存在,请参阅 NotFound
  • 超出配额限制,请参阅 Blocked
  • 其他问题,在这种情况下,扩展必须检查 [LanguageModelError.cause LanguageModelError.cause](#LanguageModelError.cause LanguageModelError.cause)

扩展可以通过向 LanguageModelChatRequestOptions.tools 传递一组工具来利用语言模型工具调用。语言模型将返回一个 LanguageModelToolCallPart,并且扩展可以调用该工具并使用结果发出另一个请求。

参数描述
messages: LanguageModelChatMessage[]

消息实例的数组。

options?: LanguageModelChatRequestOptions

控制请求的选项。

token?: CancellationToken

控制请求的取消令牌。有关如何创建一个,请参阅 CancellationTokenSource

返回描述
Thenable<LanguageModelChatResponse>

一个可解析为 LanguageModelChatResponse 的 thenable 对象。当无法发出请求时,promise 将被拒绝。

LanguageModelChatMessage

表示聊天中的消息。可以承担不同的角色,如用户或助手。

静态

用于创建新的助手消息的实用程序。

参数描述
content: string | Array<LanguageModelTextPart | LanguageModelToolCallPart>

消息的内容。

name?: string

消息的用户的可选名称。

返回描述
LanguageModelChatMessage

用于创建新的用户消息的实用程序。

参数描述
content: string | Array<LanguageModelTextPart | LanguageModelToolResultPart>

消息的内容。

name?: string

消息的用户的可选名称。

返回描述
LanguageModelChatMessage

构造函数

创建新的用户消息。

参数描述
role: LanguageModelChatMessageRole

消息的角色。

content: string | Array<LanguageModelTextPart | LanguageModelToolResultPart | LanguageModelToolCallPart>

消息的内容。

name?: string

消息的用户的可选名称。

返回描述
LanguageModelChatMessage

属性

字符串或消息可以包含作为内容的异构数组。某些部分对于某些模型可能是特定于消息类型的。

此消息的用户的可选名称。

此消息的角色。

LanguageModelChatMessageRole

表示聊天消息的角色。这可以是用户或助手。

枚举成员

用户角色,例如与语言模型交互的人。

助手角色,例如生成响应的语言模型。

LanguageModelChatRequestOptions

使用语言模型发出聊天请求的选项。

另请参阅 LanguageModelChat.sendRequest

属性

一个人类可读的消息,解释为什么需要访问语言模型以及它启用了什么功能。

一组控制语言模型行为的选项。这些选项特定于语言模型,需要在相应的文档中查找。

要使用的工具选择模式。默认为 LanguageModelChatToolMode.Auto

可供语言模型使用的可选工具列表。这些可以是已通过 lm.tools 注册的工具,或者只是在调用扩展中实现的私有工具。

如果 LLM 请求调用其中一个工具,它将在 LanguageModelChatResponse.stream 中返回一个 LanguageModelToolCallPart。调用者有责任调用该工具。如果它是注册在 lm.tools 中的工具,则意味着调用 lm.invokeTool

然后,可以通过创建一个带有 LanguageModelToolCallPart 的助手类型 LanguageModelChatMessage,然后是一个带有 LanguageModelToolResultPart 的用户类型消息,将工具结果提供给 LLM。

LanguageModelChatResponse

表示语言模型的响应。

另请参阅 LanguageModelAccess.chatRequest

属性

一个异步可迭代对象,它是构成整体响应的文本和工具调用部分的流。 LanguageModelTextPart 是助手的响应的一部分,将显示给用户。 LanguageModelToolCallPart 是语言模型调用工具的请求。只有当通过 LanguageModelChatRequestOptions.tools 在请求中传递了工具时,才会返回后者。 unknown 类型用作未来部分(如图像数据部分)的占位符。

请注意,当数据接收期间发生错误时,此流将报错。流的消费者应相应地处理错误。

要取消流,消费者可以 取消 用于发出请求的令牌或从 for 循环中跳出。

示例

try {
  // consume stream
  for await (const chunk of response.stream) {
    if (chunk instanceof LanguageModelTextPart) {
      console.log('TEXT', chunk);
    } else if (chunk instanceof LanguageModelToolCallPart) {
      console.log('TOOL CALL', chunk);
    }
  }
} catch (e) {
  // stream ended with an error
  console.error(e);
}

这等效于从 LanguageModelChatResponse.stream 中过滤掉除文本部分之外的所有内容。

另请参阅 LanguageModelChatResponse.stream

LanguageModelChatSelector

描述如何为聊天请求选择语言模型。

另请参阅 lm.selectChatModels

属性

一个语言模型系列。

另请参阅 LanguageModelChat.family

语言模型的标识符。

另请参阅 LanguageModelChat.id

语言模型的供应商。

另请参阅 LanguageModelChat.vendor

语言模型的版本。

另请参阅 LanguageModelChat.version

LanguageModelChatTool

通过 LanguageModelChatRequestOptions 可供语言模型使用的工具。语言模型使用此接口的所有属性来决定调用哪个工具以及如何调用它。

属性

该工具的描述。

此工具接受的输入的 JSON 模式。

该工具的名称。

LanguageModelChatToolMode

语言模型要使用的工具调用模式。

枚举成员

语言模型可以选择调用工具或生成消息。是默认值。

语言模型必须调用提供的工具之一。请注意,某些模型在使用此模式时仅支持单个工具。

LanguageModelError

语言模型特定错误的错误类型。

语言模型的消费者应检查 code 属性以确定具体的失败原因,例如 if(someError.code === vscode.LanguageModelError.NotFound.name) {...},以处理引用未知语言模型的情况。对于未指定的错误,cause 属性将包含实际的错误。

静态

请求者被阻止使用此语言模型。

参数描述
消息?: string
返回描述
LanguageModelError

请求者没有使用此语言模型的权限。

参数描述
消息?: string
返回描述
LanguageModelError

该语言模型不存在。

参数描述
消息?: string
返回描述
LanguageModelError

构造函数

参数描述
消息?: string
返回描述
LanguageModelError

属性

一个标识此错误的代码。

可能的值是错误的名称,例如 NotFound,或者对于语言模型本身未指定的错误,为 Unknown。在后一种情况下,cause 属性将包含实际的错误。

LanguageModelPromptTsxPart

一个语言模型响应部分,包含来自 vscode/prompt-tsx 的 PromptElementJSON。

另请参阅 LanguageModelToolResult

构造函数

使用给定内容构造一个 prompt-tsx 部分。

参数描述
value: unknown

部件的值,是来自 vscode/prompt-tsxrenderPromptElementJSON 的结果。

返回描述
LanguageModelPromptTsxPart

属性

该部分的值。

LanguageModelTextPart

一个包含一段文本的语言模型响应部件,从 LanguageModelChatResponse 返回。

构造函数

使用给定的内容构造一个文本部件。

参数描述
value: string

部件的文本内容。

返回描述
LanguageModelTextPart

属性

部件的文本内容。

LanguageModelTool<T>

一个可以通过调用 LanguageModelChat 来调用的工具。

方法

使用给定的输入调用工具并返回结果。

提供的 LanguageModelToolInvocationOptions.input 已根据声明的模式进行了验证。

在调用工具之前调用一次。建议实现此方法来自定义工具运行时显示进度消息,并提供来自调用输入的上下文更有用的消息。如果需要,还可以表示工具在运行之前需要用户确认。

  • 注意 1: 必须没有副作用。
  • 注意 2: 调用 prepareInvocation 之后不一定会调用 invoke

LanguageModelToolCallPart

一个指示工具调用的语言模型响应部件,从 LanguageModelChatResponse 返回,也可以作为 LanguageModelChatMessage 的内容部分,表示聊天请求中之前的工具调用。

构造函数

创建一个新的 LanguageModelToolCallPart。

参数描述
callId: string

工具调用的 ID。

name: string

要调用的工具的名称。

input: object

调用工具的输入。

返回描述
LanguageModelToolCallPart

属性

工具调用的 ID。这是聊天请求中工具调用的唯一标识符。

调用工具的输入。

要调用的工具的名称。

LanguageModelToolConfirmationMessages

当在 PreparedToolInvocation 中返回此值时,会询问用户是否在运行工具之前进行确认。这些消息将显示带有“继续”和“取消”按钮。

属性

确认消息的正文。

确认消息的标题。

LanguageModelToolInformation

有关 lm.tools 中可用的已注册工具的信息。

属性

此工具的描述,可能会传递给语言模型。

此工具接受的输入的 JSON 模式。

该工具的唯一名称。

工具声明的一组标签,大致描述了工具的功能。工具用户可以使用这些标签来筛选工具集,只保留与手头任务相关的工具。

LanguageModelToolInvocationOptions<T>

工具调用提供的选项。

属性

用于调用工具的输入。输入必须与 LanguageModelToolInformation.inputSchema 中定义的模式匹配。

用于提示工具在其响应中返回多少个 token 的选项,并使工具能够准确地计算 token。

一个不透明的对象,将工具调用与 聊天参与者 的聊天请求联系起来。

获取有效的工具调用 token 的唯一方法是使用聊天请求中提供的 toolInvocationToken。在这种情况下,将在聊天响应视图中自动显示工具调用的进度条,如果工具需要用户确认,它将以内联方式显示在聊天视图中。

如果工具在聊天请求之外被调用,则应传递 undefined,并且除了确认之外不会显示任何特殊的 UI。

注意 在工具调用期间调用另一个工具的工具,可以传递它收到的 toolInvocationToken

LanguageModelToolInvocationPrepareOptions<T>

属性

调用工具时使用的输入。

LanguageModelToolResult

从工具调用返回的结果。如果使用 vscode/prompt-tsx,则可以使用 ToolResult 呈现此结果。

构造函数

创建 LanguageModelToolResult

参数描述
content: Array<LanguageModelTextPart | LanguageModelPromptTsxPart>

工具结果内容部分的列表

返回描述
LanguageModelToolResult

属性

工具结果内容部分的列表。包含 unknown 是因为此列表将来可能会扩展新的内容类型。

另请参阅 lm.invokeTool

LanguageModelToolResultPart

工具调用的结果。这是 工具调用 的对应部分,它只能包含在 User 消息的内容中

构造函数

参数描述
callId: string

工具调用的 ID。

content: unknown[]

工具结果的内容。

返回描述
LanguageModelToolResultPart

属性

工具调用的 ID。

请注意,这应该与工具调用部分的 callId 匹配。

工具结果的值。

LanguageModelToolTokenizationOptions

与工具调用相关的分词选项。

属性

如果已知,工具在其结果中应发出的最大 token 数。

方法

使用模型特定的分词器逻辑计算消息中的令牌数。

参数描述
text: string

一个字符串。

token?: CancellationToken

可选的取消令牌。有关如何创建一个,请参阅 CancellationTokenSource

返回描述
Thenable<number>

一个可解析为令牌数的 thenable 对象。

LanguageStatusItem

语言状态项是为活动文本编辑器呈现语言状态报告的首选方式,例如选择的 linter 或通知有关配置问题。

属性

当屏幕阅读器与此项交互时使用的辅助功能信息

控制该项是否显示为“忙碌”。默认为 false

此项的 命令

此项的可选、人类可读的详细信息。

此项的标识符。

此项的简称,例如“Java 语言状态”等。

一个 选择器,用于定义此项显示在哪些编辑器中。

此项的严重性。

默认为 information。您可以使用此属性向用户发出信号,表明存在需要注意的问题,例如缺少可执行文件或配置无效。

要显示在条目中的文本。您可以通过利用语法在文本中嵌入图标

我的文本 $(icon-name) 包含像 $(icon-name) 这样的图标。

其中 icon-name 取自 ThemeIcon 图标集,例如 light-bulbthumbsupzap 等。

方法

释放并释放相关资源。

参数描述
返回描述
void

LanguageStatusSeverity

表示语言状态的严重性级别。

枚举成员

信息严重性级别。

警告严重性级别。

错误严重性级别。

LinkedEditingRangeProvider

链接编辑范围提供程序接口定义了扩展与链接编辑功能之间的约定。

方法

对于文档中的给定位置,返回该位置的符号范围和所有具有相同内容的范围。如果新内容有效,则对其中一个范围的更改可以应用于所有其他范围。可以使用结果返回可选的单词模式来描述有效内容。如果没有提供特定于结果的单词模式,则使用语言配置中的单词模式。

参数描述
document: TextDocument

调用提供程序的文档。

position: Position

调用提供程序的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<LinkedEditingRanges>

可以一起编辑的范围列表

LinkedEditingRanges

表示可以一起编辑的范围列表以及描述有效范围内容的单词模式。

构造函数

创建一个新的链接编辑范围对象。

参数描述
ranges: Range[]

可以一起编辑的范围列表

wordPattern?: RegExp

一个可选的单词模式,用于描述给定范围的有效内容

返回描述
LinkedEditingRanges

属性

可以一起编辑的范围列表。范围必须具有相同的长度和文本内容。范围不能重叠。

一个可选的单词模式,用于描述给定范围的有效内容。如果没有提供模式,则将使用语言配置的单词模式。

Location

表示资源内的位置,例如文本文件中的一行。

构造函数

创建一个新的位置对象。

参数描述
uri: Uri

资源标识符。

rangeOrPosition: Range | Position

范围或位置。位置将转换为空范围。

返回描述
Location

属性

此位置的文档范围。

此位置的资源标识符。

表示两个位置的连接。在普通的 位置之上提供额外的元数据,包括原点范围。

属性

此链接的原点范围。

用作鼠标定义悬停的下划线范围。默认为定义位置的单词范围。

此链接的完整目标范围。

此链接的范围。

此链接的目标资源标识符。

LogLevel

日志级别

枚举成员

此级别不记录任何消息。

此级别记录所有消息。

此级别记录调试及更高级别的消息。

此级别记录信息及更高级别的消息。

此级别记录警告及更高级别的消息。

此级别仅记录错误消息。

LogOutputChannel

用于包含日志输出的通道。

要获取 LogOutputChannel 的实例,请使用 createOutputChannel

事件

当通道的日志级别更改时触发的 Event

属性

通道的当前日志级别。默认为 编辑器日志级别

此输出通道的可读名称。

方法

将给定值追加到通道。

参数描述
value: string

字符串,虚值将不会打印。

返回描述
void

将给定值和一个换行符追加到通道。

参数描述
value: string

字符串,虚值将被打印。

返回描述
void

从通道中删除所有输出。

参数描述
返回描述
void

将给定的调试消息输出到通道。

仅当通道配置为显示 调试 或更低的日志级别时,才会记录该消息。

参数描述
message: string

要记录的调试消息

...args: any[]
返回描述
void

释放并释放相关资源。

参数描述
返回描述
void

将给定的错误或错误消息输出到通道。

仅当通道配置为显示 错误 或更低的日志级别时,才会记录该消息。

参数描述
error: string | Error

要记录的错误或错误消息

...args: any[]
返回描述
void

从 UI 中隐藏此通道。

参数描述
返回描述
void

将给定的信息消息输出到通道。

仅当通道配置为显示 信息 或更低的日志级别时,才会记录该消息。

参数描述
message: string

要记录的信息消息

...args: any[]
返回描述
void

将通道中的所有输出替换为给定值。

参数描述
value: string

字符串,虚值将不会打印。

返回描述
void

在 UI 中显示此通道。

参数描述
preserveFocus?: boolean

true 时,通道不会获取焦点。

返回描述
void

在 UI 中显示此通道。

  • 已弃用 - 请使用只有一个参数的重载 (show(preserveFocus?: boolean): void)。
参数描述
column?: ViewColumn

此参数已弃用,将被忽略。

preserveFocus?: boolean

true 时,通道不会获取焦点。

返回描述
void

将给定的跟踪消息输出到通道。使用此方法记录详细信息。

仅当通道配置为显示 跟踪 日志级别时,才会记录该消息。

参数描述
message: string

要记录的跟踪消息

...args: any[]
返回描述
void

将给定的警告消息输出到通道。

仅当通道配置为显示 警告 或更低的日志级别时,才会记录该消息。

参数描述
message: string

要记录的警告消息

...args: any[]
返回描述
void

MarkdownString

人类可读的文本,支持通过 markdown 语法 进行格式化。

supportThemeIcons 设置为 true 时,支持通过 $(<name>) 语法渲染 主题图标

supportHtml 设置为 true 时,支持渲染嵌入式 html。

构造函数

使用给定值创建一个新的 markdown 字符串。

参数描述
value?: string

可选,初始值。

supportThemeIcons?: boolean

可选,指定是否在 MarkdownString 中支持 ThemeIcons

返回描述
MarkdownString

属性

相对路径解析时所基于的 Uri。

如果 baseUri/ 结尾,则将其视为目录,并且 markdown 中的相对路径将相对于该目录解析

const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/dir/');
// Here 'link' in the rendered markdown resolves to '/path/to/dir/file.js'

如果 baseUri 是一个文件,则 markdown 中的相对路径将相对于该文件的父目录解析

const md = new vscode.MarkdownString(`[link](./file.js)`);
md.baseUri = vscode.Uri.file('/path/to/otherFile.js');
// Here 'link' in the rendered markdown resolves to '/path/to/file.js'

指示此 markdown 字符串来自受信任的源。只有受信任的 markdown 支持执行命令的链接,例如 [运行它](command:myCommandId)

默认为 false(禁用命令)。

指示此 markdown 字符串可以包含原始 html 标签。默认为 false

supportHtml 为 false 时,markdown 渲染器将删除 markdown 文本中出现的任何原始 html 标签。这意味着您只能使用 markdown 语法进行渲染。

supportHtml 为 true 时,markdown 渲染器还将允许渲染安全的 html 标签和属性子集。有关所有支持的标签和属性的列表,请参见 https://github.com/microsoft/vscode/blob/6d2920473c6f13759c978dd89104c4270a83422d/src/vs/base/browser/markdownRenderer.ts#L296

指示此 markdown 字符串可以包含 ThemeIcons,例如 $(zap)

Markdown 字符串。

方法

使用提供的语言将给定的字符串追加为代码块。

参数描述
value: string

一段代码片段。

language?: string

一个可选的语言标识符

返回描述
MarkdownString

将给定的字符串“按原样”追加到此 markdown 字符串。当 supportThemeIconstrue 时,value 中的 ThemeIcons 将被图标化。

参数描述
value: string

Markdown 字符串。

返回描述
MarkdownString

将给定的字符串追加并转义到此 markdown 字符串。

参数描述
value: string

纯文本。

返回描述
MarkdownString

MarkedString

MarkedString 可以用于渲染人类可读的文本。它要么是一个 markdown 字符串,要么是一个提供语言和代码片段的代码块。请注意,markdown 字符串将被清理,这意味着 html 将被转义。

Memento

Memento 代表一个存储实用程序。它可以存储和检索值。

方法

返回值。

参数描述
key: string

一个字符串。

返回描述
T

存储的值或 undefined

返回值。

参数描述
key: string

一个字符串。

defaultValue: T

当给定键没有值 (undefined) 时应返回的值。

返回描述
T

存储的值或 defaultValue。

返回存储的键。

参数描述
返回描述
readonly string[]

存储的键。

存储一个值。该值必须是可 JSON 序列化的。

注意,使用 undefined 作为值会从底层存储中删除该键。

参数描述
key: string

一个字符串。

value: any

一个值。必须不包含循环引用。

返回描述
Thenable<void>

MessageItem

表示在信息、警告或错误消息中显示的操作。

另请参阅

属性

用于模态对话框的提示,指示当用户取消对话框(例如,按 ESC 键)时应触发该项。

注意:此选项对于非模态消息将被忽略。

简短标题,如“重试”、“打开日志”等。

MessageOptions

用于配置消息行为的选项。

另请参阅

属性

人类可读的详细信息消息,以较不突出的方式呈现。注意,详细信息仅针对 模态消息显示。

指示此消息应为模态。

NotebookCell

表示 笔记本的一个单元格,可以是 代码单元格或 标记单元格。

NotebookCell 实例是不可变的,并且只要它们是笔记本的一部分,就会保持同步。

属性

此单元格的 文本,表示为文本文档。

此单元格最新的执行摘要

此单元格在其包含笔记本中的索引。当单元格在其笔记本内移动时,索引会更新。当单元格已从其笔记本中删除时,索引为 -1

此单元格的类型。

此单元格的元数据。可以是任何内容,但必须是可 JSON 序列化的。

包含此单元格的 笔记本

此单元格的输出。

NotebookCellData

NotebookCellData 是笔记本单元格的原始表示形式。它是 NotebookData 的一部分。

构造函数

创建新的单元格数据。最少的单元格数据指定其类型、其源值以及其源的语言标识符。

参数描述
kind: NotebookCellKind

类型。

value: string

源值。

languageId: string

源值的语言标识符。

返回描述
NotebookCellData

属性

此单元格数据的执行摘要。

此单元格数据的 类型

此单元格数据源值的语言标识符。来自 getLanguages 的任何值都是可能的。

此单元格数据的任意元数据。可以是任何内容,但必须是可 JSON 序列化的。

此单元格数据的输出。

此单元格数据的源值 - 源代码或格式化文本。

NotebookCellExecution

NotebookCellExecution 是 笔记本控制器 在执行时如何修改笔记本单元格的方式。

当创建单元格执行对象时,单元格进入 [NotebookCellExecutionState.Pending 待定](#NotebookCellExecutionState.Pending 待定) 状态。当在执行任务上调用 start(...) 时,它进入 [NotebookCellExecutionState.Executing 执行中](#NotebookCellExecutionState.Executing 执行中) 状态。当调用 end(...) 时,它进入 [NotebookCellExecutionState.Idle 空闲](#NotebookCellExecutionState.Idle 空闲) 状态。

属性

创建此执行的 单元格

设置和取消设置此单元格执行的顺序。

当从 UI 取消单元格执行时将触发的取消令牌。

请注意,当创建此执行的 控制器 使用 中断处理程序 时,不会触发取消令牌。

方法

追加到正在执行的单元格的输出,或追加到受此执行影响的另一个单元格。

参数描述
out: NotebookCellOutput | readonly NotebookCellOutput[]

追加到当前输出的输出。

cell?: NotebookCell

清除输出的单元格。默认为此执行的 单元格

返回描述
Thenable<void>

一个在操作完成时解析的 thenable 对象。

将输出项追加到现有单元格输出。

参数描述
items: NotebookCellOutputItem | readonly NotebookCellOutputItem[]

追加到现有输出的输出项。

output: NotebookCellOutput

已存在的输出对象。

返回描述
Thenable<void>

一个在操作完成时解析的 thenable 对象。

清除正在执行的单元格的输出,或清除受此执行影响的另一个单元格的输出。

参数描述
cell?: NotebookCell

清除输出的单元格。默认为此执行的 单元格

返回描述
Thenable<void>

一个在操作完成时解析的 thenable 对象。

表示执行已结束。

参数描述
success: boolean

如果为 true,则在单元格状态栏上显示绿色勾号。如果为 false,则显示红色 X。如果未定义,则不显示勾号或 X 图标。

endTime?: number

执行完成的时间,以 Unix 纪元中的毫秒为单位。

返回描述
void

替换正在执行的单元格的输出,或替换受此执行影响的另一个单元格的输出。

参数描述
out: NotebookCellOutput | readonly NotebookCellOutput[]

替换当前输出的输出。

cell?: NotebookCell

清除输出的单元格。默认为此执行的 单元格

返回描述
Thenable<void>

一个在操作完成时解析的 thenable 对象。

替换现有单元格输出的所有输出项。

参数描述
items: NotebookCellOutputItem | readonly NotebookCellOutputItem[]

替换现有输出项的输出项。

output: NotebookCellOutput

已存在的输出对象。

返回描述
Thenable<void>

一个在操作完成时解析的 thenable 对象。

表示执行已开始。

参数描述
startTime?: number

执行开始的时间,以 Unix 纪元中的毫秒为单位。用于驱动显示单元格运行时间的时钟。如果未提供,则不会显示时钟。

返回描述
void

NotebookCellExecutionSummary

笔记本单元格执行的摘要。

属性

执行发生的顺序。

执行是否成功完成。

执行开始和结束的时间,以 Unix 时间戳表示

参数描述
endTime: number

执行结束时间。

startTime: number

执行开始时间。

NotebookCellKind

笔记本单元格类型。

枚举成员

标记单元格是用于显示的格式化源代码。

代码单元格是可以 执行 并产生 输出 的源代码。

NotebookCellOutput

笔记本单元格输出表示执行单元格的结果。它是多个 输出项 的容器类型,其中包含的项目表示相同的结果,但使用不同的 MIME 类型。

构造函数

创建新的笔记本输出。

参数描述
items: NotebookCellOutputItem[]

笔记本输出项。

metadata?:

可选元数据。

返回描述
NotebookCellOutput

属性

此输出的输出项。每个项必须表示相同的结果。请注意,每个输出重复的 MIME 类型无效,并且编辑器只会选择其中一个。

new vscode.NotebookCellOutput([
  vscode.NotebookCellOutputItem.text('Hello', 'text/plain'),
  vscode.NotebookCellOutputItem.text('<i>Hello</i>', 'text/html'),
  vscode.NotebookCellOutputItem.text('_Hello_', 'text/markdown'),
  vscode.NotebookCellOutputItem.text('Hey', 'text/plain') // INVALID: repeated type, editor will pick just one
]);

此单元格输出的任意元数据。可以是任何内容,但必须是可 JSON 字符串化的。

NotebookCellOutputItem

由 MIME 类型和数据定义的 笔记本输出 的一种表示形式。

静态

用于创建使用 application/vnd.code.notebook.error MIME 类型的 NotebookCellOutputItem 的工厂函数。

参数描述
value: Error

一个错误对象。

返回描述
NotebookCellOutputItem

一个新的输出项对象。

用于从 JSON 对象创建 NotebookCellOutputItem 的工厂函数。

请注意,此函数不期望“字符串化的 JSON”,而是期望一个可以被字符串化的对象。当传递的值不能被 JSON 字符串化时,此函数将抛出错误。

参数描述
value: any

一个可以 JSON 字符串化的值。

mime?: string

可选的 MIME 类型,默认为 application/json

返回描述
NotebookCellOutputItem

一个新的输出项对象。

用于创建使用 application/vnd.code.notebook.stderr MIME 类型的 NotebookCellOutputItem 的工厂函数。

参数描述
value: string

一个字符串。

返回描述
NotebookCellOutputItem

一个新的输出项对象。

用于创建使用 application/vnd.code.notebook.stdout MIME 类型的 NotebookCellOutputItem 的工厂函数。

参数描述
value: string

一个字符串。

返回描述
NotebookCellOutputItem

一个新的输出项对象。

用于从字符串创建 NotebookCellOutputItem 的工厂函数。

请注意,使用 UTF-8 编码器为字符串创建字节。

参数描述
value: string

一个字符串。

mime?: string

可选的 MIME 类型,默认为 text/plain

返回描述
NotebookCellOutputItem

一个新的输出项对象。

构造函数

创建一个新的笔记本单元格输出项。

参数描述
data: Uint8Array

输出项的值。

mime: string

输出项的 MIME 类型。

返回描述
NotebookCellOutputItem

属性

此输出项的数据。必须始终是无符号 8 位整数的数组。

MIME 类型,它确定如何解释 data 属性。

笔记本内置支持某些 MIME 类型,扩展可以添加对新类型的支持并覆盖现有类型。

NotebookCellStatusBarAlignment

表示状态栏项的对齐方式。

枚举成员

与左侧对齐。

与右侧对齐。

NotebookCellStatusBarItem

对单元格状态栏的贡献。

构造函数

创建一个新的 NotebookCellStatusBarItem。

参数描述
text: string

该项显示的文本。

alignment: NotebookCellStatusBarAlignment

该项是对齐到左侧还是右侧。

返回描述
NotebookCellStatusBarItem

属性

屏幕阅读器与此项交互时使用的辅助功能信息。

该项是对齐到左侧还是右侧。

可选的 Command 或单击时要运行的命令的标识符。

该命令必须是已知的

请注意,如果这是一个 Command 对象,则编辑器仅使用 commandarguments

该项的优先级。值较高的项将更多地显示在左侧。

该项显示的文本。

鼠标悬停在该项上时显示的工具提示。

NotebookCellStatusBarItemProvider

一个可以向单元格编辑器下方出现的状态栏添加项的提供程序。

事件

一个可选事件,用于指示状态栏项已更改。将再次调用 provide 方法。

方法

当单元格滚动到视图中、其内容、输出、语言或元数据更改以及其执行状态更改时,将调用提供程序。

参数描述
cell: NotebookCell

要为其返回项的单元格。

token: CancellationToken

如果应取消此请求,则会触发令牌。

返回描述
ProviderResult<NotebookCellStatusBarItem | NotebookCellStatusBarItem[]>

一个或多个单元格状态栏项

NotebookController

笔记本控制器表示可以执行笔记本单元格的实体。这通常被称为内核。

可以有多个控制器,并且编辑器将允许用户选择要用于特定笔记本的控制器。notebookType 属性定义控制器适用于哪种笔记本,updateNotebookAffinity 函数允许控制器为特定的笔记本文档设置首选项。选择控制器后,将触发其 onDidChangeSelectedNotebooks 事件。

当正在运行单元格时,编辑器将调用 executeHandler,并且控制器应创建并完成 笔记本单元格执行。但是,控制器也可以自行创建执行。

事件

每当为笔记本文档选择或取消选择控制器时触发的事件。

一个笔记本可以有多个控制器,在这种情况下,需要选择一个控制器。这是一个用户手势,并且在与建议使用控制器的笔记本进行交互时,会明确或隐式发生。如果可能,编辑器会建议最有可能被选择的控制器。

请注意,控制器选择是持久化的(通过控制器的 id),并在重新创建控制器或 打开笔记本时恢复。

属性

以不显眼的方式呈现的、人类可读的描述。

以不显眼的方式呈现的、人类可读的详细信息。

当在用户界面中选择运行手势时,例如“运行单元格”、“全部运行”、“运行选定内容”等,会调用执行处理程序。执行处理程序负责创建和管理执行对象。

参数描述
cells: NotebookCell[]
notebook: NotebookDocument
controller: NotebookController
返回描述
void | Thenable<void>

此笔记本控制器的标识符。

请注意,控制器是通过其标识符记住的,并且扩展应在会话中使用稳定的标识符。

可选的中断处理程序。

默认情况下,单元格执行通过令牌取消。取消令牌要求控制器能够跟踪其执行情况,以便稍后可以取消特定的执行。并非所有场景都允许这样做,例如,REPL 风格的控制器通常通过中断当前正在运行的任何内容来工作。对于这些情况,存在中断处理程序 - 可以将其视为终端中的 SIGINTControl+C 的等效项。

请注意,首选支持取消令牌,并且只有在不支持令牌时才应使用中断处理程序。

参数描述
notebook: NotebookDocument
返回描述
void | Thenable<void>

此笔记本控制器的用户可读标签。

此控制器适用的笔记本类型。

此控制器支持的语言标识符数组。可以使用来自getLanguages的任何语言标识符。当为假值时,则支持所有语言。

示例

// support JavaScript and TypeScript
myController.supportedLanguages = ['javascript', 'typescript'];

// support all languages
myController.supportedLanguages = undefined; // falsy
myController.supportedLanguages = []; // falsy

此控制器是否支持执行顺序,以便编辑器可以为其呈现占位符。

方法

创建一个单元格执行任务。

请注意,一次只能对每个单元格执行一次执行,如果在另一个执行仍在活动状态时创建单元格执行,则会引发错误。

这应该用于响应执行处理程序被调用或当单元格执行已在其他地方启动时,例如,当单元格已经在执行或当单元格执行从另一个源触发时。

参数描述
cell: NotebookCell

要为其创建执行的笔记本单元格。

返回描述
NotebookCellExecution

笔记本单元格执行。

释放并释放相关资源。

参数描述
返回描述
void

控制器可以为特定的笔记本文档设置亲和性。这允许控制器对某些笔记本更突出地显示。

参数描述
notebook: NotebookDocument

为其设置优先级的笔记本。

affinity: NotebookControllerAffinity

控制器亲和性

返回描述
void

NotebookControllerAffinity

笔记本控制器对笔记本文档的亲和性。

另请参阅 NotebookController.updateNotebookAffinity

枚举成员

默认亲和性。

控制器是笔记本的首选。

NotebookData

笔记本的原始表示形式。

扩展负责创建NotebookData,以便编辑器可以创建NotebookDocument

另请参阅 NotebookSerializer

构造函数

创建新的笔记本数据。

参数描述
cells: NotebookCellData[]

单元格数据数组。

返回描述
NotebookData

属性

此笔记本数据的单元格数据。

笔记本数据的任意元数据。

NotebookDocument

表示一个笔记本,它本身是代码或标记单元格的序列。笔记本文档是从笔记本数据创建的。

属性

笔记本中的单元格数。

如果笔记本已关闭,则为 true。关闭的笔记本不再同步,并且当再次打开相同的资源时不会被重用。

如果存在未持久化的更改,则为 true

此笔记本是否表示尚未保存的未命名文件。

此笔记本的任意元数据。可以是任何内容,但必须可 JSON 字符串化。

笔记本的类型。

此笔记本的相关 URI。

请注意,大多数笔记本使用 file 方案,这意味着它们是磁盘上的文件。但是,并非所有笔记本都保存在磁盘上,因此在尝试访问底层文件或磁盘上的同级文件之前,必须检查 scheme

另请参阅 FileSystemProvider

此笔记本的版本号(每次更改后(包括撤消/重做)都将严格增加)。

方法

返回指定索引处的单元格。索引将调整为笔记本。

参数描述
index: number

要检索的单元格的索引。

返回描述
NotebookCell

获取此笔记本的单元格。可以通过提供范围来检索子集。该范围将调整为笔记本。

参数描述
range?: NotebookRange

笔记本范围。

返回描述
NotebookCell[]

范围或所有单元格包含的单元格。

保存文档。保存将由相应的序列化程序处理。

参数描述
返回描述
Thenable<boolean>

一个 promise,当文档已保存时将解析为 true。如果文件不是脏的或保存失败,将返回 false。

NotebookDocumentCellChange

描述对笔记本单元格的更改。

另请参阅 NotebookDocumentChangeEvent

属性

受影响的单元格。

单元格的文档,或当它没有更改时为 undefined

请注意,对于详细的更改信息,例如已执行的编辑,您应该使用onDidChangeTextDocument事件。

单元格新的执行摘要,如果未更改则为 undefined

单元格新的元数据,如果未更改则为 undefined

单元格新的输出,如果未更改则为 undefined

NotebookDocumentChangeEvent

描述事务性的 笔记本 更改的事件。

属性

一个 单元格更改 的数组。

一个描述添加或删除 单元格 的内容更改的数组。

笔记本新的元数据,如果未更改则为 undefined

受影响的笔记本。

NotebookDocumentContentChange

描述笔记本文档的结构性更改,例如新添加和删除的单元格。

另请参阅 NotebookDocumentChangeEvent

属性

已添加到文档的单元格。

添加或删除单元格的范围。

请注意,当此范围为 时,没有 删除任何单元格。

已从文档中删除的单元格。

NotebookDocumentContentOptions

笔记本内容选项定义笔记本的哪些部分被持久化。请注意

例如,笔记本序列化器可以选择不保存输出,在这种情况下,当笔记本的输出发生更改时,编辑器不会将笔记本标记为 已修改

属性

控制单元格元数据属性更改事件是否会触发笔记本文档内容更改事件,以及是否会在差异编辑器中使用,默认为 false。如果内容提供程序未在文件文档中持久化元数据属性,则应将其设置为 true。

控制文档元数据属性更改事件是否会触发笔记本文档内容更改事件,以及是否会在差异编辑器中使用,默认为 false。如果内容提供程序未在文件文档中持久化元数据属性,则应将其设置为 true。

控制输出更改事件是否会触发笔记本文档内容更改事件,以及是否会在差异编辑器中使用,默认为 false。如果内容提供程序未在文件文档中持久化输出,则应将其设置为 true。

NotebookDocumentShowOptions

表示在 笔记本编辑器 中显示 笔记本文档 的行为的选项。

属性

一个可选的标志,当为 true 时,将阻止 笔记本编辑器 获取焦点。

一个可选的标志,控制 笔记本编辑器 选项卡是否显示为预览。预览选项卡将被替换和重用,直到设置为保留 - 显式或通过编辑。默认行为取决于 workbench.editor.enablePreview 设置。

一个可选的选择,用于在 笔记本编辑器 中应用于文档。

一个可选的视图列,应在其中显示 笔记本编辑器。默认值是 活动。不存在的列将按需创建,最多为 ViewColumn.Nine。使用 ViewColumn.Beside 在当前活动编辑器的旁边打开编辑器。

NotebookDocumentWillSaveEvent

笔记本文档 将被保存时触发的事件。

要在保存文档之前对其进行修改,请使用可解析为 工作区编辑 的 thenable 调用 waitUntil 函数。

属性

将被保存的 笔记本文档

触发保存的原因。

取消令牌。

方法

允许暂停事件循环并应用 工作区编辑。对此函数的后续调用的编辑将按顺序应用。如果笔记本文档发生并发修改,则这些编辑将被忽略

注意: 此函数只能在事件调度期间调用,而不能以异步方式调用

workspace.onWillSaveNotebookDocument(event => {
  // async, will *throw* an error
  setTimeout(() => event.waitUntil(promise));

  // sync, OK
  event.waitUntil(promise);
});
参数描述
thenable: Thenable<WorkspaceEdit>

可解析为 工作区编辑 的 thenable。

返回描述
void

允许暂停事件循环,直到提供的 thenable 解析。

注意: 此函数只能在事件调度期间调用。

参数描述
thenable: Thenable<any>

延迟保存的 thenable。

返回描述
void

NotebookEdit

笔记本编辑表示应应用于笔记本内容的编辑。

静态

用于创建删除笔记本中单元格的编辑的实用工具。

参数描述
range: NotebookRange

要删除的单元格范围。

返回描述
NotebookEdit

用于创建替换笔记本中单元格的编辑的实用工具。

参数描述
index: number

要插入单元格的索引。

newCells: NotebookCellData[]

新的笔记本单元格。

返回描述
NotebookEdit

用于创建替换笔记本中单元格的编辑的实用工具。

参数描述
range: NotebookRange

要替换的单元格范围

newCells: NotebookCellData[]

新的笔记本单元格。

返回描述
NotebookEdit

用于创建更新单元格元数据的编辑的实用工具。

参数描述
index: number

要更新的单元格的索引。

newCellMetadata:

单元格的新元数据。

返回描述
NotebookEdit

用于创建更新笔记本元数据的编辑操作的实用工具。

参数描述
newNotebookMetadata:

笔记本的新元数据。

返回描述
NotebookEdit

构造函数

创建一个新的笔记本编辑操作。

参数描述
range: NotebookRange

笔记本范围。

newCells: NotebookCellData[]

新的单元格数据数组。

返回描述
NotebookEdit

属性

单元格的可选新元数据。

正在插入的新单元格。可能为空。

笔记本的可选新元数据。

正在编辑的单元格的范围。可能为空。

NotebookEditor

表示附加到笔记本的笔记本编辑器。NotebookEditor 的其他属性在建议的 API 中可用,该 API 将在稍后最终确定。

属性

与此笔记本编辑器关联的笔记本文档

此笔记本编辑器中的主选择。

此笔记本编辑器中的所有选择。

主选择(或焦点范围)是 selections[0]。当文档没有单元格时,主选择为空 { start: 0, end: 0 }

此编辑器显示的列。

编辑器中当前可见的范围(垂直方向)。

方法

按照 revealType 指示的方式滚动,以显示给定的范围。

参数描述
range: NotebookRange

一个范围。

revealType?: NotebookEditorRevealType

用于显示 range 的滚动策略。

返回描述
void

NotebookEditorRevealType

表示附加到笔记本的笔记本编辑器。

枚举成员

将以尽可能少的滚动方式显示该范围。

该范围将始终在视口的中心显示。

如果该范围在视口之外,则将在视口的中心显示。否则,将以尽可能少的滚动方式显示。

该范围将始终在视口的顶部显示。

NotebookEditorSelectionChangeEvent

表示描述笔记本编辑器的选择中的更改的事件。

属性

选择已更改的笔记本编辑器

NotebookEditorVisibleRangesChangeEvent

表示描述笔记本编辑器的 visibleRanges 中的更改的事件。

属性

可见范围已更改的笔记本编辑器

NotebookRange

笔记本范围表示两个单元格索引的有序对。保证开始小于或等于结束。

构造函数

创建一个新的笔记本范围。如果 start 不在 end 之前或等于 end,则将交换这些值。

参数描述
start: number

开始索引

end: number

结束索引。

返回描述
NotebookRange

属性

此范围的独占结束索引(从零开始)。

如果 startend 相等,则为 true

此范围的从零开始的开始索引。

方法

为此范围派生一个新范围。

参数描述
change: {end: number, start: number}

描述此范围更改的对象。

返回描述
NotebookRange

反映给定更改的范围。如果更改没有任何更改,将返回 this 范围。

NotebookRendererMessaging

渲染器消息传递用于与单个渲染器通信。它从notebooks.createRendererMessaging 返回。

事件

当从渲染器接收到消息时触发的事件。

方法

向一个或所有渲染器发送消息。

参数描述
message: any

要发送的消息

editor?: NotebookEditor

要使用该消息作为目标的编辑器。如果未提供,则该消息将发送到所有渲染器。

返回描述
Thenable<boolean>

一个布尔值,指示是否已成功将消息传递到任何渲染器。

NotebookSerializer

笔记本序列化程序使编辑器能够打开笔记本文件。

编辑器的核心仅知道笔记本数据结构,但不知道如何将该数据结构写入文件,也不知道如何从文件中读取该数据结构。笔记本序列化程序通过将字节反序列化为笔记本数据,反之亦然来弥补这一差距。

方法

将笔记本文件的内容反序列化为笔记本数据结构。

参数描述
content: Uint8Array

笔记本文件的内容。

token: CancellationToken

取消令牌。

返回描述
NotebookData | Thenable<NotebookData>

笔记本数据或解析为该数据的 Thenable 对象。

将笔记本数据序列化为文件内容。

参数描述
data: NotebookData

笔记本数据结构。

token: CancellationToken

取消令牌。

返回描述
Uint8Array | Thenable<Uint8Array>

字节数组,或解析为此数组的 thenable 对象。

OnEnterRule

描述按下 Enter 键时要评估的规则。

属性

要执行的操作。

仅当光标后的文本与此正则表达式匹配时,此规则才会执行。

仅当光标前的文本与此正则表达式匹配时,此规则才会执行。

仅当当前行上面的文本与此正则表达式匹配时,此规则才会执行。

OnTypeFormattingEditProvider

文档格式设置提供程序接口定义了扩展与格式设置功能之间的约定。

方法

在键入字符后提供格式化编辑。

给定的位置和字符应该提示提供程序要扩展到的位置范围,例如当输入 } 时查找匹配的 {

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

ch: string

已键入的字符。

options: FormattingOptions

控制格式设置的选项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或可解析为此的 thenable。可以通过返回 undefinednull 或空数组来表示缺少结果。

OpenDialogOptions

用于配置文件打开对话框行为的选项。

  • 注意 1:在 Windows 和 Linux 上,文件对话框不能同时是文件选择器和文件夹选择器,因此如果在这些平台上将 canSelectFilescanSelectFolders 都设置为 true,则会显示文件夹选择器。
  • 注意 2:显式将 canSelectFilescanSelectFolders 设置为 false 是徒劳的,编辑器会默默地调整选项以选择文件。

属性

允许选择文件,默认为 true

允许选择文件夹,默认为 false

允许选择多个文件或文件夹。

打开时对话框显示的资源。

对话框使用的一组文件筛选器。每个条目都是一个人类可读的标签,例如“TypeScript”,以及一个扩展名数组,例如

{
    'Images': ['png', 'jpg'],
    'TypeScript': ['ts', 'tsx']
}

用于打开按钮的人类可读字符串。

对话框标题。

此参数可能会被忽略,因为并非所有操作系统都在打开对话框上显示标题(例如 macOS)。

OutputChannel

输出通道是只读文本信息的容器。

要获取 OutputChannel 的实例,请使用 createOutputChannel

属性

此输出通道的可读名称。

方法

将给定值追加到通道。

参数描述
value: string

字符串,虚值将不会打印。

返回描述
void

将给定值和一个换行符追加到通道。

参数描述
value: string

字符串,虚值将被打印。

返回描述
void

从通道中删除所有输出。

参数描述
返回描述
void

释放并释放相关资源。

参数描述
返回描述
void

从 UI 中隐藏此通道。

参数描述
返回描述
void

将通道中的所有输出替换为给定值。

参数描述
value: string

字符串,虚值将不会打印。

返回描述
void

在 UI 中显示此通道。

参数描述
preserveFocus?: boolean

true 时,通道不会获取焦点。

返回描述
void

在 UI 中显示此通道。

  • 已弃用 - 请使用只有一个参数的重载 (show(preserveFocus?: boolean): void)。
参数描述
column?: ViewColumn

此参数已弃用,将被忽略。

preserveFocus?: boolean

true 时,通道不会获取焦点。

返回描述
void

OverviewRulerLane

表示在 概览标尺 中渲染装饰的不同位置。概览标尺支持三个通道。

枚举成员

概览标尺的左侧通道。

概览标尺的中心通道。

概览标尺的右侧通道。

概览标尺的所有通道。

ParameterInformation

表示可调用签名的参数。参数可以有标签和文档注释。

构造函数

创建新的参数信息对象。

参数描述
label: string | [number, number]

标签字符串或其包含的签名标签内的包含开始和不包含结束偏移量。

documentation?: string | MarkdownString

文档字符串。

返回描述
ParameterInformation

属性

此签名的用户可读文档注释。 将会显示在 UI 中,但可以省略。

此签名的标签。

可以是字符串,也可以是在其包含的签名标签内的包含开始和不包含结束的偏移量。注意:字符串类型的标签必须是其包含的签名信息的标签的子字符串。

Position

表示行和字符位置,例如光标的位置。

Position 对象是不可变的。使用withtranslate方法从现有位置派生新位置。

构造函数

参数描述
line: number

从零开始的行值。

character: number

从零开始的字符值。

返回描述
Position

属性

从零开始的字符值。

从零开始的行值。

方法

将此位置与 other 进行比较。

参数描述
other: Position

一个位置。

返回描述
number

如果此位置在给定位置之前,则该数字小于零;如果此位置在给定位置之后,则该数字大于零;如果此位置和给定位置相等,则为零。

检查此位置是否在 other 之后。

参数描述
other: Position

一个位置。

返回描述
布尔值

如果位置在更大的行上,或者在同一行上的更大字符上,则为 true

检查此位置是否在 other 之后或与之相等。

参数描述
other: Position

一个位置。

返回描述
布尔值

如果位置在更大的行上,或者在同一行上的更大或相等字符上,则为 true

检查此位置是否在 other 之前。

参数描述
other: Position

一个位置。

返回描述
布尔值

如果位置在更小的行上,或者在同一行上的更小字符上,则为 true

检查此位置是否在 other 之前或与之相等。

参数描述
other: Position

一个位置。

返回描述
布尔值

如果位置在更小的行上,或者在同一行上的更小或相等字符上,则为 true

检查此位置是否与 other 相等。

参数描述
other: Position

一个位置。

返回描述
布尔值

如果给定位置的行和字符与此位置的行和字符相等,则为 true

创建相对于此位置的新位置。

参数描述
lineDelta?: number

行值的增量值,默认为 0

characterDelta?: number

字符值的增量值,默认为 0

返回描述
Position

一个位置,其行和字符是当前行和字符与相应增量的总和。

派生相对于此位置的新位置。

参数描述
change: {characterDelta: number, lineDelta: number}

一个描述此位置增量的对象。

返回描述
Position

反映给定增量的位置。如果更改没有更改任何内容,则将返回 this 位置。

创建一个从此位置派生的新位置。

参数描述
line?: number

应该用作行的值,默认为现有值

character?: number

应该用作字符的值,默认为现有值

返回描述
Position

一个行和字符被给定值替换的位置。

从此位置派生新位置。

参数描述
change: {character: number, line: number}

一个描述此位置更改的对象。

返回描述
Position

一个反映给定更改的位置。如果更改没有更改任何内容,则将返回 this 位置。

PreparedToolInvocation

属性

此属性的存在表示在运行该工具之前应要求用户确认。对于任何具有副作用或可能存在潜在危险的工具,应要求用户进行确认。

在工具运行时要显示的自定义进度消息。

ProcessExecution

任务的执行发生在没有 shell 交互的外部进程中。

构造函数

创建进程执行。

参数描述
process: string

要启动的进程。

options?: ProcessExecutionOptions

启动进程的可选选项。

返回描述
ProcessExecution

创建进程执行。

参数描述
process: string

要启动的进程。

args: string[]

要传递给进程的参数。

options?: ProcessExecutionOptions

启动进程的可选选项。

返回描述
ProcessExecution

属性

传递给进程的参数。默认为空数组。

执行进程时使用的进程选项。默认为 undefined。

要执行的进程。

ProcessExecutionOptions

进程执行的选项

属性

执行的程序或 shell 的当前工作目录。如果省略,则使用工具的当前工作区根目录。

执行的程序或 shell 的附加环境。如果省略,则使用父进程的环境。如果提供,则将其与父进程的环境合并。

Progress<T>

定义一种通用的报告进度更新的方式。

方法

报告进度更新。

参数描述
value: T

一个进度项,例如消息和/或关于已完成多少工作的报告

返回描述
void

ProgressLocation

编辑器中可以显示进度信息的位置。进度在视觉上的呈现方式取决于位置。

枚举成员

为源代码管理视图显示进度,作为图标的覆盖层和视图内的进度条(当可见时)。两者都不支持取消、离散进度或描述操作的标签。

在编辑器的状态栏中显示进度。两者都不支持取消或离散进度。支持通过进度标签中的 $(<name>) 语法渲染主题图标

将进度显示为带有可选取消按钮的通知。支持显示无限和离散进度,但不支持渲染图标。

ProgressOptions

描述进度应在何处以及如何显示的值对象。

属性

控制是否应显示取消按钮,以允许用户取消长时间运行的操作。请注意,目前只有 ProgressLocation.Notification 支持显示取消按钮。

应显示进度的位置。

一个人类可读的字符串,用于描述操作。

ProviderResult<T>

提供程序结果表示提供程序(如 HoverProvider)可能返回的值。对于一次,这是实际结果类型 T,如 Hover,或解析为该类型 T 的 thenable。此外,可以返回 nullundefined - 直接返回或从 thenable 返回。

下面的代码片段都是 HoverProvider 的有效实现

let a: HoverProvider = {
  provideHover(doc, pos, token): ProviderResult<Hover> {
    return new Hover('Hello World');
  }
};

let b: HoverProvider = {
  provideHover(doc, pos, token): ProviderResult<Hover> {
    return new Promise(resolve => {
      resolve(new Hover('Hello World'));
    });
  }
};

let c: HoverProvider = {
  provideHover(doc, pos, token): ProviderResult<Hover> {
    return; // undefined
  }
};

Pseudoterminal

定义终端 pty 的接口,使扩展能够控制终端。

事件

当触发此事件时,允许更改终端的名称。

在调用 Pseudoterminal.open 之前触发的事件将被忽略。

示例: 将终端名称更改为“我的新终端”。

const writeEmitter = new vscode.EventEmitter<string>();
const changeNameEmitter = new vscode.EventEmitter<string>();
const pty: vscode.Pseudoterminal = {
  onDidWrite: writeEmitter.event,
  onDidChangeName: changeNameEmitter.event,
  open: () => changeNameEmitter.fire('My new terminal'),
  close: () => {}
};
vscode.window.createTerminal({ name: 'My terminal', pty });

当触发此事件时,将发出 pty 已关闭并释放终端的信号。

在调用 Pseudoterminal.open 之前触发的事件将被忽略。

可以使用数字为终端提供退出代码。退出代码必须为正数,非零退出代码表示失败,这将显示常规终端的通知,并允许在使用 CustomExecution API 时继续进行相关的任务。

示例: 当按下“y”时退出终端,否则显示通知。

const writeEmitter = new vscode.EventEmitter<string>();
const closeEmitter = new vscode.EventEmitter<void>();
const pty: vscode.Pseudoterminal = {
  onDidWrite: writeEmitter.event,
  onDidClose: closeEmitter.event,
  open: () => writeEmitter.fire('Press y to exit successfully'),
  close: () => {},
  handleInput: data => {
    if (data !== 'y') {
      vscode.window.showInformationMessage('Something went wrong');
    }
    closeEmitter.fire();
  }
};
const terminal = vscode.window.createTerminal({ name: 'Exit example', pty });
terminal.show(true);

当触发此事件时,允许覆盖终端的尺寸。请注意,当设置后,覆盖的尺寸只有在小于终端的实际尺寸时才会生效(即,永远不会出现滚动条)。设置为 undefined 时,终端将返回到常规尺寸(适合面板的大小)。

在调用 Pseudoterminal.open 之前触发的事件将被忽略。

示例: 将终端的尺寸覆盖为 20 列和 10 行

const dimensionsEmitter = new vscode.EventEmitter<vscode.TerminalDimensions>();
const pty: vscode.Pseudoterminal = {
  onDidWrite: writeEmitter.event,
  onDidOverrideDimensions: dimensionsEmitter.event,
  open: () => {
    dimensionsEmitter.fire({
      columns: 20,
      rows: 10
    });
  },
  close: () => {}
};
vscode.window.createTerminal({ name: 'My terminal', pty });

当触发此事件时,会将数据写入终端。与将文本发送到基础子伪设备(子设备)的 Terminal.sendText 不同,这会将文本写入父伪设备(终端本身)。

请注意,写入 \n 只会将光标向下移动 1 行,您还需要写入 \r 以将光标移动到最左边的单元格。

在调用 Pseudoterminal.open 之前触发的事件将被忽略。

示例: 将红色文本写入终端

const writeEmitter = new vscode.EventEmitter<string>();
const pty: vscode.Pseudoterminal = {
  onDidWrite: writeEmitter.event,
  open: () => writeEmitter.fire('\x1b[31mHello world\x1b[0m'),
  close: () => {}
};
vscode.window.createTerminal({ name: 'My terminal', pty });

示例: 将光标移动到第 10 行和第 20 列,并写入一个星号

writeEmitter.fire('\x1b[10;20H*');

方法

实现以处理用户关闭终端的情况。

参数描述
返回描述
void

实现以处理终端中传入的击键,或当扩展调用 Terminal.sendText 时的情况。data 包含序列化为其相应 VT 序列表示形式的击键/文本。

参数描述
data: string

传入的数据。

示例: 在终端中回显输入。回车键 (\r) 的序列转换为 CRLF,以转到新行并将光标移动到行首。

const writeEmitter = new vscode.EventEmitter<string>();
const pty: vscode.Pseudoterminal = {
  onDidWrite: writeEmitter.event,
  open: () => {},
  close: () => {},
  handleInput: data => writeEmitter.fire(data === '\r' ? '\r\n' : data)
};
vscode.window.createTerminal({ name: 'Local echo', pty });
返回描述
void

实现以处理何时打开 pty 并准备开始触发事件的情况。

参数描述
initialDimensions: TerminalDimensions

终端的尺寸,如果终端面板在调用此方法之前没有打开过,则此值将为 undefined。

返回描述
void

实现以处理当适合终端面板的行数和列数发生更改时的情况,例如当字体大小更改或面板大小调整时。在触发此方法之前,终端尺寸的初始状态应视为 undefined,因为直到它显示在用户界面中,终端的大小才是已知的。

当尺寸被 onDidOverrideDimensions 覆盖时,setDimensions 将继续使用常规面板尺寸进行调用,从而允许扩展继续对尺寸更改做出反应。

参数描述
dimensions: TerminalDimensions

新的尺寸。

返回描述
void

QuickDiffProvider

快速差异提供程序为修改资源的原始状态提供 uri。编辑器将使用此信息在文本中呈现临时差异。

方法

为任何给定资源 uri 提供原始资源的 Uri

参数描述
uri: Uri

在文本编辑器中打开的资源的 uri。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Uri>

一个 thenable,解析为匹配的原始资源的 uri。

QuickInput

一个轻量级的用户输入 UI,最初不可见。通过其属性配置后,扩展可以通过调用 QuickInput.show 使其可见。

此 UI 可能必须隐藏的原因有多种,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide,用户按 Esc 键,打开其他输入 UI 等。)

用户按下 Enter 或其他表示接受当前状态的手势不会自动隐藏此 UI 组件。扩展可以决定是否接受用户的输入,以及是否应通过调用 QuickInput.hide 来隐藏 UI。

当扩展不再需要此输入 UI 时,它应 QuickInput.dispose 它,以便释放与其关联的任何资源。

有关具体的 UI,请参阅 QuickPickInputBox

事件

一个事件,指示此输入 UI 何时隐藏。

此 UI 可能必须隐藏的原因有多种,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide,用户按 Esc 键,打开其他输入 UI 等。)

属性

UI 是否应显示进度指示器。默认为 false。

例如,在加载更多数据或验证用户输入时,将此更改为 true。

UI 是否应允许用户输入。默认为 true。

例如,在验证用户输入或为用户输入的下一步加载数据时,将此更改为 false。

即使失去 UI 焦点,UI 是否也应保持打开状态。默认为 false。此设置在 iPad 上被忽略,并且始终为 false。

可选的当前步骤计数。

可选的标题。

可选的总步骤计数。

方法

释放此输入 UI 和任何关联的资源。如果它仍然可见,则首先将其隐藏。在此调用之后,输入 UI 不再起作用,并且不应访问其上的任何其他方法或属性。而是应该创建一个新的输入 UI。

参数描述
返回描述
void

隐藏此输入 UI。 这也会触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

使其当前配置中的输入 UI 可见。任何其他输入 UI 将首先触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

QuickInputButton

QuickPickInputBox 中执行操作的按钮。

属性

按钮的图标。

可选的工具提示。

QuickInputButtons

QuickPickInputBox 预定义的按钮。

静态

用于 QuickPickInputBox 的后退按钮。

当需要导航“后退”按钮时,应使用此按钮以保持一致性。它带有预定义的图标、工具提示和位置。

QuickPick<T>

一个具体的 QuickInput,允许用户从 T 类型项的列表中选择一个项。这些项可以通过过滤器文本字段进行过滤,并且有一个选项 canSelectMany 允许选择多个项。

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

事件

当用户表示接受所选项目时发出的事件信号。

当活动项发生更改时发出的事件信号。

当选定项发生更改时发出的事件信号。

当过滤器文本的值发生更改时发出的事件信号。

一个事件,指示此输入 UI 何时隐藏。

此 UI 可能必须隐藏的原因有多种,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide,用户按 Esc 键,打开其他输入 UI 等。)

当触发顶级按钮(存储在 buttons 中的按钮)时发出的事件信号。此事件不会为 QuickPickItem 上的按钮触发。

当触发特定 QuickPickItem 中的按钮时发出的事件信号。此事件不会为标题栏中的按钮触发。

属性

活动项。扩展可以读取和更新此项。

UI 是否应显示进度指示器。默认为 false。

例如,在加载更多数据或验证用户输入时,将此更改为 true。

UI 中操作的按钮。

是否可以同时选择多个项。默认为 false。

UI 是否应允许用户输入。默认为 true。

例如,在验证用户输入或为用户输入的下一步加载数据时,将此更改为 false。

即使失去 UI 焦点,UI 是否也应保持打开状态。默认为 false。此设置在 iPad 上被忽略,并且始终为 false。

从中选择的项。扩展可以读取和更新此项。

一个可选标志,用于在更新快速选择项时保持快速选择的滚动位置。默认为 false。

是否还应将过滤器文本与项的描述进行匹配。默认为 false。

是否还应将过滤器文本与项的详细信息进行匹配。默认为 false。

未输入任何过滤器时,在过滤器文本框中显示的可选占位符。

选定项。扩展可以读取和更新此项。

可选的当前步骤计数。

可选的标题。

可选的总步骤计数。

过滤器文本的当前值。

方法

释放此输入 UI 和任何关联的资源。如果它仍然可见,则首先将其隐藏。在此调用之后,输入 UI 不再起作用,并且不应访问其上的任何其他方法或属性。而是应该创建一个新的输入 UI。

参数描述
返回描述
void

隐藏此输入 UI。 这也会触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

使其当前配置中的输入 UI 可见。任何其他输入 UI 将首先触发 QuickInput.onDidHide 事件。

参数描述
返回描述
void

QuickPickItem

表示可以从项列表中选择的项。

属性

始终显示此项。

注意:当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略

将在此特定项上呈现的可选按钮。单击这些按钮将触发 QuickPickItemButtonEvent。仅在使用由 createQuickPick() API 创建的快速选择时才会呈现按钮。当使用 showQuickPick() API 时,不会呈现按钮。

注意:当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略

一个人类可读的字符串,在同一行中以不那么突出的方式呈现。支持通过 $(<name>) 语法渲染主题图标

注意:当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略

一个人类可读的字符串,在单独的一行中以不那么突出的方式呈现。支持通过 $(<name>) 语法渲染主题图标

注意:当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略

QuickPickItem 的图标路径或 ThemeIcon

QuickPickItem 的种类,它将决定此项目在快速选择中的呈现方式。如果未指定,则默认值为 QuickPickItemKind.Default

一个人类可读的字符串,以突出的方式呈现。支持通过 $(<name>) 语法渲染主题图标

可选标志,指示此项目是否在初始时被选中。仅在使用 showQuickPick() API 时才生效。要使用 createQuickPick() API 实现相同的功能,只需将 QuickPick.selectedItems 设置为您希望初始选中的项目。(注意: 仅当选择器允许多项选择时,此项才生效。)

另请参阅 QuickPickOptions.canPickMany

注意:当 kind 设置为 QuickPickItemKind.Separator 时,此属性将被忽略

QuickPickItemButtonEvent<T>

当触发特定 QuickPickItem 中的按钮时发出的事件信号。此事件不会为标题栏中的按钮触发。

属性

被单击的按钮。

按钮所属的项目。

QuickPickItemKind

快速选择项目的种类。

枚举成员

QuickPickItem的种类为Separator时,该项目只是一个视觉分隔符,不代表真实的项目。唯一适用的属性是label QuickPickItem上的所有其他属性都将被忽略,不起作用。

默认的QuickPickItem.kind是一个可以在快速选择中选择的项目。

QuickPickOptions

用于配置快速选择 UI 行为的选项。

事件

一个可选的函数,在每次选择项目时调用。

参数描述
item: string | QuickPickItem
返回描述
any

属性

一个可选标志,用于使选择器接受多项选择,如果为 true,则结果是选择的数组。

设置为 true 可在焦点移动到编辑器的其他部分或另一个窗口时保持选择器打开。此设置在 iPad 上被忽略,并且始终为 false。

一个可选标志,用于在筛选选择时包含描述。

一个可选标志,用于在筛选选择时包含详细信息。

一个可选字符串,在输入框中显示为占位符,以指导用户选择内容。

一个可选字符串,表示快速选择的标题。

Range

范围表示两个位置的有序对。保证 start.isBeforeOrEqual(end)

Range 对象是不可变的。使用 withintersectionunion 方法从现有范围派生新范围。

构造函数

从两个位置创建新范围。如果 start 不在 end 之前或等于 end,则将交换这些值。

参数描述
start: Position

一个位置。

end: Position

一个位置。

返回描述
Range

从数字坐标创建新范围。它等同于使用 new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter)) 的简短形式。

参数描述
startLine: number

从零开始的行值。

startCharacter: number

从零开始的字符值。

endLine: number

从零开始的行值。

endCharacter: number

从零开始的字符值。

返回描述
Range

属性

结束位置。它在 start 之后或等于 start

如果 startend 相等,则为 true

如果 start.lineend.line 相等,则为 true

起始位置。它在 end 之前或等于 end

方法

检查此范围是否包含某个位置或范围。

参数描述
positionOrRange: Range | Position

位置或范围。

返回描述
布尔值

如果位置或范围在此范围内部或等于此范围,则为 true

range 与此范围相交,并返回新范围;如果范围没有重叠,则返回 undefined

参数描述
range: Range

一个范围。

返回描述
Range

具有较大起始位置和较小结束位置的范围。当没有重叠时,将返回 undefined。

检查 other 是否等于此范围。

参数描述
other: Range

一个范围。

返回描述
布尔值

当起始位置和结束位置与此范围的起始位置和结束位置相等时,为 true

计算 other 与此范围的并集。

参数描述
other: Range

一个范围。

返回描述
Range

具有较小起始位置和较大结束位置的范围。

从此范围派生新范围。

参数描述
start?: Position

应该用作起始位置的位置。默认值是当前起始位置

end?: Position

应该用作结束位置的位置。默认值是当前结束位置

返回描述
Range

一个从此范围派生的、具有给定起始和结束位置的范围。如果起始位置和结束位置相同,将返回 this 范围。

从此范围派生新范围。

参数描述
change: {end: Position, start: Position}

描述此范围更改的对象。

返回描述
Range

反映给定更改的范围。如果更改没有任何更改,将返回 this 范围。

ReferenceContext

一个值对象,在请求引用时包含其他信息。

属性

包含当前符号的声明。

ReferenceProvider

引用提供程序接口定义了扩展和查找引用功能之间的约定。

方法

为给定位置和文档提供一组项目范围的引用。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

context: ReferenceContext

有关引用请求的其他信息。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Location[]>

位置数组或一个可以解析为位置数组的 thenable。可以通过返回 undefinednull 或一个空数组来表示缺少结果。

RelativePattern

相对模式是一个帮助构造 glob 模式的工具,这些模式是相对于基本文件路径进行匹配的。基本路径可以是绝对文件路径(字符串或 uri)或工作区文件夹,这是创建相对模式的首选方式。

构造函数

创建一个新的相对模式对象,其中包含基本文件路径和要匹配的模式。此模式将在相对于基本路径的文件路径上进行匹配。

示例

const folder = vscode.workspace.workspaceFolders?.[0];
if (folder) {
  // Match any TypeScript file in the root of this workspace folder
  const pattern1 = new vscode.RelativePattern(folder, '*.ts');

  // Match any TypeScript file in `someFolder` inside this workspace folder
  const pattern2 = new vscode.RelativePattern(folder, 'someFolder/*.ts');
}
参数描述
base: string | Uri | WorkspaceFolder

此模式将相对于其匹配的基本路径。如果模式应在工作区内匹配,建议传入工作区文件夹。否则,仅当模式用于工作区之外的文件路径时,才应使用 uri 或字符串。

pattern: string

类似于 *.{ts,js} 的文件 glob 模式,将在相对于基本路径的路径上进行匹配。

返回描述
RelativePattern

属性

一个基本文件路径,此模式将相对于其匹配。

这与RelativePattern.baseUrifsPath 值匹配。

注意:更新此值将更新RelativePattern.baseUri,使其成为具有 file 方案的 uri。

一个基本文件路径,此模式将相对于其匹配。文件路径必须是绝对路径,不应包含任何尾随路径分隔符,也不应包含任何相对段(...)。

类似于 *.{ts,js} 的文件 glob 模式,将在相对于基本路径的文件路径上进行匹配。

示例:给定基本路径为 /home/work/folder 和文件路径为 /home/work/folder/index.js,文件 glob 模式将匹配 index.js

RenameProvider

重命名提供程序接口定义了扩展和重命名功能之间的约定。

方法

用于在运行重命名之前解析和验证位置的可选函数。结果可以是范围或范围和占位符文本。占位符文本应为正在重命名的符号的标识符 - 如果省略,则使用返回的范围中的文本。

注意:当提供的位置不允许重命名时,此函数应抛出错误或返回一个被拒绝的 thenable。

参数描述
document: TextDocument

将在其中调用重命名的文档。

position: Position

将在其中调用重命名的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Range | {placeholder: string, range: Range}>

要重命名的标识符的范围或范围和占位符文本。可以通过返回 undefinednull 来表示缺少结果。

提供一个编辑,描述为了将符号重命名为其他名称而必须对一个或多个资源进行的更改。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

newName: string

符号的新名称。如果给定的名称无效,提供程序必须返回一个被拒绝的 promise。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<WorkspaceEdit>

工作区编辑或一个可以解析为工作区编辑的 thenable。可以通过返回 undefinednull 来表示缺少结果。

RunOptions

任务的运行选项。

属性

控制是否在重新运行时重新评估任务变量。

SaveDialogOptions

用于配置文件保存对话框行为的选项。

属性

打开时对话框显示的资源。

对话框使用的一组文件筛选器。每个条目都是一个人类可读的标签,例如“TypeScript”,以及一个扩展名数组,例如

{
    'Images': ['png', 'jpg'],
    'TypeScript': ['ts', 'tsx']
}

用于保存按钮的易于理解的字符串。

对话框标题。

此参数可能会被忽略,因为并非所有操作系统都会在保存对话框上显示标题(例如,macOS)。

SecretStorage

表示用于存储加密的机密(或任何敏感信息)的存储实用程序。机密存储的实现将在每个平台上有所不同,并且机密不会在机器之间同步。

事件

当存储或删除机密时触发。

方法

从存储中删除机密。

参数描述
key: string

存储机密所用的键。

返回描述
Thenable<void>

检索使用键存储的密钥。如果不存在与该键匹配的密码,则返回 undefined。

参数描述
key: string

存储机密所用的键。

返回描述
Thenable<string>

存储的值或 undefined

在给定的键下存储一个密钥。

参数描述
key: string

用于存储密钥的键。

value: string

密钥。

返回描述
Thenable<void>

SecretStorageChangeEvent

当添加或删除密钥时触发的事件数据。

属性

已更改的密钥的键。

SelectedCompletionInfo

描述当前选定的补全项。

属性

如果接受此补全项,将替换的范围。

如果接受此补全,该范围将替换为的文本。

Selection

表示编辑器中的文本选择。

构造函数

从两个位置创建一个选择。

参数描述
anchor: Position

一个位置。

active: Position

一个位置。

返回描述
选择

从四个坐标创建一个选择。

参数描述
anchorLine: number

从零开始的行值。

anchorCharacter: number

从零开始的字符值。

activeLine: number

从零开始的行值。

activeCharacter: number

从零开始的字符值。

返回描述
选择

属性

光标的位置。此位置可能在anchor之前或之后。

选择开始的位置。此位置可能在active之前或之后。

结束位置。它在 start 之后或等于 start

如果 startend 相等,则为 true

如果选择的anchorend位置,则该选择是反向的。

如果 start.lineend.line 相等,则为 true

起始位置。它在 end 之前或等于 end

方法

检查此范围是否包含某个位置或范围。

参数描述
positionOrRange: Range | Position

位置或范围。

返回描述
布尔值

如果位置或范围在此范围内部或等于此范围,则为 true

range 与此范围相交,并返回新范围;如果范围没有重叠,则返回 undefined

参数描述
range: Range

一个范围。

返回描述
Range

具有较大起始位置和较小结束位置的范围。当没有重叠时,将返回 undefined。

检查 other 是否等于此范围。

参数描述
other: Range

一个范围。

返回描述
布尔值

当起始位置和结束位置与此范围的起始位置和结束位置相等时,为 true

计算 other 与此范围的并集。

参数描述
other: Range

一个范围。

返回描述
Range

具有较小起始位置和较大结束位置的范围。

从此范围派生新范围。

参数描述
start?: Position

应该用作起始位置的位置。默认值是当前起始位置

end?: Position

应该用作结束位置的位置。默认值是当前结束位置

返回描述
Range

一个从此范围派生的、具有给定起始和结束位置的范围。如果起始位置和结束位置相同,将返回 this 范围。

从此范围派生新范围。

参数描述
change: {end: Position, start: Position}

描述此范围更改的对象。

返回描述
Range

反映给定更改的范围。如果更改没有任何更改,将返回 this 范围。

SelectionRange

选择范围表示选择层次结构的一部分。一个选择范围可能有一个包含它的父选择范围。

构造函数

创建一个新的选择范围。

参数描述
range: Range

选择范围的范围。

parent?: SelectionRange

选择范围的父级。

返回描述
选择范围

属性

包含此范围的父选择范围。

此选择范围的Range

SelectionRangeProvider

选择范围提供程序接口定义了扩展和“扩展和收缩选择”功能之间的约定。

方法

为给定位置提供选择范围。

应该为每个位置单独且独立地计算选择范围。编辑器将合并和删除重复范围,但提供程序必须返回选择范围的层次结构,以便范围被其父级包含

参数描述
document: TextDocument

调用命令的文档。

positions: readonly Position[]

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<SelectionRange[]>

选择范围或可解析为选择范围的 thenable。可以通过返回 undefinednull 来表示缺少结果。

SemanticTokens

表示语义标记,可以在一个范围或整个文档中。

另请参阅

构造函数

创建新的语义标记。

参数描述
data: Uint32Array

标记数据。

resultId?: string

结果标识符。

返回描述
语义标记

属性

实际的标记数据。

另请参阅provideDocumentSemanticTokens,了解格式的说明。

令牌的结果 ID。

这个 ID 将被传递给 DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits(如果已实现)。

SemanticTokensBuilder

语义令牌构建器可以帮助创建 SemanticTokens 实例,其中包含增量编码的语义令牌。

构造函数

创建一个语义令牌构建器。

参数描述
legend?: SemanticTokensLegend

一个语义令牌图例。

返回描述
SemanticTokensBuilder

方法

完成并创建一个 SemanticTokens 实例。

参数描述
resultId?: string
返回描述
语义标记

添加另一个令牌。

参数描述
line: number

令牌起始行号(绝对值)。

char: number

令牌起始字符(绝对值)。

length: number

令牌的字符长度。

tokenType: number

编码后的令牌类型。

tokenModifiers?: number

编码后的令牌修饰符。

返回描述
void

添加另一个令牌。仅在提供图例时使用。

参数描述
range: Range

令牌的范围。必须是单行。

tokenType: string

令牌类型。

tokenModifiers?: readonly string[]

令牌修饰符。

返回描述
void

SemanticTokensEdit

表示对语义令牌的编辑。

另请参阅 provideDocumentSemanticTokensEdits 以了解格式的说明。

构造函数

创建一个语义令牌编辑。

参数描述
start: number

起始偏移量

deleteCount: number

要删除的元素数量。

data?: Uint32Array

要插入的元素

返回描述
SemanticTokensEdit

属性

要插入的元素。

要删除的元素计数。

编辑的起始偏移量。

SemanticTokensEdits

表示对语义令牌的编辑。

另请参阅 provideDocumentSemanticTokensEdits 以了解格式的说明。

构造函数

创建新的语义令牌编辑。

参数描述
edits: SemanticTokensEdit[]

语义令牌编辑的数组

resultId?: string

结果标识符。

返回描述
SemanticTokensEdits

属性

对令牌数据的编辑。所有编辑都参考初始数据状态。

令牌的结果 ID。

这个 ID 将被传递给 DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits(如果已实现)。

SemanticTokensLegend

语义令牌图例包含解密语义令牌整数编码表示所需的必要信息。

构造函数

创建一个语义令牌图例。

参数描述
tokenTypes: string[]

令牌类型的数组。

tokenModifiers?: string[]

令牌修饰符的数组。

返回描述
SemanticTokensLegend

属性

可能的令牌修饰符。

可能的令牌类型。

ShellExecution

表示在 shell 中发生的任务执行。

构造函数

使用完整的命令行创建 shell 执行。

参数描述
commandLine: string

要执行的命令行。

options?: ShellExecutionOptions

启动 shell 的可选选项。

返回描述
ShellExecution

使用命令和参数创建 shell 执行。 对于实际执行,编辑器将从命令和参数构建命令行。 这会受到解释,尤其是在涉及引用时。 如果需要完全控制命令行,请使用使用完整命令行创建 ShellExecution 的构造函数。

参数描述
command: string | ShellQuotedString

要执行的命令。

args: Array<string | ShellQuotedString>

命令参数。

options?: ShellExecutionOptions

启动 shell 的可选选项。

返回描述
ShellExecution

属性

shell 参数。如果使用完整命令行创建,则为 undefined

shell 命令。如果使用完整命令行创建,则为 undefined

shell 命令行。如果使用命令和参数创建,则为 undefined

在 shell 中执行命令行时使用的 shell 选项。默认为 undefined。

ShellExecutionOptions

shell 执行的选项

属性

执行的 shell 的当前工作目录。 如果省略,则使用工具的当前工作区根目录。

执行的 shell 的附加环境。 如果省略,则使用父进程的环境。 如果提供,它将与父进程的环境合并。

shell 可执行文件。

传递给用于运行任务的 shell 可执行文件的参数。大多数 shell 需要特殊的参数来执行命令。例如,bash 需要 -c 参数来执行命令,PowerShell 需要 -Command,而 cmd 则需要 /d/c

此 shell 支持的 shell 引号。

ShellQuotedString

一个字符串,将根据使用的 shell 进行引用。

属性

要使用的引用样式。

实际的字符串值。

ShellQuoting

定义如果参数包含空格或不支持的字符时应如何引用。

枚举成员

应使用字符转义。例如,这在 bash 上使用 \,在 PowerShell 上使用 `。

应使用强字符串引用。例如,这在 Windows cmd 上使用 ",在 bash 和 PowerShell 上使用 '。强引用将参数视为字面字符串。在 PowerShell 中,echo 'The value is $(2 * 3)' 将打印 The value is $(2 * 3)

应使用弱字符串引用。例如,这在 Windows cmd、bash 和 PowerShell 上都使用 "。弱引用仍然在引用的字符串内执行某种评估。在 PowerShell 中,echo "The value is $(2 * 3)" 将打印 The value is 6

ShellQuotingOptions

shell 引用选项。

属性

用于进行字符转义的字符。如果提供一个字符串,则只转义空格。如果提供一个 { escapeChar, charsToEscape } 字面量,则 charsToEscape 中的所有字符都将使用 escapeChar 进行转义。

用于强引用的字符。字符串的长度必须为 1。

用于弱引用的字符。字符串的长度必须为 1。

SignatureHelp

签名帮助表示可调用内容的签名。可以有多个签名,但只有一个活动签名和一个活动参数。

构造函数

参数描述
返回描述
SignatureHelp

属性

活动签名的活动参数。

活动签名。

一个或多个签名。

SignatureHelpContext

有关触发 SignatureHelpProvider 的上下文的其他信息。

属性

当前活动的 SignatureHelp

activeSignatureHelpactiveSignature 字段会根据用户在可用签名之间移动而更新。

如果触发时签名帮助已在显示,则为 true

当签名帮助已激活时会发生重新触发,并且可能由诸如键入触发字符、光标移动或文档内容更改等操作引起。

导致触发签名帮助的字符。

当签名帮助不是由键入触发时,例如手动调用签名帮助或移动光标时,此值为 undefined

导致触发签名帮助的操作。

SignatureHelpProvider

签名帮助提供程序接口定义了扩展和 参数提示 功能之间的约定。

方法

为给定位置和文档处的签名提供帮助。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

context: SignatureHelpContext

有关如何触发签名帮助的信息。

返回描述
ProviderResult<SignatureHelp>

签名帮助或可解析为签名帮助的 thenable。可以通过返回 undefinednull 来表示缺少结果。

SignatureHelpProviderMetadata

有关已注册的 SignatureHelpProvider 的元数据。

属性

重新触发签名帮助的字符列表。

这些触发字符仅在签名帮助已在显示时才处于活动状态。所有触发字符也都被视为重新触发字符。

触发签名帮助的字符列表。

SignatureHelpTriggerKind

如何触发 SignatureHelpProvider

枚举成员

签名帮助由用户或命令手动调用。

签名帮助由触发字符触发。

签名帮助由光标移动或文档内容更改触发。

SignatureInformation

表示可调用内容的签名。签名可以有一个标签(如函数名)、文档注释和一组参数。

构造函数

创建一个新的签名信息对象。

参数描述
label: string

标签字符串。

documentation?: string | MarkdownString

文档字符串。

返回描述
SignatureInformation

属性

活动参数的索引。

如果提供,则使用此参数代替 SignatureHelp.activeParameter

此签名的用户可读文档注释。 将会显示在 UI 中,但可以省略。

此签名的标签。将显示在 UI 中。

此签名的参数。

SnippetString

代码片段字符串是一个模板,允许插入文本并在插入时控制编辑器光标。

代码片段可以使用 $1$2${3:foo} 定义制表位和占位符。$0 定义最终制表位,默认是代码片段的末尾。变量使用 $name${name:默认值} 定义。另请参阅 完整代码片段语法

构造函数

创建一个新的代码片段字符串。

参数描述
value?: string

一个代码片段字符串。

返回描述
SnippetString

属性

代码片段字符串。

方法

构建器函数,将一个选择(${1|a,b,c|})追加到此代码片段字符串的 中。

参数描述
values: readonly string[]

选择的值 - 字符串数组

number?: number

此制表位的编号,默认为从 1 开始自动递增的值。

返回描述
SnippetString

此代码片段字符串。

构建器函数,将一个占位符(${1:value})追加到此代码片段字符串的 中。

参数描述
value: string | (snippet: SnippetString) => any

此占位符的值 - 可以是字符串,也可以是可以使用它创建嵌套代码片段的函数。

number?: number

此制表位的编号,默认为从 1 开始自动递增的值。

返回描述
SnippetString

此代码片段字符串。

构建器函数,将一个制表位($1$2 等)追加到此代码片段字符串的 中。

参数描述
number?: number

此制表位的编号,默认为从 1 开始自动递增的值。

返回描述
SnippetString

此代码片段字符串。

构建器函数,将给定的字符串追加到此代码片段字符串的 中。

参数描述
string: string

要“按给定”追加的值。字符串将被转义。

返回描述
SnippetString

此代码片段字符串。

构建器函数,将一个变量(${VAR})追加到此代码片段字符串的 中。

参数描述
name: string

变量的名称 - 不包括 $

defaultValue: string | (snippet: SnippetString) => any

当无法解析变量名称时使用的默认值 - 可以是字符串,也可以是可以使用它创建嵌套代码片段的函数。

返回描述
SnippetString

此代码片段字符串。

SnippetTextEdit

代码片段编辑表示由编辑器执行的交互式编辑。

请注意,代码片段编辑始终可以作为普通的 文本编辑 执行。当没有匹配的编辑器打开或者 工作区编辑 包含多个文件的代码片段编辑时,会发生这种情况。在这种情况下,只有那些与活动编辑器匹配的编辑才会作为代码片段编辑执行,其他的编辑将作为普通文本编辑执行。

静态

创建插入代码片段编辑的实用工具。

参数描述
position: Position

一个位置,将变成一个空范围。

snippet: SnippetString

一个代码片段字符串。

返回描述
SnippetTextEdit

一个新的代码片段编辑对象。

创建替换代码片段编辑的实用工具。

参数描述
range: Range

一个范围。

snippet: SnippetString

一个代码片段字符串。

返回描述
SnippetTextEdit

一个新的代码片段编辑对象。

构造函数

创建一个新的代码片段编辑。

参数描述
range: Range

一个范围。

snippet: SnippetString

一个代码片段字符串。

返回描述
SnippetTextEdit

属性

此编辑应用到的范围。

此编辑将执行的 代码片段

SourceBreakpoint

由源代码位置指定的断点。

构造函数

为源代码位置创建一个新的断点。

参数描述
location: Location
enabled?: boolean
condition?: string
hitCondition?: string
logMessage?: string
返回描述
SourceBreakpoint

属性

条件断点的可选表达式。

是否启用断点。

控制忽略多少次断点命中的可选表达式。

断点的唯一 ID。

此断点的源代码和行位置。

命中此断点时记录的可选消息。{} 内的嵌入表达式由调试适配器进行插值。

SourceControl

源代码管理能够向编辑器提供 资源状态,并以几种与源代码管理相关的方式与编辑器交互。

属性

可选的接受输入命令。

当用户接受源代码管理输入中的值时,将调用此命令。

可选的提交模板字符串。

当适用时,源代码管理视图将使用此值填充源代码管理输入。

此源代码管理的 资源状态 的 UI 可见计数。

如果未定义,则此源代码管理将

  • 将其 UI 可见计数显示为零,并且
  • 将其 资源状态 的计数贡献给所有源代码管理的 UI 可见聚合计数

此源代码管理的 ID。

此源代码管理的 输入框

此源代码管理的人类可读标签。

一个可选的快速差异提供程序

此源代码管理根目录的(可选)Uri。

可选的状态栏命令。

这些命令将显示在编辑器的状态栏中。

方法

创建一个新的资源组

参数描述
id: string
label: string
返回描述
SourceControlResourceGroup

释放此源代码管理。

参数描述
返回描述
void

SourceControlInputBox

表示源代码管理视图中的输入框。

属性

控制输入框是否启用(默认为 true)。

在输入框中显示的占位符字符串,用于引导用户。

输入框内容的设置器和获取器。

控制输入框是否可见(默认为 true)。

SourceControlResourceDecorations

源代码管理资源状态的装饰。 可以针对浅色和深色主题单独指定。

属性

深色主题装饰。

是否应在 UI 中淡化源代码管理资源状态

特定源代码管理资源状态的图标路径。

浅色主题装饰。

是否应在 UI 中删除源代码管理资源状态

特定源代码管理资源状态的标题。

SourceControlResourceGroup

源代码管理资源组是源代码管理资源状态的集合。

属性

当此源代码管理资源组不包含任何源代码管理资源状态时是否隐藏。

此源代码管理资源组的 ID。

此源代码管理资源组的标签。

此组的源代码管理资源状态集合。

方法

释放此源代码管理资源组。

参数描述
返回描述
void

SourceControlResourceState

源代码管理资源状态表示特定源代码管理组中基础工作区资源的状态。

属性

当在源代码管理视图中打开资源状态时应运行的命令

资源状态的上下文值。这可用于贡献资源特定操作。例如,如果资源的上下文值被指定为 diffable。当使用 menus 扩展点向 scm/resourceState/context 贡献操作时,您可以在 when 表达式中为键 scmResourceState 指定上下文值,例如 scmResourceState == diffable

"contributes": {
  "menus": {
    "scm/resourceState/context": [
      {
        "command": "extension.diff",
        "when": "scmResourceState == diffable"
      }
    ]
  }
}

这将仅对 contextValuediffable 的资源显示操作 extension.diff

此源代码管理资源状态的装饰

工作区内底层资源的Uri

SourceControlResourceThemableDecorations

源代码管理资源状态的主题感知装饰。

属性

特定源代码管理资源状态的图标路径。

StatementCoverage

包含单个语句或行的覆盖率信息。

构造函数

参数描述
executed: number | boolean

此语句的执行次数,如果确切的计数未知,则为指示是否执行的布尔值。 如果为零或 false,则该语句将被标记为未覆盖。

location: Range | Position

语句的位置。

branches?: BranchCoverage[]

此行分支的覆盖率。如果不是条件语句,则应省略。

返回描述
StatementCoverage

属性

此行或语句的分支的覆盖率。如果不是条件语句,则此项将为空。

此语句的执行次数,如果确切的计数未知,则为指示是否执行的布尔值。 如果为零或 false,则该语句将被标记为未覆盖。

语句位置。

StatusBarAlignment

表示状态栏项的对齐方式。

枚举成员

与左侧对齐。

与右侧对齐。

StatusBarItem

状态栏项是一种状态栏贡献,可以显示文本和图标,并在单击时运行命令。

属性

当屏幕阅读器与此状态栏项交互时使用的辅助功能信息

此项的对齐方式。

此条目的背景颜色。

注意:仅支持以下颜色

  • new ThemeColor('statusBarItem.errorBackground')
  • new ThemeColor('statusBarItem.warningBackground')

未来可能会支持更多背景颜色。

注意:当设置背景颜色时,状态栏可能会覆盖 color 的选择,以确保条目在所有主题中都可读。

此条目的前景色。

命令或点击时要运行的命令的标识符。

该命令必须是已知的

请注意,如果这是一个 Command 对象,则编辑器仅使用 commandarguments

此项的标识符。

注意:如果 window.createStatusBarItem 方法没有提供标识符,则标识符将与 扩展标识符 匹配。

条目的名称,例如 “Python 语言指示器”、“Git 状态” 等。尽量保持名称简短,但又具有足够的描述性,以便用户能够理解状态栏项目的作用。

此条目的优先级。值越高,条目越靠左显示。

要显示在条目中的文本。您可以通过利用语法在文本中嵌入图标

我的文本 $(icon-name) 包含像 $(icon-name) 这样的图标。

其中 icon-name 取自 ThemeIcon 图标集,例如 light-bulbthumbsupzap 等。

当您将鼠标悬停在此条目上时显示的工具提示文本。

方法

释放并释放相关资源。调用 hide

参数描述
返回描述
void

隐藏状态栏中的条目。

参数描述
返回描述
void

在状态栏中显示条目。

参数描述
返回描述
void

SymbolInformation

表示有关编程结构(如变量、类、接口等)的信息。

构造函数

创建一个新的符号信息对象。

参数描述
name: string

符号的名称。

kind: SymbolKind

符号的种类。

containerName: string

包含该符号的符号的名称。

location: Location

符号的位置。

返回描述
SymbolInformation

创建一个新的符号信息对象。

  • 已弃用 - 请使用带有 Location 对象的构造函数。
参数描述
name: string

符号的名称。

kind: SymbolKind

符号的种类。

range: Range

符号所在位置的范围。

uri?: Uri

符号位置的资源,默认为当前文档。

containerName?: string

包含该符号的符号的名称。

返回描述
SymbolInformation

属性

包含此符号的符号的名称。

此符号的种类。

此符号的位置。

此符号的名称。

此符号的标签。

SymbolKind

符号的种类。

枚举成员

File 符号种类。

Module 符号种类。

Namespace 符号种类。

Package 符号种类。

Class 符号种类。

Method 符号种类。

Property 符号种类。

Field 符号种类。

Constructor 符号种类。

Enum 符号种类。

Interface 符号种类。

Function 符号种类。

Variable 符号种类。

Constant 符号种类。

String 符号种类。

Number 符号种类。

Boolean 符号种类。

Array 符号种类。

Object 符号类型。

Key 符号类型。

Null 符号类型。

EnumMember 符号类型。

Struct 符号类型。

Event 符号类型。

Operator 符号类型。

TypeParameter 符号类型。

SymbolTag

符号标签是用于调整符号呈现效果的额外注解。

枚举成员

将符号呈现为已弃用,通常使用删除线。

SyntaxTokenType

常用语法标记类型的枚举。

枚举成员

除了属于注释、字符串字面量和正则表达式的标记之外的所有内容。

注释。

字符串字面量。

正则表达式。

Tab

表示选项卡组中的一个选项卡。选项卡仅仅是编辑器区域内的图形表示。不保证有后备编辑器。

属性

选项卡所属的组。

定义选项卡的结构,即文本、笔记本、自定义等。资源和其他有用的属性在选项卡类型上定义。

选项卡当前是否处于活动状态。这由该选项卡是否在组中被选中决定。

选项卡上是否存在未保存指示符。

选项卡是否被固定(是否存在固定图标)。

选项卡是否处于预览模式。

选项卡上显示的文本。

TabChangeEvent

描述选项卡更改的事件。

属性

已更改的选项卡,例如其 active 状态已更改。

已关闭的选项卡。

已打开的选项卡。

TabGroup

表示一组选项卡。一个选项卡组本身包含多个选项卡。

属性

组中活动的选项卡。这是当前正在呈现其内容的选项卡。

注意,每个组只能有一个活动选项卡,但只能有一个活动组

该组当前是否处于活动状态。

注意,一次只有一个选项卡组处于活动状态,但多个选项卡组可以拥有活动选项卡

另请参阅 Tab.isActive

组中包含的选项卡列表。如果组没有打开的选项卡,则此列表可能为空。

组的视图列。

TabGroupChangeEvent

描述选项卡组更改的事件。

属性

已更改的选项卡组,例如其 active 状态已更改。

已关闭的选项卡组。

已打开的选项卡组。

TabGroups

表示由多个包含选项卡的组组成的主编辑器区域。

事件

选项卡组发生更改时触发的事件

选项卡发生更改时触发的事件

属性

当前活动的组。

组容器中的所有组。

方法

关闭选项卡。这将使选项卡对象无效,并且不应再将该选项卡用于进一步操作。注意:如果是未保存的选项卡,将显示确认对话框,该对话框可以取消。如果取消,选项卡仍然有效

参数描述
tab: Tab | readonly Tab[]

要关闭的选项卡。

preserveFocus?: boolean

当为 true 时,焦点将保持在当前位置。如果为 false,它将跳转到下一个选项卡。

返回描述
Thenable<boolean>

当所有选项卡都已关闭时,解析为 true 的 Promise。

关闭选项卡组。这将使选项卡组对象无效,并且不应再将该选项卡组用于进一步操作。

参数描述
tabGroup: TabGroup | readonly TabGroup[]

要关闭的选项卡组。

preserveFocus?: boolean

当为 true 时,焦点将保持在当前位置。

返回描述
Thenable<boolean>

当所有选项卡组都已关闭时,解析为 true 的 Promise。

TabInputCustom

选项卡表示自定义编辑器。

构造函数

构建一个自定义编辑器标签输入。

参数描述
uri: Uri

标签的 URI。

viewType: string

自定义编辑器的视图类型。

返回描述
TabInputCustom

属性

标签所代表的 URI。

自定义编辑器的类型。

TabInputNotebook

该标签表示一个笔记本。

构造函数

为笔记本构建一个新的标签输入。

参数描述
uri: Uri

笔记本的 URI。

notebookType: string

笔记本的类型。映射到NotebookDocuments 的 notebookType

返回描述
TabInputNotebook

属性

笔记本的类型。映射到NotebookDocuments 的 notebookType

标签所代表的 URI。

TabInputNotebookDiff

该标签表示以差异配置显示的两个笔记本。

构造函数

构建一个笔记本差异标签输入。

参数描述
original: Uri

原始未修改笔记本的 URI。

modified: Uri

修改后的笔记本的 URI。

notebookType: string

笔记本的类型。映射到NotebookDocuments 的 notebookType

返回描述
TabInputNotebookDiff

属性

修改后的笔记本的 URI。

笔记本的类型。映射到NotebookDocuments 的 notebookType

原始笔记本的 URI。

TabInputTerminal

该标签表示编辑器区域中的一个终端。

构造函数

构建一个终端标签输入。

参数描述
返回描述
TabInputTerminal

TabInputText

该标签表示一个基于文本的单一资源。

构造函数

使用给定的 URI 构建一个文本标签输入。

参数描述
uri: Uri

标签的 URI。

返回描述
TabInputText

属性

标签所代表的 URI。

TabInputTextDiff

该标签表示两个基于文本的资源,它们以差异形式呈现。

构造函数

使用给定的 URI 构建一个新的文本差异标签输入。

参数描述
original: Uri

原始文本资源的 URI。

modified: Uri

修改后的文本资源的 URI。

返回描述
TabInputTextDiff

属性

修改后的文本资源的 URI。

原始文本资源的 URI。

TabInputWebview

该标签表示一个 Webview。

构造函数

使用给定的视图类型构建一个 Webview 标签输入。

参数描述
viewType: string

Webview 的类型。映射到 WebviewPanel 的 viewType

返回描述
TabInputWebview

属性

Webview 的类型。映射到 WebviewPanel 的 viewType

Task

要执行的任务

构造函数

创建一个新任务。

参数描述
taskDefinition: TaskDefinition

任务定义,如 taskDefinitions 扩展点中所定义。

scope: WorkspaceFolder | Global | Workspace

指定任务的作用域。它可以是全局任务、工作区任务或特定工作区文件夹的任务。目前不支持全局任务。

name: string

任务的名称。在用户界面中显示。

source: string

任务的来源(例如,“gulp”、“npm”等)。在用户界面中显示。

execution?: ProcessExecution | ShellExecution | CustomExecution

进程或 Shell 执行。

problemMatchers?: string | string[]

要使用的匹配器名称,如“$tsc”或“$eslint”。可以使用 problemMatchers 扩展点通过扩展程序贡献问题匹配器。

返回描述
Task

创建一个新任务。

  • 已弃用 - 使用新的构造函数,该构造函数允许为任务指定作用域。
参数描述
taskDefinition: TaskDefinition

任务定义,如 taskDefinitions 扩展点中所定义。

name: string

任务的名称。在用户界面中显示。

source: string

任务的来源(例如,“gulp”、“npm”等)。在用户界面中显示。

execution?: ProcessExecution | ShellExecution

进程或 Shell 执行。

problemMatchers?: string | string[]

要使用的匹配器名称,如“$tsc”或“$eslint”。可以使用 problemMatchers 扩展点通过扩展程序贡献问题匹配器。

返回描述
Task

属性

任务的定义。

一个人类可读的字符串,在显示任务名称的地方,会在单独一行上以不显眼的方式呈现。支持通过 $(<name>) 语法呈现主题图标

任务的执行引擎

此任务所属的任务组。有关可用组的预定义集,请参阅 TaskGroup。默认为未定义,表示该任务不属于任何特殊组。

指示任务是否为后台任务。

任务的名称

演示选项。默认为空字面量。

附加到任务的问题匹配器。默认为空数组。

任务的运行选项

任务的作用域。

一个人类可读的字符串,描述此 shell 任务的来源,例如“gulp”或“npm”。支持通过 $(<name>) 语法渲染主题图标

TaskDefinition

一个定义系统中任务类型的结构。该值必须是可 JSON 序列化的。

属性

任务定义,描述扩展提供的任务。通常,任务提供程序会定义更多属性来标识任务。它们需要在扩展的 package.json 中的“taskDefinitions”扩展点下定义。例如,npm 任务定义如下所示

interface NpmTaskDefinition extends TaskDefinition {
  script: string;
}

请注意,以“$”开头的类型标识符保留供内部使用,不应被扩展使用。

TaskEndEvent

一个表示已执行任务结束的事件。

此接口不应被实现。

属性

表示已完成任务的任务项。

TaskExecution

一个表示已执行的任务的对象。它可用于终止任务。

此接口不应被实现。

属性

已启动的任务。

方法

终止任务执行。

参数描述
返回描述
void

TaskFilter

任务筛选器按其版本和类型表示任务

属性

要返回的任务类型;

在 tasks.json 文件中使用的任务版本。该字符串支持 package.json semver 表示法。

TaskGroup

任务的分组。编辑器默认支持“Clean”、“Build”、“RebuildAll”和“Test”组。

静态

构建任务组;

清理任务组;

全部重建任务组;

全部测试任务组;

构造函数

私有构造函数

参数描述
id: string

任务组的标识符。

label: string

任务组的人类可读名称。

返回描述
TaskGroup

属性

任务组的 ID。是 TaskGroup.Clean.id、TaskGroup.Build.id、TaskGroup.Rebuild.id 或 TaskGroup.Test.id 之一。

属于此组的任务是否为该组的默认值。此属性无法通过 API 设置,并且由用户的任务配置控制。

TaskPanelKind

控制任务通道在任务之间如何使用

枚举成员

与其他任务共享一个面板。这是默认设置。

对此任务使用专用面板。该面板不与其他任务共享。

每次执行此任务时都会创建一个新面板。

TaskPresentationOptions

控制任务在 UI 中的显示方式。

属性

控制是否在执行任务之前清除终端。

控制是否在执行任务后关闭终端。

控制与任务关联的命令是否在用户界面中回显。

控制显示任务输出的面板是否获得焦点。

控制任务面板是否仅用于此任务(专用)、在任务之间共享(共享)或是否在每次任务执行时创建一个新面板(新)。默认为 TaskInstanceKind.Shared

控制任务输出是否在用户界面中显示。默认为 RevealKind.Always

控制是否显示“终端将由任务重用,按任意键关闭它”消息。

TaskProcessEndEvent

一个表示通过任务触发的进程执行结束的事件

属性

进程启动的任务执行。

进程的退出代码。当任务被终止时,将为 undefined

TaskProcessStartEvent

一个表示通过任务触发的进程执行开始的事件

属性

进程启动的任务执行。

底层进程 ID。

TaskProvider<T>

任务提供程序允许向任务服务添加任务。任务提供程序通过 tasks.registerTaskProvider 注册。

方法

提供任务。

参数描述
token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

一个任务数组

解析没有设置 执行 的任务。任务通常从 tasks.json 文件中找到的信息创建。此类任务缺少有关如何执行它们的信息,任务提供程序必须在 resolveTask 方法中填写缺失的信息。对于从上面的 provideTasks 方法返回的任务,此方法不会被调用,因为这些任务始终是完全解析的。resolveTask 方法的有效默认实现是返回 undefined

请注意,在填写 task 的属性时,您必须确保使用完全相同的 TaskDefinition,而不是创建一个新的。其他属性可能会被更改。

参数描述
task: T

要解析的任务。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

已解析的任务

TaskRevealKind

控制终端可见性的行为。

枚举成员

如果执行任务,始终将终端置于前台。

仅当检测到执行任务时出现问题(例如,任务因故无法启动)时,才将终端置于前台。

执行任务时,终端永远不会置于前台。

TaskScope

任务的作用域。

枚举成员

该任务是全局任务。当前不支持全局任务。

该任务是工作区任务

TaskStartEvent

表示任务执行开始的事件。

此接口不应被实现。

属性

表示已启动任务的任务项。

TelemetryLogger

一个遥测记录器,扩展可以使用它来记录使用情况和错误遥测数据。

记录器包装在 发送器 周围,但它保证

  • 尊重用户禁用或调整遥测的设置,并且
  • 删除潜在的敏感数据

它还启用了一个“回显 UI”,该 UI 会打印发送的任何数据,并允许编辑器将未处理的错误转发给相应的扩展。

要获取 TelemetryLogger 的实例,请使用 createTelemetryLogger

事件

当使用情况或错误遥测的启用状态发生更改时触发的 事件

属性

是否为此记录器启用了错误遥测。

是否为此记录器启用了使用情况遥测。

方法

释放此对象并释放资源。

参数描述
返回描述
void

记录错误事件。

完成清理、遥测设置检查和数据混合调用后,TelemetrySender.sendEventData 将记录事件。与 logUsage 不同的是,如果遥测设置是 Error+,它将记录事件。自动支持回显到扩展遥测输出通道。

参数描述
eventName: string

要记录的事件名称

data?: Record<string, any>

要记录的数据

返回描述
void

记录错误事件。

调用 TelemetrySender.sendErrorData。进行清理、遥测检查和数据混合。自动支持回显到扩展遥测输出通道。还将自动记录扩展主机进程中抛出的任何异常。

参数描述
error: Error

包含已清除 PII 的堆栈跟踪的错误对象

data?: Record<string, any>

与堆栈跟踪一起记录的其他数据

返回描述
void

记录使用情况事件。

完成清理、遥测设置检查和数据混合调用后,TelemetrySender.sendEventData 将记录事件。自动支持回显到扩展遥测输出通道。

参数描述
eventName: string

要记录的事件名称

data?: Record<string, any>

要记录的数据

返回描述
void

TelemetryLoggerOptions

用于创建 TelemetryLogger 的选项

属性

应注入到数据对象中的任何其他通用属性。

是否要避免将内置通用属性(如操作系统、扩展名称等)注入到数据对象中。如果未定义,则默认为 false

是否应将扩展主机上由您的扩展引起的未处理错误记录到您的发送器。如果未定义,则默认为 false

TelemetrySender

遥测发送器是遥测记录器和某些遥测服务之间的约定。注意,扩展不得直接调用其发送器的方法,因为记录器提供了额外的保护和清理。

const sender: vscode.TelemetrySender = {...};
const logger = vscode.env.createTelemetryLogger(sender);

// GOOD - uses the logger
logger.logUsage('myEvent', { myData: 'myValue' });

// BAD - uses the sender directly: no data cleansing, ignores user settings, no echoing to the telemetry output channel etc
sender.logEvent('myEvent', { myData: 'myValue' });

方法

可选的刷新函数,它将使此发送器有机会在 TelemetryLogger 被处置时发送任何剩余的事件

参数描述
返回描述
void | Thenable<void>

发送错误的函数。在 TelemetryLogger 中使用

参数描述
error: Error

正在记录的错误

data?: Record<string, any>

要与异常一起收集的任何其他数据

返回描述
void

发送不带堆栈跟踪的事件数据的函数。在 TelemetryLogger 中使用

参数描述
eventName: string

您正在记录的事件的名称

data?: Record<string, any>

正在记录的可序列化键值对

返回描述
void

TelemetryTrustedValue<T>

一种特殊的数值包装器,表示一个值可以安全地不清理。当您可以保证该值不包含可识别的信息并且清理不正确地对其进行编辑时,应使用此值。

构造函数

创建一个新的遥测信任值。

参数描述
value: T

要信任的值

返回描述
TelemetryTrustedValue<T>

属性

信任不包含 PII 的值。

Terminal

集成终端中的单个终端实例。

属性

用于初始化终端的对象,例如,当终端不是由此扩展启动时,或者用于检测启动 shell 的文件夹时,这非常有用。

终端的退出状态,当终端处于活动状态时,这将是未定义的。

示例:当终端以非零退出代码退出时,显示带有退出代码的通知。

window.onDidCloseTerminal(t => {
  if (t.exitStatus && t.exitStatus.code) {
    vscode.window.showInformationMessage(`Exit code: ${t.exitStatus.code}`);
  }
});

终端的名称。

shell 进程的进程 ID。

一个包含 shell 集成支持的终端功能的对象。在终端创建后,它将始终为 undefined。监听 window.onDidChangeTerminalShellIntegration,以便在终端激活 shell 集成时收到通知。

请注意,如果 shell 集成从未激活,则此对象可能仍然是未定义的。例如,命令提示符不支持 shell 集成,并且用户的 shell 设置可能会与自动 shell 集成激活冲突。

终端的当前状态。

方法

释放并释放相关资源。

参数描述
返回描述
void

如果此终端当前正在显示,则隐藏终端面板。

参数描述
返回描述
void

将文本发送到终端。文本被写入终端底层 pty 进程(shell)的标准输入。

参数描述
text: string

要发送的文本。

shouldExecute?: boolean

指示要发送的文本应该执行,而不仅仅是插入到终端中。添加的字符是 \n\r\n,具体取决于平台。默认为 true

返回描述
void

显示终端面板并在 UI 中显示此终端。

参数描述
preserveFocus?: boolean

当为 true 时,终端将不会获取焦点。

返回描述
void

TerminalDimensions

表示终端的尺寸。

属性

终端中的列数。

终端中的行数。

TerminalEditorLocationOptions

假设 TerminalLocation 为编辑器,并允许指定 ViewColumnpreserveFocus 属性

属性

一个可选标志,当为 true 时,将阻止 终端获取焦点。

一个视图列,其中 终端应该在编辑器区域中显示。默认值为 active。不存在的列将根据需要创建,最大为 ViewColumn.Nine。使用 ViewColumn.Beside 将编辑器打开到当前活动编辑器的侧面。

TerminalExitReason

终端退出原因的类型。

枚举成员

未知原因。

窗口已关闭/重新加载。

shell 进程已退出。

用户关闭了终端。

扩展程序处置了终端。

TerminalExitStatus

表示终端如何退出。

属性

终端退出的退出代码,它可以具有以下值

  • 零:终端进程或自定义执行成功。
  • 非零:终端进程或自定义执行失败。
  • undefined:用户强制关闭了终端,或者自定义执行退出时未提供退出代码。

触发终端退出的原因。

终端行上的链接。

构造函数

创建一个新的终端链接。

参数描述
startIndex: number

TerminalLinkContext.line 上链接的起始索引。

length: number

TerminalLinkContext.line 上链接的长度。

tooltip?: string

鼠标悬停在此链接上时显示的工具提示文本。

如果提供了工具提示,它将显示在一个包含如何触发链接的说明的字符串中,例如 {0} (ctrl + click)。具体说明因操作系统、用户设置和本地化而异。

返回描述
TerminalLink

属性

TerminalLinkContext.line 上链接的长度。

TerminalLinkContext.line 上链接的起始索引。

鼠标悬停在此链接上时显示的工具提示文本。

如果提供了工具提示,它将显示在一个包含如何触发链接的说明的字符串中,例如 {0} (ctrl + click)。具体说明因操作系统、用户设置和本地化而异。

TerminalLinkContext

提供终端中一行的信息,以便为其提供链接。

属性

这是来自终端中未换行的文本。

链接所属的终端。

TerminalLinkProvider<T>

一个提供程序,用于启用终端中链接的检测和处理。

方法

处理激活的终端链接。

参数描述
link: T

要处理的链接。

返回描述
ProviderResult<void>

为给定上下文提供终端链接。请注意,即使在之前的调用解析之前,也可以多次调用此方法,请确保不要共享可能在异步使用可能重叠时出现问题的全局对象(例如,RegExp)。

参数描述
context: TerminalLinkContext

有关正在为其提供链接的信息。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

给定行的终端链接列表。

TerminalLocation

终端的位置。

枚举成员

在终端视图中

在编辑器区域中

TerminalOptions

描述终端应使用哪些选项的值对象。

属性

终端的图标 ThemeColor。建议使用 terminal.ansi* 主题键,以获得最佳的对比度和跨主题的一致性。

要用于终端的当前工作目录的路径或 Uri。

包含将添加到编辑器进程中的环境变量的对象。

启用后,终端将像正常一样运行进程,但直到调用 Terminal.show 时才向用户显示。 这种情况的典型用法是,当您需要运行一些可能需要交互的操作时,但只想在需要交互时才告知用户。请注意,终端仍将像正常一样暴露给所有扩展。下次打开工作区时,隐藏的终端将不会恢复。

终端的图标路径或 ThemeIcon

选择退出重启和重载时默认的终端持久性。这仅在启用 terminal.integrated.enablePersistentSessions 时生效。

首次启动时写入终端的消息,请注意,此消息不会发送到进程,而是直接写入终端。这支持诸如设置文本样式之类的转义序列。

一个人类可读的字符串,用于在 UI 中表示终端。

自定义 shell 可执行文件的参数。 在 Windows 上可以使用字符串,它允许以 命令行格式 指定 shell 参数。

要在终端中使用的自定义 shell 可执行文件的路径。

终端进程环境是否应与 TerminalOptions.env 中提供的环境完全相同。如果此值为 false(默认值),则环境将基于窗口的环境,并且还会在之上应用配置的平台设置,例如 terminal.integrated.env.windows。如果此值为 true,则必须提供完整的环境,因为不会从进程或任何配置中继承任何内容。

TerminalProfile

终端配置文件定义了如何启动终端。

构造函数

创建一个新的终端配置文件。

参数描述
options: TerminalOptions | ExtensionTerminalOptions

终端将使用启动的选项。

返回描述
TerminalProfile

属性

终端将使用启动的选项。

TerminalProfileProvider

当通过 UI 或命令启动时,为贡献的终端配置文件提供终端配置文件。

方法

提供终端配置文件。

参数描述
token: CancellationToken

一个取消标记,指示不再需要该结果。

返回描述
ProviderResult<TerminalProfile>

终端配置文件。

TerminalShellExecution

在终端中执行的命令。

属性

已执行的命令行。此值的 置信度 取决于特定 shell 的 shell 集成实现。在触发 window.onDidEndTerminalShellExecution 之后,此值可能会变得更准确。

示例

// Log the details of the command line on start and end
window.onDidStartTerminalShellExecution(event => {
  const commandLine = event.execution.commandLine;
  console.log(`Command started\n${summarizeCommandLine(commandLine)}`);
});
window.onDidEndTerminalShellExecution(event => {
  const commandLine = event.execution.commandLine;
  console.log(`Command ended\n${summarizeCommandLine(commandLine)}`);
});
function summarizeCommandLine(commandLine: TerminalShellExecutionCommandLine) {
  return [
    `  Command line: ${command.commandLine.value}`,
    `  Confidence: ${command.commandLine.confidence}`,
    `  Trusted: ${command.commandLine.isTrusted}
  ].join('\n');
}

执行此命令时 shell 报告的工作目录。此 Uri 可能表示另一台计算机上的文件(例如,ssh 进入另一台计算机)。这要求 shell 集成支持工作目录报告。

方法

创建一个写入终端的原始数据(包括转义序列)流。这仅包括在首次调用 read 后写入的数据,即,您必须在通过 TerminalShellIntegration.executeCommandwindow.onDidStartTerminalShellExecution 执行命令后立即调用 read,以避免遗漏任何数据。

示例

// Log all data written to the terminal for a command
const command = term.shellIntegration.executeCommand({ commandLine: 'echo "Hello world"' });
const stream = command.read();
for await (const data of stream) {
  console.log(data);
}
参数描述
返回描述
AsyncIterable<string>

TerminalShellExecutionCommandLine

在终端中执行的命令行。

属性

命令行值的置信度,由值的获取方式确定。这取决于 shell 集成脚本的实现。

命令行值是否来自受信任的来源,因此无需用户额外确认即可安全执行,例如,要求“您要执行(命令)吗?”的通知。如果您要再次执行该命令,则可能只需要进行此验证。

仅当命令行是由 shell 集成脚本显式报告时(即,高置信度),并且它使用 nonce 进行验证时,此值为 true

已执行的完整命令行,包括命令及其参数。

TerminalShellExecutionCommandLineConfidence

枚举成员

命令行值置信度较低。这意味着该值是使用 shell 集成脚本报告的标记从终端缓冲区读取的。此外,将满足以下条件之一

  • 该命令从最左侧的列开始,这很不寻常,或者
  • 该命令是多行的,由于存在行继续字符和右侧提示符,因此更难以准确检测。
  • Shell 集成脚本未报告命令行标记。

命令行值的置信度为中等。这意味着该值是从终端缓冲区读取的,使用了 shell 集成脚本报告的标记。该命令是单行的,并且不是从最左边的列开始(这不寻常)。

命令行值的置信度为高。这意味着该值是由 shell 集成脚本显式发送的,或者该命令是通过 TerminalShellIntegration.executeCommand API 执行的。

TerminalShellExecutionEndEvent

一个表示终端中执行已结束的事件。

属性

已结束的终端 shell 执行。

shell 报告的退出代码。

请注意,undefined 表示 shell 要么没有报告退出代码(即,shell 集成脚本行为不正常),要么 shell 报告了一个在命令完成之前开始的命令(例如,打开了一个子 shell)。通常这不应该发生,根据用例,最好将其视为失败。

示例

const execution = shellIntegration.executeCommand({
  command: 'echo',
  args: ['Hello world']
});
window.onDidEndTerminalShellExecution(event => {
  if (event.execution === execution) {
    if (event.exitCode === undefined) {
      console.log('Command finished but exit code is unknown');
    } else if (event.exitCode === 0) {
      console.log('Command succeeded');
    } else {
      console.log('Command failed');
    }
  }
});

shell 集成对象。

已激活 shell 集成的终端。

TerminalShellExecutionStartEvent

一个表示终端中执行已开始的事件。

属性

已结束的终端 shell 执行。

shell 集成对象。

已激活 shell 集成的终端。

TerminalShellIntegration

终端拥有的 Shell 集成驱动的功能。

属性

终端的当前工作目录。此 Uri 可能表示另一台计算机上的文件(例如,通过 SSH 连接到另一台计算机)。这需要 shell 集成支持工作目录报告。

方法

执行命令,并在需要时发送 ^C 以中断任何正在运行的命令。

示例

// Execute a command in a terminal immediately after being created
const myTerm = window.createTerminal();
window.onDidChangeTerminalShellIntegration(async ({ terminal, shellIntegration }) => {
  if (terminal === myTerm) {
    const execution = shellIntegration.executeCommand('echo "Hello world"');
    window.onDidEndTerminalShellExecution(event => {
      if (event.execution === execution) {
        console.log(`Command exited with code ${event.exitCode}`);
      }
    });
  }
}));
// Fallback to sendText if there is no shell integration within 3 seconds of launching
setTimeout(() => {
  if (!myTerm.shellIntegration) {
    myTerm.sendText('echo "Hello world"');
    // Without shell integration, we can't know when the command has finished or what the
    // exit code was.
  }
}, 3000);

示例

// Send command to terminal that has been alive for a while
const commandLine = 'echo "Hello world"';
if (term.shellIntegration) {
  const execution = shellIntegration.executeCommand({ commandLine });
  window.onDidEndTerminalShellExecution(event => {
    if (event.execution === execution) {
      console.log(`Command exited with code ${event.exitCode}`);
    }
  });
} else {
  term.sendText(commandLine);
  // Without shell integration, we can't know when the command has finished or what the
  // exit code was.
}
参数描述
commandLine: string

要执行的命令行,这是将发送到终端的确切文本。

返回描述
TerminalShellExecution

执行命令,并在需要时发送 ^C 以中断任何正在运行的命令。

注意 这不能保证工作,因为必须激活 shell 集成。检查是否拒绝了 TerminalShellExecution.exitCode,以验证它是否成功。

示例

// Execute a command in a terminal immediately after being created
const myTerm = window.createTerminal();
window.onDidChangeTerminalShellIntegration(async ({ terminal, shellIntegration }) => {
  if (terminal === myTerm) {
    const command = shellIntegration.executeCommand({
      command: 'echo',
      args: ['Hello world']
    });
    const code = await command.exitCode;
    console.log(`Command exited with code ${code}`);
  }
}));
// Fallback to sendText if there is no shell integration within 3 seconds of launching
setTimeout(() => {
  if (!myTerm.shellIntegration) {
    myTerm.sendText('echo "Hello world"');
    // Without shell integration, we can't know when the command has finished or what the
    // exit code was.
  }
}, 3000);

示例

// Send command to terminal that has been alive for a while
const commandLine = 'echo "Hello world"';
if (term.shellIntegration) {
  const command = term.shellIntegration.executeCommand({
    command: 'echo',
    args: ['Hello world']
  });
  const code = await command.exitCode;
  console.log(`Command exited with code ${code}`);
} else {
  term.sendText(commandLine);
  // Without shell integration, we can't know when the command has finished or what the
  // exit code was.
}
参数描述
executable: string

要运行的命令。

args: string[]

用于启动可执行文件的参数。这些参数将被转义,以便当参数既包含空格又不包含任何单引号、双引号或反引号字符时,它们被解释为单个参数。

请注意,此转义并非旨在作为安全措施,在将不受信任的数据传递给此 API 时请小心,因为像 $(...) 这样的字符串通常可以在 shell 中用来在字符串中执行代码。

返回描述
TerminalShellExecution

TerminalShellIntegrationChangeEvent

一个表示终端的 shell 集成已更改的事件。

属性

shell 集成对象。

已激活 shell 集成的终端。

TerminalSplitLocationOptions

使用父 Terminal 的位置作为终端的位置

属性

此终端要拆分在其旁边的父终端。无论父终端在面板中还是在编辑器区域中,这都有效。

TerminalState

表示 Terminal 的状态。

属性

是否已与 Terminal 进行了交互。交互意味着终端已将数据发送到进程,这取决于终端的模式。默认情况下,当按下键或命令或扩展发送文本时会发送输入,但根据终端的模式,它也可能发生在

  • 指针单击事件
  • 指针滚动事件
  • 指针移动事件
  • 终端焦点进入/退出

有关可以发送数据的事件的更多信息,请参阅 https://invisible-island.net/xterm/ctlseqs/ctlseqs.html 上的 “DEC 私有模式设置 (DECSET)”

TestController

用于发现和执行测试的入口点。它包含 TestController.items,用于填充编辑器 UI,并与 运行配置文件 相关联,以允许执行测试。

属性

tests.createTestController 中传递的控制器的 id。这必须是全局唯一的。

“顶层” TestItem 实例的集合,这些实例可以反过来拥有自己的 子项,以形成“测试树”。

扩展控制何时添加测试。例如,当 workspace.onDidOpenTextDocument 触发时,扩展应为文件添加测试,以便在文件中显示测试的装饰。

但是,编辑器有时可能会使用 resolveHandler 显式请求子项。有关更多详细信息,请参阅该方法的文档。

测试控制器的易读标签。

如果存在此方法,则 UI 中将显示一个刷新按钮,并在单击该按钮时调用此方法。调用时,扩展应扫描工作区中任何新的、已更改的或已删除的测试。

建议扩展尝试实时更新测试,例如使用 FileSystemWatcher,并将此方法用作后备。

参数描述
token: CancellationToken
返回描述
void | Thenable<void>

当测试刷新后解析的可 thenable 对象。

由扩展提供的一个函数,如果 TestItem.canResolveChildrentrue,编辑器可以调用该函数来请求测试项的子项。调用时,该项应发现子项,并在发现子项时调用 TestController.createTestItem

通常,扩展管理测试项的生命周期,但在某些情况下,编辑器可能会请求加载特定项的子项。例如,如果用户在重新加载编辑器后请求重新运行测试,则编辑器可能需要调用此方法来解析先前运行的测试。

浏览器中的项将自动标记为“忙”,直到该函数返回或返回的可 thenable 对象解析为止。

参数描述
item: TestItem

正在请求其子项的未解析测试项,或者在解析控制器的初始 items 时为 undefined

返回描述
void | Thenable<void>

方法

创建一个用于运行测试的配置文件。扩展必须至少创建一个配置文件才能运行测试。

参数描述
label: string

此配置文件的人性化标签。

kind: TestRunProfileKind

配置此配置文件管理的执行类型。

runHandler: (request: TestRunRequest, token: CancellationToken) => void | Thenable<void>

用于启动测试运行的函数。

isDefault?: boolean

是否为此类型操作的默认操作。

tag?: TestTag

配置文件测试标签。

supportsContinuousRun?: boolean

该配置文件是否支持持续运行。

返回描述
TestRunProfile

TestRunProfile 的一个实例,它会自动与此控制器关联。

创建一个新的托管 TestItem 实例。它可以添加到现有项的 TestItem.children 中,或者添加到 TestController.items 中。

参数描述
id: string

TestItem 的标识符。测试项的 ID 在它添加到的 TestItemCollection 中必须是唯一的。

label: string

测试项的人性化标签。

uri?: Uri

与此 TestItem 关联的 URI。可能是文件或目录。

返回描述
TestItem

创建一个 TestRun。当请求执行测试时,应由 TestRunProfile 调用此方法,并且如果从外部检测到测试运行,也可能调用此方法。创建后,请求中包含的测试将移至排队状态。

使用同一 request 实例创建的所有运行将分组在一起。例如,如果在一多个平台上运行同一套测试,这将非常有用。

参数描述
request: TestRunRequest

测试运行请求。只能修改 include 中的测试,并且忽略其 exclude 中的测试。

name?: string

运行的人性化名称。这可用于消除测试运行中多组结果的歧义。例如,如果跨多个平台运行测试,这将非常有用。

persist?: boolean

是否应在编辑器中保留运行创建的结果。如果结果来自已在外部保存的文件(例如,覆盖率信息文件),则此值可能为 false。

返回描述
TestRun

TestRun 的一个实例。从调用此方法开始,直到调用 TestRun.end 为止,它将被视为“正在运行”。

注销测试控制器,处置其关联的测试和未持久化的结果。

参数描述
返回描述
void

将项的结果标记为过时。当代码或配置更改并且不应再认为先前结果相关时,通常会调用此方法。用于将结果标记为过时的相同逻辑可用于驱动 持续测试运行

如果将项传递给此方法,则将该项及其所有子项的测试结果标记为过时。如果未传递项,则会将 TestController 拥有的所有测试标记为过时。

在此方法调用之前启动的任何测试运行,包括可能仍在进行的运行,都将在编辑器的 UI 中标记为过时并降低优先级。

参数描述
items?: TestItem | readonly TestItem[]

要标记为过时的项。如果未定义,则控制器的所有项都将标记为过时。

返回描述
void

TestCoverageCount

一个包含有关覆盖资源信息的类。可以给出文件中行、分支和声明的计数。

构造函数

参数描述
covered: number
total: number
返回描述
TestCoverageCount

属性

文件中覆盖的项数。

文件中覆盖的项的总数。

TestItem

“测试资源管理器”视图中显示的项。

TestItem 可以表示测试套件或测试本身,因为它们都具有类似的功能。

属性

控制该项是否在测试资源管理器视图中显示为“繁忙”。在发现子项时显示状态非常有用。

默认为 false

指示是否可以通过解析发现此测试项的子项。

如果为 true,则此项在测试资源管理器视图中显示为可展开,展开该项会导致使用该项调用 TestController.resolveHandler

默认为 false

此测试项的子项。对于测试套件,这可能包含各个测试用例或嵌套套件。

显示在标签旁边的可选描述。

加载测试时遇到的可选错误。

请注意,这不是测试结果,仅应用于表示测试发现中的错误,例如语法错误。

TestItem 的标识符。这用于将文档中的测试结果和测试与工作区(测试资源管理器)中的测试相关联。对于 TestItem 的生命周期,此项不能更改,并且在其父项的直接子项中必须是唯一的。

描述测试用例的显示名称。

此项的父项。它是自动设置的,对于 TestController.items 中的顶级项以及尚未包含在另一项的 children 中的项,则未定义。

测试项在其 uri 中的位置。

仅当 uri 指向文件时,此项才有意义。

将此项与其他项进行比较时应使用的字符串。当 falsy 时,将使用 label

与此测试项关联的标签。可以与 tags 结合使用,或者仅用作组织功能。

TestItem 与之关联的 URI。可能是文件或目录。

TestItemCollection

TestItem.childrenTestController.items 中找到的测试项的集合。

属性

获取集合中的项数。

方法

将测试项添加到子项。如果已存在具有相同 ID 的项,则会将其替换。

参数描述
item: TestItem

要添加的项。

返回描述
void

从集合中删除单个测试项。

参数描述
itemId: string

要删除的项 ID。

返回描述
void

迭代此集合中的每个条目。

参数描述
callback: (item: TestItem, collection: TestItemCollection) => unknown

为每个条目执行的函数。

thisArg?: any

调用处理函数时使用的 this 上下文。

返回描述
void

如果子项中存在,则通过 ID 有效获取测试项。

参数描述
itemId: string

要获取的项 ID。

返回描述
TestItem

找到的项,如果不存在则为 undefined。

替换集合存储的项。

参数描述
items: readonly TestItem[]

要存储的项。

返回描述
void

TestMessage

与测试状态关联的消息。可以链接到特定的源范围,例如,用于断言失败。

静态

创建一个新的 TestMessage,它将在编辑器中显示为差异。

参数描述
message: string | MarkdownString

要向用户显示的消息。

expected: string

预期输出。

actual: string

实际输出。

返回描述
TestMessage

构造函数

创建一个新的 TestMessage 实例。

参数描述
message: string | MarkdownString

要向用户显示的消息。

返回描述
TestMessage

属性

实际测试输出。如果与 expectedOutput 一起给出,将显示差异视图。

测试项的上下文值。这可用于向测试预览视图贡献特定于消息的操作。此处设置的值可以在以下 menus 贡献点的 testMessage 属性中找到

  • testing/message/context - 结果树中消息的上下文菜单
  • testing/message/content - 覆盖显示消息的编辑器内容的突出按钮。

例如

"contributes": {
  "menus": {
    "testing/message/content": [
      {
        "command": "extension.deleteCommentThread",
        "when": "testMessage == canApplyRichDiff"
      }
    ]
  }
}

将使用包含以下内容的对象调用该命令

预期测试输出。如果与 actualOutput 一起给出,将显示差异视图。

关联的文件位置。

要显示的人类可读的消息文本。

与消息或失败关联的堆栈跟踪。

TestMessageStackFrame

TestMessage.stackTrace 中找到的堆栈帧。

构造函数

参数描述
label: string

堆栈帧的名称

uri?: Uri
position?: Position

堆栈帧在文件中的位置

返回描述
TestMessageStackFrame

属性

堆栈帧的名称,通常是方法或函数名称。

堆栈帧在文件中的位置。

此堆栈帧的位置。如果编辑器可以访问调用帧的位置,则应将其作为 URI 提供。

TestRun

TestRun 表示正在进行或已完成的测试运行,并提供报告运行中各个测试状态的方法。

事件

当编辑器不再对与测试运行关联的数据感兴趣时触发的事件。

属性

测试运行是否将由编辑器跨重新加载持久保存。

运行的人性化名称。这可用于消除测试运行中多组结果的歧义。例如,如果跨多个平台运行测试,这将非常有用。

当从 UI 取消测试运行时将触发的取消令牌。

方法

在运行中添加文件的覆盖率。

参数描述
fileCoverage: FileCoverage
返回描述
void

追加来自测试运行器的原始输出。根据用户的请求,输出将显示在终端中。支持 ANSI 转义序列,例如颜色和文本样式。新行必须以 CRLF (\r\n) 而不是 LF (\n) 给出。

参数描述
output: string

要追加的输出文本。

location?: Location

指示输出记录在给定位置。

test?: TestItem

要将输出与之关联的测试项。

返回描述
void

表示测试运行结束。运行中包含的任何状态未更新的测试都将重置其状态。

参数描述
返回描述
void

表示测试已排队等待稍后执行。

参数描述
test: TestItem

要更新的测试项。

返回描述
void

表示测试已出错。应传递一个或多个 TestMessages 来描述失败。这与“失败”状态不同,因为它表示无法执行的测试,例如来自编译错误。

参数描述
test: TestItem

要更新的测试项。

message: TestMessage | readonly TestMessage[]

与测试失败关联的消息。

duration?: number

测试执行所花费的时间,以毫秒为单位。

返回描述
void

表示测试已失败。应传递一个或多个 TestMessages 来描述失败。

参数描述
test: TestItem

要更新的测试项。

message: TestMessage | readonly TestMessage[]

与测试失败关联的消息。

duration?: number

测试执行所花费的时间,以毫秒为单位。

返回描述
void

表示测试已通过。

参数描述
test: TestItem

要更新的测试项。

duration?: number

测试执行所花费的时间,以毫秒为单位。

返回描述
void

表示测试已被跳过。

参数描述
test: TestItem

要更新的测试项。

返回描述
void

表示测试已开始运行。

参数描述
test: TestItem

要更新的测试项。

返回描述
void

TestRunProfile

TestRunProfile 描述在 TestController 中执行测试的一种方法。

事件

当用户更改此配置文件是否为默认配置文件时触发。该事件包含 isDefault 的新值。

属性

如果存在此方法,则 UI 中会显示一个配置齿轮,并且单击该齿轮时将调用此方法。调用时,您可以采取其他编辑器操作,例如显示快速选择或打开配置文件。

参数描述
返回描述
void

控制此配置文件是否是其类型被操作时将采取的默认操作。例如,如果用户单击通用的“全部运行”按钮,则将执行 TestRunProfileKind.Run 的默认配置文件,尽管用户可以配置它。

用户在其默认配置文件中所做的更改将在 onDidChangeDefault 事件之后反映在此属性中。

配置此配置文件控制的执行类型。如果某种类型没有配置文件,则它在 UI 中将不可用。

在 UI 中向用户显示的标签。

请注意,如果用户请求以某种方式重新运行测试,则标签具有一定的意义。例如,如果测试正常运行,并且用户请求以调试模式重新运行它们,则编辑器将尝试使用与 Debug 类型具有相同标签的配置。如果没有此类配置,则将使用默认配置。

扩展程序提供的函数,用于为文件提供详细的语句和函数级覆盖率。当需要更多文件详细信息时,例如当文件在编辑器中打开或在“**测试覆盖率**”视图中展开时,编辑器将调用此函数。

传递给此函数的 FileCoverage 对象是与此配置文件关联的 TestRun.addCoverage 调用时发出的同一实例。

参数描述
testRun: TestRun
fileCoverage: FileCoverage
token: CancellationToken
返回描述
Thenable<FileCoverageDetail[]>

扩展程序提供的函数,用于为文件中单个测试提供详细的语句和函数级覆盖率。这是 TestRunProfile.loadDetailedCoverage 的每个测试的同级函数,仅当 FileCoverage.includesTests 中提供了测试项,并且仅针对报告了此类数据的文件调用。

通常,当用户打开文件时,会首先调用 TestRunProfile.loadDetailedCoverage,然后如果他们深入了解特定的每个测试的覆盖率信息,则将调用此方法。然后,此方法应仅返回在运行期间由特定测试执行的语句和声明的覆盖率数据。

传递给此函数的 FileCoverage 对象是与此配置文件关联的 TestRun.addCoverage 调用时发出的同一实例。

参数描述
testRun: TestRun

生成覆盖率数据的测试运行。

fileCoverage: FileCoverage

要加载详细覆盖率的文件覆盖率对象。

fromTestItem: TestItem

要请求覆盖率信息的测试项。

token: CancellationToken

指示应取消操作的取消标记。

返回描述
Thenable<FileCoverageDetail[]>

用于启动测试运行的处理程序。调用时,该函数应至少调用一次 TestController.createTestRun,并且在函数返回或返回的 promise 被解析之前,应创建与请求关联的所有测试运行。

如果设置了 supportsContinuousRun,则 TestRunRequest.continuous 可能为 true。在这种情况下,配置文件应观察源代码的更改,并通过调用 TestController.createTestRun 来创建新的测试运行,直到在 token 上请求取消为止。

参数描述
request: TestRunRequest

测试运行的请求信息。

token: CancellationToken
返回描述
void | Thenable<void>

此配置文件是否支持连续运行请求。如果是,则可以将 TestRunRequest.continuous 设置为 true。默认为 false。

配置文件的关联标记。如果设置了此项,则只有具有相同标记的 TestItem 实例才有资格在此配置文件中执行。

方法

删除运行配置文件。

参数描述
返回描述
void

TestRunProfileKind

TestRunProfiles 控制的执行类型。

枚举成员

Run 测试配置文件类型。

Debug 测试配置文件类型。

Coverage 测试配置文件类型。

TestRunRequest

TestRunRequest 是 TestRun 的前身,而 TestRun 又是通过将请求传递给 TestController.createTestRun 创建的。TestRunRequest 包含有关应运行哪些测试、不应运行哪些测试以及如何运行它们(通过 profile)的信息。

通常,TestRunRequest 由编辑器创建并传递给 TestRunProfile.runHandler,但是您也可以在 runHandler 之外创建测试请求和运行。

构造函数

参数描述
include?: readonly TestItem[]

要运行的特定测试数组,如果未定义,则运行所有测试

exclude?: readonly TestItem[]

要从运行中排除的测试数组。

profile?: TestRunProfile

用于此请求的运行配置文件。

continuous?: boolean

是否在源代码更改时连续运行测试。

preserveFocus?: boolean

是否在启动运行时保留用户的焦点

返回描述
TestRunRequest

属性

配置文件是否应在源代码更改时连续运行。仅与设置了 TestRunProfile.supportsContinuousRun 的配置文件相关。

用户标记为从此运行中包含的测试中排除的测试数组;排除项应在包含项之后应用。

如果未请求排除项,则可以省略。测试控制器不应运行排除的测试或排除的测试的任何子项。

要运行的特定测试的过滤器。如果给定,则扩展应运行所有包含的测试及其所有子项,排除 TestRunRequest.exclude 中出现的任何测试。如果此属性未定义,则扩展应简单地运行所有测试。

运行测试的过程应解析尚未解析的任何测试项的子项。

控制如何聚焦测试结果视图。如果为 true,则编辑器将保持用户的焦点。如果为 false,则编辑器将首选将焦点移动到“测试结果”视图中,尽管用户可以配置此项。

此请求使用的配置文件。对于从编辑器 UI 发出的请求,此项将始终被定义,但扩展程序可能会以编程方式创建未与任何配置文件关联的请求。

TestTag

标签可以与 TestItemsTestRunProfiles 关联。带有标签的配置文件只能执行其 TestItem.tags 数组中包含该标签的测试。

构造函数

创建一个新的 TestTag 实例。

参数描述
id: string

测试标签的 ID。

返回描述
TestTag

属性

测试标签的 ID。具有相同 ID 的 TestTag 实例被视为相同。

TextDocument

表示文本文件,例如源文件。文本文件具有,并了解底层资源,例如文件。

属性

此文档中主要使用的行尾序列。

关联资源的的文件系统路径。TextDocument.uri.fsPath 的简写符号。独立于 URI 方案。

如果文档已关闭,则为 true。关闭的文档不再同步,当再次打开同一资源时,不会重新使用该文档。

如果存在未持久化的更改,则为 true

此文档是否表示尚未保存的无标题文件。注意,这并不意味着该文档将保存到磁盘,请使用 Uri.scheme 来确定文档将保存到的位置,例如 fileftp 等。

与此文档关联的语言的标识符。

此文档中的行数。

此文档的关联 uri。

注意,大多数文档都使用 file 方案,这意味着它们是磁盘上的文件。但是,并非所有文档都保存在磁盘上,因此在尝试访问磁盘上的底层文件或同级文件之前,必须检查 scheme

另请参阅

此文档的版本号(每次更改(包括撤消/重做)后,它都会严格增加)。

方法

获取此文档的文本。可以通过提供范围来检索子字符串。范围将被调整

参数描述
range?: Range

仅包含范围内的文本。

返回描述
string

提供的范围内的文本或整个文本。

获取给定位置的单词范围。默认情况下,单词由常见的分隔符(如空格、-、_ 等)定义。此外,可以定义每种语言的自定义[单词定义]。也可以提供自定义正则表达式。

  • 注意 1:自定义正则表达式不得匹配空字符串,如果匹配,则会被忽略。
  • 注意 2:自定义正则表达式将无法匹配多行字符串,并且为了提高速度,正则表达式不应匹配带有空格的单词。对于更复杂的非单词场景,请使用TextLine.text

位置将被调整

参数描述
position: Position

一个位置。

regex?: RegExp

可选的正则表达式,描述什么是单词。

返回描述
Range

跨越单词的范围,或 undefined

返回由行号表示的文本行。请注意,返回的对象不是实时的,并且对文档的更改不会反映出来。

参数描述
line: number

[0, lineCount) 中的行号。

返回描述
TextLine

返回由位置表示的文本行。请注意,返回的对象不是实时的,并且对文档的更改不会反映出来。

位置将被调整

另请参阅 TextDocument.lineAt

参数描述
position: Position

一个位置。

返回描述
TextLine

将位置转换为从零开始的偏移量。

位置将被调整

参数描述
position: Position

一个位置。

返回描述
number

有效的从零开始的偏移量。

将从零开始的偏移量转换为位置。

参数描述
offset: number

从零开始的偏移量。

返回描述
Position

有效的 Position

保存底层文件。

参数描述
返回描述
Thenable<boolean>

当文件保存后将解析为 true 的 Promise。如果保存失败,则返回 false

确保位置包含在此文档的范围内。

参数描述
position: Position

一个位置。

返回描述
Position

给定的位置或新的、调整后的位置。

确保范围完全包含在此文档中。

参数描述
range: Range

一个范围。

返回描述
Range

给定的范围或新的、调整后的范围。

TextDocumentChangeEvent

描述事务性 文档 更改的事件。

属性

内容更改的数组。

受影响的文档。

文档更改的原因。如果原因未知,则为 undefined

TextDocumentChangeReason

文本文件发生更改的原因。

枚举成员

文本更改是由撤消操作引起的。

文本更改是由重做操作引起的。

TextDocumentContentChangeEvent

描述 文档文本中单个更改的事件。

属性

被替换的范围。

被替换的范围的长度。

被替换的范围的偏移量。

该范围的新文本。

TextDocumentContentProvider

文本文档内容提供程序允许向编辑器添加只读文档,例如来自 dll 的源代码或从 md 生成的 html。

内容提供程序会针对 uri-scheme 进行注册。当需要加载具有该 scheme 的 uri 时,会询问内容提供程序。

事件

用于发出资源已更改信号的事件。

方法

为给定的 uri 提供文本内容。

编辑器将使用返回的字符串内容来创建一个只读的 文档。当相应的文档被关闭时,应释放已分配的资源。

注意:由于行尾序列的规范化,创建的文档的内容可能与提供的文本不完全相同。

参数描述
uri: Uri

uri 的 scheme 与此提供程序注册的 scheme 相匹配。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<string>

字符串或解析为字符串的可 thenable 对象。

TextDocumentSaveReason

表示文本文档被保存的原因。

枚举成员

手动触发,例如用户按保存键、开始调试或通过 API 调用。

延迟后自动保存。

当编辑器失去焦点时。

TextDocumentShowOptions

表示配置在 编辑器 中显示 文档 的行为的选项。

属性

一个可选标志,当为 true 时,将阻止 编辑器 获取焦点。

一个可选标志,用于控制 编辑器 选项卡是否显示为预览。预览选项卡将被替换和重用,直到设置为保持(显式或通过编辑)。

注意,如果用户在设置中禁用了预览编辑器,则该标志将被忽略。

一个可选的选择范围,应用于 编辑器 中的文档。

一个可选的视图列,编辑器应在该列中显示。默认值为活动列。不存在的列将按需创建,最多为ViewColumn.Nine。使用 ViewColumn.Beside 将编辑器打开到当前活动编辑器的侧面。

TextDocumentWillSaveEvent

文档 即将被保存时触发的事件。

要在文档被保存之前对其进行修改,请使用解析为 文本编辑 数组的 thenable 调用 waitUntil 函数。

属性

即将保存的文档。

触发保存的原因。

方法

允许暂停事件循环并应用 预保存编辑。对该函数的后续调用所进行的编辑将按顺序应用。如果文档发生了并发修改,则编辑将被忽略

注意: 此函数只能在事件调度期间调用,而不能以异步方式调用

workspace.onWillSaveTextDocument(event => {
  // async, will *throw* an error
  setTimeout(() => event.waitUntil(promise));

  // sync, OK
  event.waitUntil(promise);
});
参数描述
thenable: Thenable<readonly TextEdit[]>

一个解析为 预保存编辑的 thenable 对象。

返回描述
void

允许暂停事件循环,直到提供的 thenable 解析。

注意: 此函数只能在事件调度期间调用。

参数描述
thenable: Thenable<any>

延迟保存的 thenable。

返回描述
void

TextEdit

文本编辑表示应应用于文档的编辑。

静态

用于创建删除编辑的实用程序。

参数描述
range: Range

一个范围。

返回描述
TextEdit

一个新的文本编辑对象。

用于创建插入编辑的实用程序。

参数描述
position: Position

一个位置,将变成一个空范围。

newText: string

一个字符串。

返回描述
TextEdit

一个新的文本编辑对象。

用于创建替换编辑的实用程序。

参数描述
range: Range

一个范围。

newText: string

一个字符串。

返回描述
TextEdit

一个新的文本编辑对象。

用于创建 eol 编辑的实用程序。

参数描述
eol: EndOfLine

一个 eol 序列

返回描述
TextEdit

一个新的文本编辑对象。

构造函数

创建一个新的 TextEdit。

参数描述
range: Range

一个范围。

newText: string

一个字符串。

返回描述
TextEdit

属性

文档中使用的 eol 序列。

注意,eol 序列将应用于整个文档。

此编辑将插入的字符串。

此编辑应用到的范围。

TextEditor

表示附加到 文档 的编辑器。

属性

与此文本编辑器关联的文档。该文档在此文本编辑器的整个生命周期内保持不变。

文本编辑器选项。

此文本编辑器上的主要选择。是 TextEditor.selections[0] 的简写形式。

此文本编辑器中的选择。主要选择始终位于索引 0 处。

此编辑器所在的列。如果这不是主要编辑器之一(例如嵌入式编辑器),或者编辑器列大于三列,则为 undefined

编辑器中当前可见的范围(垂直方向)。这仅考虑垂直滚动,而不考虑水平滚动。

方法

对此文本编辑器关联的文档执行编辑。

使用一个 编辑构建器 调用给定的回调函数,该构建器必须用于进行编辑。请注意,编辑构建器仅在回调执行时有效。

参数描述
callback: (editBuilder: TextEditorEdit) => void

一个可以使用 编辑构建器 创建编辑的函数。

options?: {undoStopAfter: boolean, undoStopBefore: boolean}

围绕此编辑的撤消/重做行为。默认情况下,将在此编辑之前和之后创建撤消停止。

返回描述
Thenable<boolean>

一个 promise,解析为一个值,指示是否可以应用编辑。

隐藏文本编辑器。

  • 已弃用 - 请改用命令 workbench.action.closeActiveEditor。此方法显示意外行为,将在下一个主要更新中删除。
参数描述
返回描述
void

插入一个代码片段,并将编辑器置于代码片段模式。“代码片段模式”意味着编辑器会添加占位符和额外的光标,以便用户可以完成或接受代码片段。

参数描述
snippet: SnippetString

此编辑中要插入的代码片段。

location?: Range | Position | readonly Range[] | readonly Position[]

插入代码片段的位置或范围,默认为当前编辑器的选区或多个选区。

options?: {undoStopAfter: boolean, undoStopBefore: boolean}

围绕此编辑的撤消/重做行为。默认情况下,将在此编辑之前和之后创建撤消停止。

返回描述
Thenable<boolean>

一个 Promise,其解析结果表示是否可以插入代码片段。请注意,该 Promise 不会指示代码片段是否已完全填充或接受。

按照 revealType 指示的方式滚动,以显示给定的范围。

参数描述
range: Range

一个范围。

revealType?: TextEditorRevealType

用于显示 range 的滚动策略。

返回描述
void

向文本编辑器添加一组修饰。如果已存在具有给定修饰类型的修饰集,则将替换它们。如果 rangesOrOptions 为空,则将删除具有给定修饰类型的现有修饰。

另请参阅 createTextEditorDecorationType

参数描述
decorationType: TextEditorDecorationType

修饰类型。

rangesOrOptions: readonly Range[] | readonly DecorationOptions[]

可以是 范围,也可以是更详细的 选项

返回描述
void

显示文本编辑器。

参数描述
column?: ViewColumn

显示此编辑器的。此方法会显示意外行为,将在下一个主要更新中删除。

返回描述
void

TextEditorCursorStyle

光标的渲染样式。

枚举成员

将光标渲染为垂直粗线。

将光标渲染为填充的块。

将光标渲染为水平粗线。

将光标渲染为垂直细线。

将光标渲染为轮廓块。

将光标渲染为水平细线。

TextEditorDecorationType

表示在文本编辑器中共享相同样式选项的一组修饰的句柄。

要获取 TextEditorDecorationType 的实例,请使用 createTextEditorDecorationType

属性

句柄的内部表示形式。

方法

删除此修饰类型以及所有文本编辑器上使用它的所有修饰。

参数描述
返回描述
void

TextEditorEdit

一个复杂的编辑,将在 TextEditor 上一次性应用。它保存了编辑的描述,并且如果编辑有效(即,没有重叠区域,文档在此期间未更改等),则可以将它们应用到与 文本编辑器关联的 文档上。

方法

删除某个文本区域。

参数描述
location: Range | Selection

此操作应删除的范围。

返回描述
void

在某个位置插入文本。可以在 value 中使用 \r\n\n,它们将被标准化为当前 文档。尽管可以使用 replace 进行等效的文本编辑,但 insert 将产生不同的结果选择(它将被移动)。

参数描述
location: Position

应插入新文本的位置。

value: string

此操作应插入的新文本。

返回描述
void

用新值替换某个文本区域。可以在 value 中使用 \r\n\n,它们将被标准化为当前 文档

参数描述
location: Range | Position | Selection

此操作应删除的范围。

value: string

删除 location 后此操作应插入的新文本。

返回描述
void

设置行尾序列。

参数描述
endOfLine: EndOfLine

文档的新行尾。

返回描述
void

TextEditorLineNumbersStyle

行号的渲染样式。

枚举成员

不渲染行号。

渲染行号。

渲染相对于主光标位置的行号。

每 10 行渲染行号。

TextEditorOptions

表示 文本编辑器选项

属性

此编辑器中光标的渲染样式。获取文本编辑器的选项时,此属性始终存在。设置文本编辑器的选项时,此属性是可选的。

insertSpaces 为 true 时要插入的空格数。

获取文本编辑器的选项时,此属性始终是一个数字(已解析)。设置文本编辑器的选项时,此属性是可选的,它可以是一个数字或 "tabSize"

按下 Tab 键时,插入 n 个空格。获取文本编辑器的选项时,此属性始终是一个布尔值(已解析)。设置文本编辑器的选项时,此属性是可选的,它可以是一个布尔值或 "auto"

相对于当前行号渲染相对行号。获取文本编辑器的选项时,此属性始终存在。设置文本编辑器的选项时,此属性是可选的。

一个制表符占用的空格大小。它用于两个目的:

  • 制表符的渲染宽度;
  • insertSpaces 为 true 且 indentSize 设置为 "tabSize" 时要插入的空格数。

当获取文本编辑器的选项时,此属性始终是一个数字(已解析)。当设置文本编辑器的选项时,此属性是可选的,它可以是一个数字或 "auto"

TextEditorOptionsChangeEvent

表示描述 文本编辑器选项 更改的事件。

属性

文本编辑器选项 的新值。

选项已更改的 文本编辑器

TextEditorRevealType

表示文本编辑器中不同的 显示策略。

枚举成员

将以尽可能少的滚动方式显示该范围。

该范围将始终在视口的中心显示。

如果该范围在视口之外,则将在视口的中心显示。否则,将以尽可能少的滚动方式显示。

该范围将始终在视口的顶部显示。

TextEditorSelectionChangeEvent

表示描述 文本编辑器选择 更改的事件。

属性

触发此事件的更改类型。可以是 undefined

文本编辑器选择 的新值。

选择已更改的 文本编辑器

TextEditorSelectionChangeKind

表示可能导致 选择更改事件 的源。

枚举成员

由于在编辑器中键入而导致的选择更改。

由于在编辑器中单击而导致的选择更改。

由于运行命令而导致的选择更改。

TextEditorViewColumnChangeEvent

表示描述 文本编辑器视图列 更改的事件。

属性

视图列已更改的 文本编辑器

TextEditorVisibleRangesChangeEvent

表示描述 文本编辑器可见范围 更改的事件。

属性

可见范围已更改的 文本编辑器

TextLine

表示文本行,例如源代码行。

TextLine 对象是不可变的。当 文档 更改时,先前检索到的行将不代表最新状态。

属性

/\s/ 定义的第一个非空白字符的偏移量。请注意,如果某行全部是空白,则会返回该行的长度。

此行是否仅包含空白,是 TextLine.firstNonWhitespaceCharacterIndex === TextLine.text.length 的简写形式。

基于零的行号。

此行覆盖的范围,不包括行分隔符字符。

此行覆盖的范围,包括行分隔符字符。

此行的文本,不包括行分隔符字符。

ThemableDecorationAttachmentRenderOptions

表示 之前之后 文本装饰内容的特定主题渲染样式。

属性

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

要呈现在附件中的图像的绝对路径或 URI。可以显示图标或文本,但不能同时显示两者。

定义在附件中显示的文本内容。可以显示图标或文本,但不能同时显示两者。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

将应用于装饰附件的 CSS 样式属性。

ThemableDecorationInstanceRenderOptions

表示装饰实例的可主题化渲染选项。

属性

定义插入到装饰文本之后的附件的渲染选项。

定义插入到装饰文本之前的附件的渲染选项。

ThemableDecorationRenderOptions

表示文本编辑器装饰的主题特定渲染样式。

属性

定义插入到装饰文本之后的附件的渲染选项。

装饰的背景颜色。使用 rgba() 并定义透明背景颜色以与其他装饰良好配合。或者,可以引用颜色注册表中的颜色。

定义插入到装饰文本之前的附件的渲染选项。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“border”来设置一个或多个单独的边框属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

要在装订线中呈现的图像的绝对路径或 URI。

指定装订线图标的大小。可用值包括“auto”、“contain”、“cover”和任何百分比值。有关详细信息:https://msdn.microsoft.com/en-us/library/jj127316(v=vs.85).aspx

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

将应用于装饰所包围的文本的 CSS 样式属性。最好使用“outline”来设置一个或多个单独的轮廓属性。

概览标尺中装饰的颜色。使用 rgba() 并定义透明颜色以与其他装饰良好配合。

将应用于装饰所包围的文本的 CSS 样式属性。

ThemeColor

对工作台颜色之一的引用,如 https://vscode.js.cn/api/references/theme-color 中定义的那样。与自定义颜色相比,使用主题颜色更好,因为它使主题作者和用户可以更改颜色。

构造函数

创建对主题颜色的引用。

参数描述
id: string

颜色的 id。可用颜色在 https://vscode.js.cn/api/references/theme-color 中列出。

返回描述
ThemeColor

属性

此颜色的 ID。

ThemeIcon

对命名图标的引用。目前,支持 文件文件夹主题图标 ID。与自定义图标相比,使用主题图标更好,因为它使产品主题作者可以更改图标。

注意,主题图标也可以在标签和描述中呈现。支持主题图标的地方会明确指出这一点,并且使用 $(<name>) 语法,例如 quickPick.label = "你好世界 $(globe)"

静态

引用表示文件的图标。该图标取自当前文件图标主题,或者使用占位符图标。

引用表示文件夹的图标。该图标取自当前文件图标主题,或者使用占位符图标。

构造函数

创建对主题图标的引用。

参数描述
id: string

图标的 ID。可用图标在 https://vscode.js.cn/api/references/icons-in-labels#icon-listing 中列出。

color?: ThemeColor

图标的可选 ThemeColor。该颜色目前仅在 TreeItem 中使用。

返回描述
ThemeIcon

属性

图标的可选 ThemeColor。该颜色目前仅在 TreeItem 中使用。

图标的 ID。可用图标在 https://vscode.js.cn/api/references/icons-in-labels#icon-listing 中列出。

TreeCheckboxChangeEvent<T>

描述树项复选框状态更改的事件。

属性

已选中或取消选中的项。

TreeDataProvider<T>

提供树数据的 数据提供程序

事件

一个可选事件,用于指示元素或根已更改。这将触发视图更新已更改的元素/根及其子元素(如果显示)。要指示根已更改,请不要传递任何参数或传递 undefinednull

方法

获取 element 的子元素;如果未传递任何元素,则获取根的子元素。

参数描述
element?: T

提供程序从中获取子元素的元素。可以是 undefined

返回描述
ProviderResult<T[]>

element 的子元素;如果未传递任何元素,则获取根的子元素。

用于返回 element 的父级的可选方法。如果 element 是根的子级,则返回 nullundefined

注意:应实现此方法以访问 reveal API。

参数描述
element: T

要返回其父级的元素。

返回描述
ProviderResult<T>

element 的父级。

获取 elementTreeItem 表示形式。

参数描述
element: T

请求 TreeItem 表示形式的元素。

返回描述
TreeItem | Thenable<TreeItem>

元素的 TreeItem 表示形式。

当鼠标悬停时,如果 TreeItem 属性未定义,则会调用此方法来解析该属性。当单击/打开树项时,如果 TreeItem 属性未定义,则会调用此方法来解析该属性。只有未定义的属性可以在 resolveTreeItem 中解析。此功能可能会在以后扩展,以便在选择和/或打开时解析其他缺失的属性。

每个 TreeItem 只会被调用一次。

不应从 resolveTreeItem 中触发 onDidChangeTreeData。

注意,此函数是在 UI 中已显示树项时调用的。因此,不能更改任何会更改外观(标签、描述等)的属性。

参数描述
item: TreeItem

应设置 item 的未定义属性,然后应返回 item

element: T

与 TreeItem 关联的对象。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TreeItem>

已解析的树项或解析为树项的可 thenable 对象。返回给定的 item 是可以的。当没有返回结果时,将使用给定的 item

TreeDragAndDropController<T>

TreeView 提供拖放支持。

属性

TreeDragAndDropControllerhandleDrag 方法可能会添加到树数据传输中的 MIME 类型。这可以是定义完善的现有 MIME 类型,也可以是扩展定义的 MIME 类型。

树的建议 MIME 类型 (application/vnd.code.tree.<treeidlowercase>) 将自动添加。

DragAndDropControllerhandleDrop 方法支持的 MIME 类型。这可以是定义完善的现有 MIME 类型,也可以是扩展定义的 MIME 类型。

要支持从树中拖放,您需要添加该树的 MIME 类型。这包括从同一树中拖放。建议树的 MIME 类型格式为 application/vnd.code.tree.<treeidlowercase>

使用特殊的 files MIME 类型来支持所有类型的拖放文件 files,而不管文件的实际 MIME 类型是什么。

要了解拖动项的 MIME 类型

  1. 设置您的 DragAndDropController
  2. 使用“开发人员:设置日志级别...”命令将级别设置为“调试”
  3. 打开开发者工具并将具有未知 MIME 类型的项目拖到您的树上。MIME 类型将记录到开发者控制台

请注意,无法发送到扩展的 MIME 类型将被省略。

方法

当用户开始从此 DragAndDropController 拖动项目时,将调用 handleDrag。扩展可以使用 handleDrag 将其 DataTransferItem 项添加到拖放中。

当项目拖放到同一树中另一个树项上时,您的 DataTransferItem 对象将被保留。使用建议的树的 MIME 类型 (application/vnd.code.tree.<treeidlowercase>) 在数据传输中添加树对象。有关如何充分利用此优势,请参阅 DataTransferItem 的文档。

要添加可以拖入编辑器的数据传输项,请使用应用程序特定的 MIME 类型“text/uri-list”。“text/uri-list”的数据应该是一个字符串,其中包含由 \r\n 分隔的 toString() 化的 URI。要在文件中指定光标位置,请将 URI 的片段设置为 L3,5,其中 3 是行号,5 是列号。

参数描述
source: readonly T[]

拖放操作的源项。

dataTransfer: DataTransfer

与此拖动关联的数据传输。

token: CancellationToken

指示拖动已取消的取消标记。

返回描述
void | Thenable<void>

当拖放操作导致拖放到此 DragAndDropController 所属的树上时调用。

对于任何需要刷新的元素,扩展应触发 onDidChangeTreeData

参数描述
target: T

发生拖放的目标树元素。当未定义时,目标是根。

dataTransfer: DataTransfer

拖动源的数据传输项。

token: CancellationToken

指示拖放已取消的取消标记。

返回描述
void | Thenable<void>

TreeItem

树项是树的 UI 元素。树项由 数据提供程序创建。

构造函数

参数描述
label: string | TreeItemLabel

描述此项的人类可读字符串

collapsibleState?: TreeItemCollapsibleState
返回描述
TreeItem

参数描述
resourceUri: Uri

表示此项的资源的 Uri

collapsibleState?: TreeItemCollapsibleState
返回描述
TreeItem

属性

当屏幕阅读器与此树项交互时使用的辅助功能信息。通常,TreeItem 不需要设置 accessibilityInformation 的 role;但是,在某些情况下,TreeItem 不是以树状方式显示,这时设置 role 可能有意义。

树项的 TreeItemCheckboxState。当 checkboxState 更改时,应触发 onDidChangeTreeData

选择树项时应执行的 Command

当树项在编辑器中打开某些内容时,请使用 vscode.openvscode.diff 作为命令 ID。使用这些命令可确保生成的编辑器与内置树打开编辑器的方式保持一致。

树项的上下文值。这可用于在树中贡献特定于项的操作。例如,树项的上下文值设置为 folder。当使用 menus 扩展点向 view/item/context 贡献操作时,您可以在 when 表达式中为键 viewItem 指定上下文值,如 viewItem == folder

"contributes": {
  "menus": {
    "view/item/context": [
      {
        "command": "extension.deleteFolder",
        "when": "viewItem == folder"
      }
    ]
  }
}

这将仅为 contextValuefolder 的项显示操作 extension.deleteFolder

以不显眼的方式呈现的人类可读字符串。当 true 时,它派生自 resourceUri,当 falsy 时,它不显示。

树项的图标路径或 ThemeIcon。当 falsy 时,如果该项可折叠,则分配 文件夹主题图标,否则分配 文件主题图标。当指定文件或文件夹 主题图标时,图标从当前文件图标主题派生,方法是使用 resourceUri(如果提供)获取指定主题图标。

树项的可选 ID,该 ID 在整个树中必须是唯一的。该 ID 用于保留树项的选择和展开状态。

如果未提供,则使用树项的标签生成 ID。请注意,当标签更改时,ID 将更改,并且选择和展开状态将无法再保持稳定。

描述此项的可读字符串。当为 falsy 时,它从 resourceUri 派生。

表示此项的资源的 Uri

当未提供 label 时,将用于派生该标签。当 iconPath 具有 ThemeIcon 值时,将用于从当前文件图标主题派生图标。

当您将鼠标悬停在此项上时显示的工具提示文本。

TreeItemCheckboxState

树形项的复选框状态

枚举成员

确定一个项未选中

确定一个项已选中

TreeItemCollapsibleState

树形项的可折叠状态

枚举成员

确定一个项既不能折叠也不能展开。暗示它没有子项。

确定项是否已折叠

确定项是否已展开

TreeItemLabel

描述 树形项 的标签

属性

标签中要突出显示的部分。范围定义为两个数字的元组,其中第一个是包含的起始索引,第二个是排除的结束索引

描述 树形项 的可读字符串。

TreeView<T>

表示树形视图

事件

一个事件,用于表示元素或根已被选中或未选中。

selection 发生更改时触发的事件

visibility 发生更改时触发的事件

当元素折叠时触发的事件

当元素展开时触发的事件

属性

为此 TreeView 显示的徽章。要删除徽章,请设置为 undefined。

一个可选的可读描述,在视图的标题中以较不突出的方式呈现。将标题描述设置为 null、undefined 或空字符串将从视图中删除描述。

将在视图中呈现的可选可读消息。将消息设置为 null、undefined 或空字符串将从视图中删除消息。

当前选定的元素。

树形视图标题最初取自扩展包 package.json。 对标题属性的更改将正确反映在视图标题的 UI 中。

如果 树形视图 可见,则为 true,否则为 false

方法

释放此对象。

参数描述
返回描述
any

在树形视图中显示给定元素。如果树形视图不可见,则显示树形视图并显示元素。

默认情况下,显示的元素会被选中。为了不选择,请将选项 select 设置为 false。为了聚焦,请将选项 focus 设置为 true。为了展开显示的元素,请将选项 expand 设置为 true。 要递归展开,请将 expand 设置为要展开的级别数。

参数描述
element: T
options?: {expand: number | boolean, focus: boolean, select: boolean}
返回描述
Thenable<void>

TreeViewExpansionEvent<T>

TreeView 中的元素展开或折叠时触发的事件

属性

展开或折叠的元素。

TreeViewOptions<T>

用于创建 TreeView 的选项

属性

树是否支持多选。当树支持多选并且从树执行命令时,命令的第一个参数是执行命令的树形项,第二个参数是包含所有选定树形项的数组。

一个可选的接口,用于在树形视图中实现拖放。

默认情况下,当已获取树形项的子项时,子复选框会根据父树形项的选中状态自动管理。如果树形项默认折叠(这意味着尚未获取子项),则不会更新子复选框。要覆盖此行为并在扩展中管理子和父复选框状态,请将其设置为 true

以下是 TreeViewOptions.manageCheckboxStateManually 为 false 时的示例,即默认行为

  1. 选中一个树形项,然后获取其子项。子项将被选中。

  2. 当选中树形项的父项时,该树形项及其所有兄弟项都将被选中。

  • 父项
    • 子项 1
    • 子项 2 当用户选中父项时,树形结构将如下所示
  • 父项
    • 子项 1
    • 子项 2
  1. 当选中树形项及其所有兄弟项时,父项将被选中。
  • 父项
    • 子项 1
    • 子项 2 当用户选中子项 1 和子项 2 时,树形结构将如下所示
  • 父项
    • 子项 1
    • 子项 2
  1. 当取消选中树形项时,父项将被取消选中。
  • 父项
    • 子项 1
    • 子项 2 当用户取消选中子项 1 时,树形结构将如下所示
  • 父项
    • 子项 1
    • 子项 2

是否显示全部折叠操作。

提供树形数据的数据提供程序。

TreeViewSelectionChangeEvent<T>

树视图的选择发生更改时触发的事件

属性

选定的元素。

TreeViewVisibilityChangeEvent

树视图的可见性发生更改时触发的事件

属性

如果 树形视图 可见,则为 true,否则为 false

TypeDefinitionProvider

类型定义提供程序定义了扩展和转到类型定义功能之间的约定。

方法

提供给定位置和文档处符号的类型定义。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<Definition | LocationLink[]>

一个定义,或一个可以解析为该定义的 Promise。 返回 undefinednull 可以表示没有结果。

TypeHierarchyItem

表示类型层次结构中的项,如类或接口。

构造函数

创建一个新的类型层次结构项。

参数描述
kind: SymbolKind

项的种类。

name: string

项的名称。

detail: string

项的详细信息。

uri: Uri

项的 URI。

range: Range

项的整个范围。

selectionRange: Range

项的选择范围。

返回描述
TypeHierarchyItem

属性

此项的更多详细信息,例如函数的签名。

此项的种类。

此项的名称。

封闭此符号的范围,不包括开头/结尾的空格,但包括所有其他内容,例如注释和代码。

当选择和显示此符号时,应选择和显示的范围,例如类的名称。必须包含在range属性中。

此项的标签。

此项的资源标识符。

TypeHierarchyProvider

类型层次结构提供程序接口描述了扩展和类型层次结构功能之间的约定。

方法

通过返回给定文档和位置表示的项来引导类型层次结构。此项将用作类型图的入口。当给定位置没有项时,提供程序应返回undefinednull

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TypeHierarchyItem | TypeHierarchyItem[]>

一个或多个类型层次结构项或一个可解析为这种项的可 thenable 对象。缺少结果可以通过返回undefinednull或空数组来表示。

提供项的所有子类型,例如从给定项派生/继承的所有类型。在图论中,这描述了类型图中的定向和带注释的边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: TypeHierarchyItem

应计算子类型的层次结构项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TypeHierarchyItem[]>

一组直接子类型或一个可解析为这种子类型的可 thenable 对象。缺少结果可以通过返回undefinednull来表示。

提供项的所有超类型,例如,类型派生/继承自的所有类型。在图论中,这描述了类型图中的定向和带注释的边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: TypeHierarchyItem

应计算超类型的层次结构项。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<TypeHierarchyItem[]>

一组直接超类型或一个可解析为这种超类型的可 thenable 对象。缺少结果可以通过返回undefinednull来表示。

UIKind

可以使用扩展程序的可能 UI 种类。

枚举成员

从桌面应用程序访问扩展程序。

从 Web 浏览器访问扩展程序。

Uri

一个通用的资源标识符,表示磁盘上的文件或其他资源,如未命名的资源。

静态

从文件系统路径创建 URI。scheme将为file

Uri.parseUri.file 之间的区别在于,后者将参数视为路径,而不是字符串化 URI。例如,Uri.file(path)Uri.parse('file://' + path) 不同,因为路径可能包含被解释的字符(# 和 ?)。请参阅以下示例

const good = URI.file('/coding/c#/project1');
good.scheme === 'file';
good.path === '/coding/c#/project1';
good.fragment === '';

const bad = URI.parse('file://' + '/coding/c#/project1');
bad.scheme === 'file';
bad.path === '/coding/c'; // path is now broken
bad.fragment === '/project1';
参数描述
path: string

文件系统或 UNC 路径。

返回描述
Uri

新的 Uri 实例。

从其组成部分创建 URI

另请参阅 Uri.toString

参数描述
components: {authority: string, fragment: string, path: string, query: string, scheme: string}

Uri 的组成部分。

返回描述
Uri

新的 Uri 实例。

创建一个新的 uri,其路径是将基本 uri 的路径与提供的路径段连接的结果。

  • 注意 1:joinPath 仅影响路径组件,所有其他组件(scheme、authority、query 和 fragment)都保持原样。
  • 注意 2:基本 uri 必须具有路径;否则会引发错误。

路径段以下列方式进行规范化

  • 路径分隔符(/\)的序列将替换为单个分隔符
  • 对于 Windows 上的 file-uris,反斜杠字符 (``) 被视为路径分隔符。
  • .. 段表示父段,. 表示当前段。
  • 路径都有一个始终保留的根。例如,在 Windows 上,驱动器盘符是根,所以以下为真:joinPath(Uri.file('file:///c:/root'), '../../other').fsPath === 'c:/other'
参数描述
base: Uri

一个 URI。必须包含路径。

...pathSegments: string[]

一个或多个路径片段

返回描述
Uri

一个新的 URI,其路径与给定的片段连接而成。

从字符串创建一个 URI,例如 http://www.example.com/some/pathfile:///usr/homescheme:with/path

注意,一段时间以来,接受没有 scheme 的 URI。这是不正确的,因为所有 URI 都应该有 scheme。为了避免破坏现有代码,添加了可选的 strict 参数。我们强烈建议使用它,例如 Uri.parse('my:uri', true)

另请参阅 Uri.toString

参数描述
value: string

URI 的字符串值。

strict?: boolean

value 为空或无法解析 scheme 时抛出错误。

返回描述
Uri

新的 Uri 实例。

构造函数

使用 fileparse 工厂函数来创建新的 Uri 对象。

参数描述
scheme: string
authority: string
path: string
query: string
fragment: string
返回描述
Uri

属性

Authority 是 http://www.example.com/some/path?query#fragment 中的 www.example.com 部分。即第一个双斜杠和下一个斜杠之间的部分。

Fragment 是 http://www.example.com/some/path?query#fragment 中的 fragment 部分。

表示此 URI 对应文件系统路径的字符串。

将处理 UNC 路径,并将 Windows 驱动器盘符规范化为小写。还使用特定于平台的路径分隔符。

  • 不会验证路径是否包含无效字符和语义。
  • 不会查看此 URI 的 scheme。
  • 生成的字符串应用于显示,而是用于磁盘操作,如 readFile 等。

path 属性的区别在于使用特定于平台的路径分隔符和处理 UNC 路径。下面的示例概述了差异

const u = URI.parse('file://server/c$/folder/file.txt');
u.authority === 'server';
u.path === '/c$/folder/file.txt';
u.fsPath === '\\serverc$\folder\file.txt';

Path 是 http://www.example.com/some/path?query#fragment 中的 /some/path 部分。

Query 是 http://www.example.com/some/path?query#fragment 中的 query 部分。

Scheme 是 http://www.example.com/some/path?query#fragment 中的 http 部分。即第一个冒号之前的部分。

方法

返回此 URI 的 JSON 表示形式。

参数描述
返回描述
any

一个对象。

返回此 URI 的字符串表示形式。URI 的表示形式和规范化取决于 scheme。

  • 生成的字符串可以安全地与 Uri.parse 一起使用。
  • 生成的字符串应用于显示。

注意,实现将进行激进的编码,这通常会导致意外但并非不正确的结果。例如,冒号被编码为 %3A,这在 file-uri 中可能不符合预期。另外,&= 也将被编码,这对于 http-uri 来说可能不符合预期。出于稳定性原因,这不能再更改。如果您因编码过于激进而感到困扰,则应使用 skipEncoding 参数:uri.toString(true)

参数描述
skipEncoding?: boolean

不进行百分比编码,默认为 false。请注意,路径中出现的 #? 字符将始终被编码。

返回描述
string

此 URI 的字符串表示形式。

从此 URI 派生新的 URI。

let file = Uri.parse('before:some/file/path');
let other = file.with({ scheme: 'after' });
assert.ok(other.toString() === 'after:some/file/path');
参数描述
change: {authority: string, fragment: string, path: string, query: string, scheme: string}

一个描述此 URI 更改的对象。要取消设置组件,请使用 null 或空字符串。

返回描述
Uri

一个反映给定更改的新 URI。如果更改没有改变任何内容,则将返回 this URI。

UriHandler

URI 处理程序负责处理系统范围的 URI

另请参见 window.registerUriHandler

方法

处理提供的系统范围的 Uri

另请参见 window.registerUriHandler

参数描述
uri: Uri
返回描述
ProviderResult<void>

ViewBadge

一个为视图显示值的徽章

属性

在徽章的工具提示中显示的标签。

在徽章中显示的值。

ViewColumn

表示编辑器在窗口中的位置。编辑器可以排列在一个网格中,每一列通过按编辑器出现的顺序计数来表示该网格中的一个编辑器位置。

枚举成员

一个符号化的编辑器列,表示活动列旁边的列。此值可以在打开编辑器时使用,但编辑器的已解析viewColumn 值将始终为 OneTwoThree... 或 undefined,而永远不会是 Beside

一个符号化的编辑器列,表示当前活动列。此值可以在打开编辑器时使用,但编辑器的已解析viewColumn 值将始终为 OneTwoThree... 或 undefined,而永远不会是 Active

第一个编辑器列。

第二个编辑器列。

第三个编辑器列。

第四个编辑器列。

第五个编辑器列。

第六个编辑器列。

第七个编辑器列。

第八个编辑器列。

第九个编辑器列。

Webview

显示 HTML 内容,类似于 iframe。

事件

当 webview 内容发布消息时触发。

Webview 内容可以将字符串或 JSON 可序列化对象发布回扩展。它们不能发布 BlobFileImageData 和其他 DOM 特定对象,因为接收消息的扩展不在浏览器环境中运行。

属性

webview 资源的 内容安全策略源。

这是应在内容安全策略规则中使用的来源。

`img-src https: ${webview.cspSource} ...;`;

webview 的 HTML 内容。

这应该是一个完整且有效的 HTML 文档。更改此属性会导致 webview 重新加载。

Webview 与正常的扩展进程隔离,因此与 webview 的所有通信都必须使用消息传递。要从扩展向 webview 发送消息,请使用 postMessage。要从 webview 发送消息回扩展,请在 webview 中使用 acquireVsCodeApi 函数获取编辑器 API 的句柄,然后调用 .postMessage()

<script>
    const vscode = acquireVsCodeApi(); // acquireVsCodeApi can only be invoked once
    vscode.postMessage({ message: 'hello!' });
</script>

要从 webview 内的工作区加载资源,请使用 asWebviewUri 方法,并确保资源的目录列在 WebviewOptions.localResourceRoots 中。

请记住,即使 webview 被隔离,它们仍然允许运行脚本和加载任意内容,因此扩展在处理 webview 时必须遵循所有标准的 Web 安全最佳实践。这包括正确清理所有不受信任的输入(包括来自工作区的内容)和设置 内容安全策略

webview 的内容设置。

方法

将本地文件系统的 URI 转换为可在 webview 内使用的 URI。

Webview 不能直接使用 file: URI 从工作区或本地文件系统加载资源。asWebviewUri 函数接受本地 file: URI 并将其转换为可在 webview 内用于加载相同资源的 URI。

webview.html = `<img src="${webview.asWebviewUri(
  vscode.Uri.file('/Users/codey/workspace/cat.gif')
)}">`;
参数描述
localResource: Uri
返回描述
Uri

向 webview 内容发布消息。

只有在 webview 处于活动状态(可见或在后台具有 retainContextWhenHidden)时才会传递消息。

参数描述
message: any

消息的主体。这必须是字符串或其他 JSON 可序列化对象。

对于较旧版本的 VS Code,如果 message 中包含 ArrayBuffer,则它将无法正确序列化,并且 webview 将不会收到它。类似地,任何类型数组(如 Uint8Array)的序列化效率都非常低下,并且在 webview 内部也不会被重新创建为类型数组。

但是,如果您的扩展在 package.jsonengines 字段中以 VS Code 1.57+ 为目标,则 message 中出现的任何 ArrayBuffer 值都将更有效地传输到 webview,并且也会在 webview 内部正确重新创建。

返回描述
Thenable<boolean>

当消息发布到 webview 或因为消息无法传递而被丢弃时,会解析的 Promise。

如果消息已发布到 webview,则返回 true。消息只能发布到活动的 webview(即,可见的 webview 或设置了 retainContextWhenHidden 的隐藏 webview)。

返回 true 并不意味着 webview 实际收到了消息。例如,webview 中可能没有挂钩任何消息侦听器,或者 webview 可能在消息发布后但在收到消息之前被销毁。

如果您想确认消息已实际收到,可以尝试让您的 webview 将确认消息发布回您的扩展。

WebviewOptions

webview 的内容设置。

属性

控制是否在 webview 内容中启用命令 URI。

默认为 false(禁用命令 URI)。

如果传入数组,则只允许使用数组中的命令。

控制是否在 webview 内容中启用表单。

如果 启用了脚本,则默认为 true。否则默认为 false。显式地将此属性设置为 true 或 false 会覆盖默认值。

控制是否在 webview 内容中启用脚本。

默认为 false(禁用脚本)。

webview 可以使用来自 asWebviewUri 的 URI 加载本地(文件系统)资源的根路径。

默认为当前工作区的根文件夹以及扩展的安装目录。

传入一个空数组以禁止访问任何本地资源。

webview 中使用的 localhost 端口的映射。

端口映射允许 webview 透明地定义如何解析 localhost 端口。这可以用于允许在 webview 内使用静态 localhost 端口,该端口被解析为服务正在运行的随机端口。

如果 webview 访问 localhost 内容,我们建议您指定端口映射,即使 webviewPortextensionHostPort 端口相同。

请注意,端口映射仅适用于 httphttps URL。WebSocket URL(例如 ws://127.0.0.1:3000)不能映射到另一个端口。

WebviewPanel

一个包含 webview 的面板。

事件

当面板的视图状态更改时触发。

当面板被销毁时触发。

这可能是因为用户关闭了面板,或者因为在其上调用了 .dispose()

在面板被销毁后尝试使用该面板会引发异常。

属性

面板是否处于活动状态(被用户聚焦)。

面板在 UI 中显示的图标。

webview 面板的内容设置。

面板在 UI 中显示的标题。

面板的编辑器位置。仅当 webview 位于编辑器视图列之一时才设置此属性。

标识 webview 面板的类型,例如 'markdown.preview'

面板是否可见。

属于面板的 Webview

方法

销毁 webview 面板。

如果面板正在显示,这将关闭面板,并销毁 webview 拥有的资源。当用户关闭 webview 面板时,也会销毁 webview 面板。两种情况都会触发 onDispose 事件。

参数描述
返回描述
any

在指定的列中显示 webview 面板。

一个 webview 面板一次只能显示在一个列中。如果它已经显示,此方法会将其移动到新列。

参数描述
viewColumn?: ViewColumn

要在其中显示面板的视图列。如果未定义,则在当前的 viewColumn 中显示。

preserveFocus?: boolean

当为 true 时,webview 不会获取焦点。

返回描述
void

WebviewPanelOnDidChangeViewStateEvent

当 webview 面板的视图状态更改时触发的事件。

属性

视图状态已更改的 Webview 面板。

WebviewPanelOptions

webview 面板的内容设置。

属性

控制是否在面板中启用查找小部件。

默认为 false

控制即使面板不再可见,webview 面板的内容 (iframe) 是否保留。

通常,webview 面板的 html 上下文在面板变为可见时创建,并在隐藏时销毁。具有复杂状态或 UI 的扩展可以设置 retainContextWhenHidden,使编辑器保留 webview 上下文,即使 webview 移动到后台选项卡。当使用 retainContextWhenHidden 的 webview 变为隐藏时,其脚本和其他动态内容将暂停。当面板再次变为可见时,上下文将自动恢复到其原始状态。即使启用了 retainContextWhenHidden,您也无法向隐藏的 webview 发送消息。

retainContextWhenHidden 具有较高的内存开销,只有在面板的上下文无法快速保存和恢复时才应使用。

WebviewPanelSerializer<T>

恢复在 vscode 关闭时持久化的 webview 面板。

webview 持久性有两种类型

  • 会话内的持久性。
  • 跨会话的持久性(跨编辑器重启)。

只有在第二种情况下才需要 WebviewPanelSerializer:跨会话持久化 webview。

会话内的持久性允许 webview 在隐藏时保存其状态,并在再次可见时从此状态恢复其内容。它完全由 webview 内容本身驱动。要保存持久状态,请使用任何 JSON 可序列化对象调用 acquireVsCodeApi().setState()。要再次恢复状态,请调用 getState()

// Within the webview
const vscode = acquireVsCodeApi();

// Get existing state
const oldState = vscode.getState() || { value: 0 };

// Update state
setState({ value: oldState.value + 1 });

WebviewPanelSerializer 将此持久性扩展到编辑器重启。当编辑器关闭时,它将保存所有具有序列化器的 webview 的 setState 中的状态。当 webview 在重启后首次变为可见时,此状态将传递给 deserializeWebviewPanel。然后,扩展可以从此状态恢复旧的 WebviewPanel

方法

从其序列化的 state 恢复 webview 面板。

在序列化的 webview 首次变为可见时调用。

参数描述
webviewPanel: WebviewPanel

要恢复的 Webview 面板。序列化器应拥有此面板的所有权。序列化器必须恢复 webview 的 .html 并挂钩所有 webview 事件。

state: T

来自 webview 内容的持久状态。

返回描述
Thenable<void>

表示 webview 已完全恢复的 Thenable。

WebviewPortMapping

定义在 webview 内用于 localhost 的端口映射。

属性

目标端口。webviewPort 将解析为此端口。

要在 webview 内重新映射的 localhost 端口。

WebviewView

基于 webview 的视图。

事件

当视图的可见性更改时触发的事件。

触发可见性更改的操作

  • 视图被折叠或展开。
  • 用户切换到侧边栏或面板中的其他视图组。

请注意,使用上下文菜单隐藏视图反而会处置该视图并触发 onDidDispose

当视图被处置时触发的事件。

当用户显式隐藏视图时(当用户在视图中右键单击并取消选中 webview 视图时会发生这种情况),视图会被处置。

尝试在使用后处置视图会引发异常。

属性

要为此 webview 视图显示的徽章。要删除徽章,请设置为 undefined。

人类可读的字符串,在标题中以不太突出的方式呈现。

在 UI 中显示的视图标题。

视图标题最初取自扩展 package.json 贡献。

标识 webview 视图的类型,例如 'hexEditor.dataView'

跟踪 webview 当前是否可见。

当视图在屏幕上且已展开时,视图是可见的。

视图的基础 webview。

方法

在 UI 中显示视图。

如果视图已折叠,这将展开它。

参数描述
preserveFocus?: boolean

当为 true 时,视图不会获取焦点。

返回描述
void

WebviewViewProvider

用于创建 WebviewView 元素的提供程序。

方法

解析 webview 视图。

当视图首次变为可见时,将调用 resolveWebviewView。当视图首次加载或用户隐藏然后再次显示视图时,可能会发生这种情况。

参数描述
webviewView: WebviewView

要恢复的 Webview 视图。提供程序应拥有此视图的所有权。提供程序必须设置 webview 的 .html 并挂钩所有它感兴趣的 webview 事件。

context: WebviewViewResolveContext<unknown>

有关正在解析的视图的其他元数据。

token: CancellationToken

指示不再需要正在提供的视图的取消令牌。

返回描述
void | Thenable<void>

可选的 thenable,指示视图已完全解析。

WebviewViewResolveContext<T>

正在解析的 webview 视图的其他信息。

属性

来自 webview 内容的持久状态。

为了节省资源,编辑器通常会取消分配不可见的 webview 文档(iframe 内容)。例如,当用户折叠视图或切换到侧边栏中的另一个顶级活动时,WebviewView 本身会保持活动状态,但 webview 的基础文档会被取消分配。当视图再次变为可见时,它会被重新创建。

您可以通过在 WebviewOptions 中设置 retainContextWhenHidden 来防止此行为。但是,这会增加资源使用量,应尽可能避免。相反,您可以使用持久状态来保存 webview 的状态,以便在需要时快速重新创建它。

要保存持久状态,请在 webview 内使用任何 JSON 可序列化对象调用 acquireVsCodeApi().setState()。要再次恢复状态,请调用 getState()。例如

// Within the webview
const vscode = acquireVsCodeApi();

// Get existing state
const oldState = vscode.getState() || { value: 0 };

// Update state
setState({ value: oldState.value + 1 });

编辑器确保在 webview 隐藏时以及在编辑器重启时正确保存持久状态。

WindowState

表示窗口的状态。

属性

最近是否与窗口进行过交互。这将在活动时立即更改,或者在用户不活动一小段时间后更改。

当前窗口是否已聚焦。

WorkspaceConfiguration

表示配置。它是以下项的合并视图

  • 默认设置
  • 全局(用户)设置
  • 工作区设置
  • 工作区文件夹设置 - 来自请求资源所属的工作区文件夹之一。
  • 语言设置 - 在请求的语言下定义的设置。

有效值(由get返回)是通过按照以下顺序覆盖或合并值来计算的:

  1. defaultValue(如果在package.json中定义,否则从值的类型派生)
  2. globalValue(如果已定义)
  3. workspaceValue(如果已定义)
  4. workspaceFolderValue(如果已定义)
  5. defaultLanguageValue(如果已定义)
  6. globalLanguageValue(如果已定义)
  7. workspaceLanguageValue(如果已定义)
  8. workspaceFolderLanguageValue(如果已定义)

注意: 仅合并 object 值类型,所有其他值类型都被覆盖。

示例 1:覆盖

defaultValue = 'on';
globalValue = 'relative';
workspaceFolderValue = 'off';
value = 'off';

示例 2:语言值

defaultValue = 'on';
globalValue = 'relative';
workspaceFolderValue = 'off';
globalLanguageValue = 'on';
value = 'on';

示例 3:对象值

defaultValue = { a: 1, b: 2 };
globalValue = { b: 3, c: 4 };
value = { a: 1, b: 3, c: 4 };

注意: 工作区和工作区文件夹配置包含 launchtasks 设置。它们的基本名称将成为节标识符的一部分。以下代码片段展示了如何从 launch.json 中检索所有配置

// launch.json configuration
const config = workspace.getConfiguration(
  'launch',
  vscode.workspace.workspaceFolders[0].uri
);

// retrieve values
const values = config.get('configurations');

有关更多信息,请参阅 设置

方法

从该配置返回一个值。

参数描述
section: string

配置名称,支持点号名称。

返回描述
T

section 表示 或 undefined

从该配置返回一个值。

参数描述
section: string

配置名称,支持点号名称。

defaultValue: T

当找不到值时,应返回一个值,该值为 undefined

返回描述
T

section 表示 或默认值。

检查此配置是否具有特定值。

参数描述
section: string

配置名称,支持点号名称。

返回描述
布尔值

如果该节未解析为 undefined,则为 true

检索有关配置设置的所有信息。配置值通常由默认值、全局或安装范围值、工作区特定值、文件夹特定值和语言特定值(如果WorkspaceConfiguration的作用域是某种语言)组成。

还提供了定义给定配置设置的所有语言 ID。

注意: 配置名称必须表示配置树中的叶子(editor.fontSize vs editor),否则不会返回任何结果。

参数描述
section: string

配置名称,支持点号名称。

返回描述
{defaultLanguageValue: T, defaultValue: T, globalLanguageValue: T, globalValue: T, key: string, languageIds: string[], workspaceFolderLanguageValue: T, workspaceFolderValue: T, workspaceLanguageValue: T, workspaceValue: T}

有关配置设置的信息,如果不存在则为 undefined

更新配置值。更新后的配置值将被持久化。

可以在以下位置更改值

注意: 要删除配置值,请使用 undefined,例如: config.update('somekey', undefined)

  • 抛出 - 更新时出错
    • 未注册的配置。
    • 窗口配置到工作区文件夹
    • 当没有打开工作区时配置到工作区或工作区文件夹。
    • 当没有工作区文件夹设置时配置到工作区文件夹。
    • WorkspaceConfiguration的作用域不是特定资源时配置到工作区文件夹。
参数描述
section: string

配置名称,支持点号名称。

value: any

新值。

configurationTarget?: boolean | ConfigurationTarget

配置目标或布尔值。- 如果为 true,则更新全局设置。- 如果为 false,则更新工作区设置。- 如果为 undefinednull,则如果配置是资源特定的,则更新到工作区文件夹设置,否则更新到工作区设置

overrideInLanguage?: boolean

是否在请求的 languageId 的范围内更新值。- 如果为 true,则在请求的 languageId 下更新该值。- 如果为 undefined,则仅当为该语言定义了配置时,才在请求的 languageId 下更新该值。

返回描述
Thenable<void>

WorkspaceEdit

工作区编辑是多个资源和文档的文本和文件更改的集合。

使用 applyEdit 函数来应用工作区编辑。

构造函数

参数描述
返回描述
WorkspaceEdit

属性

受文本或资源更改影响的资源数量。

方法

创建一个常规文件。

参数描述
uri: Uri

新文件的 URI。

options?: {contents: Uint8Array | DataTransferFile, ignoreIfExists: boolean, overwrite: boolean}

定义是否应覆盖或忽略现有文件。当同时设置 overwriteignoreIfExists 时,overwrite 优先。当两者都未设置并且该文件已存在时,则无法成功应用编辑。content 属性允许设置创建文件时的初始内容。

metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

删除给定范围的文本。

参数描述
uri: Uri

资源标识符。

range: Range

一个范围。

metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

删除文件或文件夹。

参数描述
uri: Uri

要删除的文件的 URI。

options?: {ignoreIfNotExists: boolean, recursive: boolean}
metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

获取按资源分组的所有文本编辑。

参数描述
返回描述
Array<[Uri, TextEdit[]]>

[Uri, TextEdit[]] 元组的浅拷贝。

获取资源的文本编辑。

参数描述
uri: Uri

资源标识符。

返回描述
TextEdit[]

文本编辑数组。

检查是否存在针对资源的文本编辑。

参数描述
uri: Uri

资源标识符。

返回描述
布尔值

如果给定资源将受此编辑影响,则返回 true

在给定位置插入给定文本。

参数描述
uri: Uri

资源标识符。

position: Position

一个位置。

newText: string

一个字符串。

metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

重命名文件或文件夹。

参数描述
oldUri: Uri

现有文件。

newUri: Uri

新的位置。

options?: {ignoreIfExists: boolean, overwrite: boolean}

定义是否应覆盖或忽略现有文件。当 overwrite 和 ignoreIfExists 都设置时,overwrite 优先。

metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

用给定文本替换给定资源的给定范围。

参数描述
uri: Uri

资源标识符。

range: Range

一个范围。

newText: string

一个字符串。

metadata?: WorkspaceEditEntryMetadata

该条目的可选元数据。

返回描述
void

为资源设置(并替换)文本编辑或代码片段编辑。

参数描述
uri: Uri

资源标识符。

edits: ReadonlyArray<TextEdit | SnippetTextEdit>

编辑数组。

返回描述
void

为资源设置(并替换)带有元数据的文本编辑或代码片段编辑。

参数描述
uri: Uri

资源标识符。

edits: ReadonlyArray<[TextEdit | SnippetTextEdit, WorkspaceEditEntryMetadata]>

编辑数组。

返回描述
void

为资源设置(并替换)笔记本编辑。

参数描述
uri: Uri

资源标识符。

edits: readonly NotebookEdit[]

编辑数组。

返回描述
void

为资源设置(并替换)带有元数据的笔记本编辑。

参数描述
uri: Uri

资源标识符。

edits: ReadonlyArray<[NotebookEdit, WorkspaceEditEntryMetadata]>

编辑数组。

返回描述
void

WorkspaceEditEntryMetadata

工作区编辑条目的附加数据。支持标记条目,并将条目标记为需要用户确认。编辑器将标签相同的编辑分组到树节点中,例如,所有标记为“字符串中的更改”的编辑将是一个树节点。

属性

一个人类可读的字符串,在同一行上以不太突出的方式呈现。

编辑的图标路径或 ThemeIcon

一个人类可读的字符串,以突出的方式呈现。

一个指示需要用户确认的标志。

WorkspaceEditMetadata

有关工作区编辑的其他数据。

属性

向编辑器发出此编辑是重构的信号。

WorkspaceFolder

工作区文件夹是编辑器打开的潜在多个根目录之一。所有工作区文件夹都是相等的,这意味着没有活动或主工作区文件夹的概念。

属性

此工作区文件夹的序号。

此工作区文件夹的名称。默认为其 uri-path 的基本名称

此工作区文件夹的关联 URI。

注意: 有意选择 Uri 类型,以便编辑器的未来版本可以支持未存储在本地磁盘上的工作区文件夹,例如 ftp://server/workspaces/foo

WorkspaceFolderPickOptions

配置 工作区文件夹 选择 UI 的行为的选项。

属性

设置为 true 可在焦点移动到编辑器的其他部分或另一个窗口时保持选择器打开。此设置在 iPad 上被忽略,并且始终为 false。

一个可选字符串,在输入框中显示为占位符,以指导用户选择内容。

WorkspaceFoldersChangeEvent

描述 工作区文件夹 集合更改的事件。

属性

添加的工作区文件夹。

删除的工作区文件夹。

WorkspaceSymbolProvider<T>

工作区符号提供程序接口定义了扩展与 符号搜索 功能之间的约定。

方法

在整个项目中搜索与给定查询字符串匹配的符号。

query 参数应以宽松的方式解释,因为编辑器将在结果上应用其自己的高亮显示和评分。一个好的经验法则是进行不区分大小写的匹配,并且只需检查query 的字符是否按其顺序出现在候选符号中。请勿使用前缀、子字符串或类似的严格匹配。

为了提高性能,实现者可以实现 resolveWorkspaceSymbol,然后提供带有部分 location 对象(未定义 range)的符号。然后,编辑器将仅对选定的符号调用 resolveWorkspaceSymbol,例如在打开工作区符号时。

参数描述
query: string

查询字符串,可以为空字符串,在这种情况下,应返回所有符号。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T[]>

文档高亮的数组或解析为此的 thenable。缺少结果可以通过返回 undefinednull 或空数组来表示。

给定一个符号,填写其 location。每当在 UI 中选择符号时,都会调用此方法。提供程序可以实现此方法并从 provideWorkspaceSymbols 返回不完整的符号,这通常有助于提高性能。

参数描述
symbol: T

要解析的符号。保证是先前调用 provideWorkspaceSymbols 返回的对象的实例。

token: CancellationToken

取消令牌。

返回描述
ProviderResult<T>

解析的符号或解析为该符号的 thenable。当未返回结果时,将使用给定的 symbol

API 模式

以下是我们在 VS Code API 中使用的一些常见模式。

Promise

VS Code API 使用 Promise 表示异步操作。 从扩展程序中,可以返回任何类型的 Promise,例如 ES6、WinJS、A+ 等。

API 中使用 Thenable 类型来表达与特定 Promise 库的独立性。Thenable 代表着共同的特征,即 then 方法。

在大多数情况下,Promise 的使用是可选的。当 VS Code 调用扩展时,它可以处理结果类型以及结果类型Thenable。当 Promise 的使用是可选的时候,API 会通过返回 or 类型来表明这一点。

provideNumber(): number | Thenable<number>

取消令牌

通常,操作会在易变的状态下启动,这些状态会在操作完成之前发生更改。例如,IntelliSense 的计算会开始,而用户继续输入,导致该操作的结果过时。

暴露给这种行为的 API 将会传递一个 CancellationToken,您可以在该令牌上检查是否已取消 (isCancellationRequested) 或者在取消发生时收到通知 (onCancellationRequested)。取消令牌通常是函数调用的最后一个参数,并且是可选的。

可释放对象

VS Code API 对从 VS Code 获取的资源使用 dispose 模式。这适用于事件监听、命令、与 UI 交互以及各种语言贡献。

例如,setStatusBarMessage(value: string) 函数返回一个 Disposable,调用 dispose 会再次移除消息。

事件

VS Code API 中的事件公开为函数,您可以调用该函数并使用监听器函数来订阅。订阅的调用会返回一个 Disposable,在 dispose 时会移除事件监听器。

var listener = function(event) {
  console.log('It happened', event);
};

// start listening
var subscription = fsWatcher.onDidDelete(listener);

// do more stuff

subscription.dispose(); // stop listening

事件的名称遵循 on[Will|Did]VerbNoun? 模式。该名称会表明事件是即将发生(onWill)还是已经发生(onDid),发生了什么(verb),以及上下文(noun),除非上下文很明显。

VS Code API 中的一个例子是 window.onDidChangeActiveTextEditor,这是一个在活动文本编辑器(noun)被 (onDid) 更改 (verb) 时触发的事件。

严格的 null

VS Code API 在适当的地方使用 undefinednull TypeScript 类型来支持 严格的 null 检查