现已发布!阅读有关十月份新功能和修复的内容。

VS Code API

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

API 命名空间和类

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

认证

用于身份验证的命名空间。

事件

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

函数

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

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

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

参数描述
providerId: string

要使用的提供程序的 id

返回描述
Thenable<readonly AuthenticationSessionAccountInformation[]>

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

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

内置的身份验证提供程序包括

  • 'github' - 用于 GitHub.com
  • 'microsoft' - 用于个人和组织 Microsoft 账户
  • (不常用)'github-enterprise' - 用于其他 GitHub 托管,GHE.com,GitHub Enterprise Server
  • (不常用)'microsoft-sovereign-cloud' - 用于其他 Microsoft 云
参数描述
providerId: string

要使用的提供程序的 id

scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest

请求的权限作用域列表或 WWW-Authenticate 请求。这些依赖于身份验证提供程序。

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

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

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

内置的身份验证提供程序包括

  • 'github' - 用于 GitHub.com
  • 'microsoft' - 用于个人和组织 Microsoft 账户
  • (不常用)'github-enterprise' - 用于其他 GitHub 托管,GHE.com,GitHub Enterprise Server
  • (不常用)'microsoft-sovereign-cloud' - 用于其他 Microsoft 云
参数描述
providerId: string

要使用的提供程序的 id

scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest

请求的权限作用域列表或 WWW-Authenticate 请求。这些依赖于身份验证提供程序。

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

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

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

内置的身份验证提供程序包括

  • 'github' - 用于 GitHub.com
  • 'microsoft' - 用于个人和组织 Microsoft 账户
  • (不常用)'github-enterprise' - 用于其他 GitHub 托管,GHE.com,GitHub Enterprise Server
  • (不常用)'microsoft-sovereign-cloud' - 用于其他 Microsoft 云
参数描述
providerId: string

要使用的提供程序的 id

scopeListOrRequest: readonly string[] | AuthenticationWwwAuthenticateRequest

请求的权限作用域列表或 WWW-Authenticate 请求。这些依赖于身份验证提供程序。

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

一个 thenable,解析为一个身份验证会话,如果使用静默流程且未找到会话,则为 undefined

注册一个身份验证提供程序。

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

参数描述
id: string

提供程序的唯一标识符。

label: string

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

provider: AuthenticationProvider

身份验证提供程序。

options?: AuthenticationProviderOptions

提供程序的附加选项。

返回描述
Disposable

一个 Disposable,在被处置时注销此提供程序。

chat

用于聊天功能的命名空间。用户通过在聊天视图中向聊天参与者发送消息来与他们互动。聊天参与者可以通过 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[]>

解析为命令 id 列表的 thenable。

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

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

参数描述
command: string

命令的唯一标识符。

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

一个命令处理函数。

thisArg?: any

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

返回描述
Disposable

在处置时注销此命令的 Disposable。

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

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

参数描述
command: string

命令的唯一标识符。

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

一个可以访问 编辑器edit 的命令处理函数。

thisArg?: any

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

返回描述
Disposable

在处置时注销此命令的 Disposable。

comments

函数

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

参数描述
id: string

注释控制器的 id

label: string

注释控制器的人类可读字符串。

返回描述
CommentController

一个 注释控制器 实例。

debug

用于调试功能的命名空间。

变量

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

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

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

断点列表。

事件

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

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

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

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

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

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

函数

添加断点。

参数描述
breakpoints: readonly Breakpoint[]

要添加的断点。

返回描述
void

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

如果“源”描述符的信息不足以创建 Uri,则会抛出错误。

参数描述
source: DebugProtocolSource
session?: DebugSession

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

返回描述
Uri

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

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

参数描述
debugType: string

工厂注册的调试类型。

factory: DebugAdapterDescriptorFactory
返回描述
Disposable

一个在被处置时注销此工厂的 Disposable

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

参数描述
debugType: string

工厂注册的调试类型,或“*”以匹配所有调试类型。

factory: DebugAdapterTrackerFactory
返回描述
Disposable

一个在被处置时注销此工厂的 Disposable

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

参数描述
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>

当调试可以成功启动时解析的 thenable。

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

参数描述
session?: DebugSession

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

返回描述
Thenable<void>

当会话已停止时解析的 thenable。

env

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

变量

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

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

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

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

系统剪贴板。

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

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

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

编辑器的当前日志级别。

计算机的唯一标识符。

远程的名称。由扩展定义,常见的例子是用于 Windows Subsystem for Linux 的 wsl 或用于使用安全 shell 的远程的 ssh-remote

注意,当没有远程扩展主机时,该值为 undefined,但在存在远程扩展主机的情况下,在所有扩展主机(本地和远程)中都会定义该值。使用 Extension.extensionKind 来了解特定扩展是否在远程运行。

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

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

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

编辑器在操作系统中注册的自定义 uri 协议。

事件

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

当默认 shell 更改时触发的 事件。此事件将附带新的 shell 路径。

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

函数

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

http:https: 协议

将扩展运行位置的外部 uri(例如 http:https: 链接)解析为客户端计算机上相同资源的 uri。

如果扩展在客户端计算机上运行,则此操作为空操作。

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

注意,通过 openExternal 传递的 uri 会自动解析,您不应对它们调用 asExternalUri

vscode.env.uriScheme

创建一个 uri,如果在浏览器中打开(例如通过 openExternal),将导致注册的 UriHandler 触发。

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

注意,如果服务器决定向 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 时将使编辑器打开工作区。

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

一个可以在客户端计算机上使用的 uri。

创建一个新的 遥测记录器

参数描述
sender: TelemetrySender

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

options?: TelemetryLoggerOptions

遥测记录器的选项。

返回描述
TelemetryLogger

一个新的遥测记录器

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

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

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

参数描述
target: Uri

应该打开的 uri。

返回描述
Thenable<boolean>

一个表示打开是否成功的 promise。

extensions

用于处理已安装扩展的命名空间。扩展由一个 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 时,在 package.json 中添加一个 extensionDependencies 条目,并使用 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

l10n

扩展 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>

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

返回描述
字符串

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

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

示例

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

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

args: Record<string, any>

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

返回描述
字符串

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

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

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

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

返回描述
字符串

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

语言

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

存在许多编程语言,它们在语法、语义和范式上差异巨大。尽管如此,像自动单词补全、代码导航或代码检查等功能在不同编程语言的不同工具中已变得普遍。

编辑器提供了一个 API,通过将所有 UI 和操作都已准备就绪,并允许您仅通过提供数据来参与,从而简化了提供此类常见功能的过程。例如,要贡献一个悬停提示,您只需提供一个可以被调用并带有 TextDocumentPosition 的函数,并返回悬停信息。其余部分,如跟踪鼠标、定位悬停、保持悬停稳定等,都由编辑器负责。

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

注册是通过一个 文档选择器 完成的,它要么是一个语言 id,如 javascript,要么是一个更复杂的过滤器,如 { language: 'typescript', scheme: 'file' }。将文档与这样的选择器匹配将产生一个 分数,用于确定是否以及如何使用提供程序。当分数相同时,后注册的提供程序获胜。对于允许完整数量的功能,如 悬停,分数仅检查是否 >0,对于其他功能,如 智能感知,分数用于确定提供程序被要求参与的顺序。

事件

当全局诊断集更改时触发的 事件。这是新增和移除的诊断。

函数

创建一个诊断集合。

参数描述
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,在被处置时注销此提供程序。

注册一个 code lens 提供程序。

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

参数描述
selector: DocumentSelector

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

provider: CodeLensProvider<CodeLens>

一个 code lens 提供程序。

返回描述
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

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

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

参数描述
selector: DocumentSelector

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

provider: DocumentDropEditProvider<DocumentDropEdit>

一个放置提供程序。

metadata?: DocumentDropEditProviderMetadata

关于提供程序的附加元数据。

返回描述
Disposable

一个可释放对象,在被释放时注销此提供程序。

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

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

参数描述
selector: DocumentSelector

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

provider: DocumentFormattingEditProvider

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

返回描述
Disposable

一个 Disposable,在被处置时注销此提供程序。

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

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

参数描述
selector: DocumentSelector

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

provider: DocumentHighlightProvider

一个文档高亮提供程序。

返回描述
Disposable

一个 Disposable,在被处置时注销此提供程序。

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

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

参数描述
selector: DocumentSelector

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

provider: DocumentLinkProvider<DocumentLink>

一个文档链接提供程序。

返回描述
Disposable

一个 Disposable,在被处置时注销此提供程序。

注册一个新的DocumentPasteEditProvider

可以为一种语言注册多个提供程序。该语言的所有已注册提供程序将根据其在DocumentPasteProviderMetadata中指定的已处理的mimetype被调用以进行复制和粘贴操作。

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

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

参数描述
selector: DocumentSelector

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

provider: DocumentPasteEditProvider<DocumentPasteEdit>

一个粘贴编辑器提供程序。

metadata: DocumentPasteProviderMetadata

关于提供程序的附加元数据。

返回描述
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

一个可释放对象,用于取消此配置。

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

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

参数描述
document: TextDocument

要更改语言的文档

languageId: string

新的语言标识符。

返回描述
Thenable<TextDocument>

一个 thenable,解析为更新后的文档。

lm

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

变量

所有扩展使用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>

工具调用的结果。

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

参数描述
vendor: string

此提供程序的供应商。必须全局唯一。例如copilotopenai

provider: LanguageModelChatProvider<LanguageModelChatInformation>

要注册的提供程序

返回描述
Disposable

一个可释放对象,在释放时注销提供程序。

注册一个为编辑器提供模型上下文协议(MCP)服务器的提供程序。这允许动态地向编辑器提供MCP服务器,此外还有用户在配置文件中创建的服务器。

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

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

当有新的McpServerDefinitionProvider可用时,编辑器默认会在提交聊天消息时自动调用它来发现新的服务器和工具。要启用此流程,扩展应在激活期间调用registerMcpServerDefinitionProvider

参数描述
id: string

提供程序的ID,对于扩展是唯一的。

provider: McpServerDefinitionProvider<McpServerDefinition>

要注册的提供程序

返回描述
Disposable

一个可释放对象,在释放时注销提供程序。

注册一个LanguageModelTool。该工具也必须在package.json的languageModelTools贡献点中注册。注册的工具在lm.tools列表中对任何扩展都可见。但为了让语言模型看到它,它必须在LanguageModelChatRequestOptions.tools的可用工具列表中传递。

参数描述
name: string
tool: LanguageModelTool<T>
返回描述
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[]>

一个聊天模型数组,可能为空!

notebooks

笔记本的命名空间。

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

  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,在被处置时注销此提供程序。

scm

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

变量

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

  • 已弃用 - 请改用 SourceControl.inputBox

函数

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

参数描述
id: string

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

label: string

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

rootUri?: Uri

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

返回描述
SourceControl

一个源代码控制的实例。

tasks

任务功能的命名空间。

变量

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

事件

当任务结束时触发。

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

当任务开始时触发。

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

函数

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

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

要执行的任务

返回描述
Thenable<TaskExecution>

一个解析为任务执行的 thenable。

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

参数描述
filter?: TaskFilter

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

返回描述
Thenable<Task[]>

一个解析为任务数组的 thenable。

注册一个任务提供程序。

参数描述
type: string

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

provider: TaskProvider<Task>

一个任务提供程序。

返回描述
Disposable

一个 Disposable,在被处置时注销此提供程序。

tests

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

函数

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

参数描述
id: string

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

label: string

控制器的人类可读标签。

返回描述
TestController

一个TestController的实例。

window

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

变量

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

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

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

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

表示当前窗口的状态。

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

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

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

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

事件

一个事件,当活动颜色主题被更改或有更改时触发。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

一个事件,当终端被释放时触发。

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

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

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

函数

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

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

参数描述
返回描述
InputBox

一个新的输入框

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

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

参数描述
name: string

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

languageId?: string

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

返回描述
OutputChannel

一个新的输出通道。

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

参数描述
name: string

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

options: {log: true}

日志输出通道的选项。

返回描述
LogOutputChannel

一个新的日志输出通道。

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

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

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

一个新的快速选择

创建一个状态栏项目

参数描述
id: string

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

alignment?: StatusBarAlignment

项目的对齐方式。

priority?: number

项目的优先级。值越高,项目应显示得越靠左。

返回描述
StatusBarItem

一个新的状态栏项目。

创建一个状态栏项目

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

参数描述
alignment?: StatusBarAlignment

项目的对齐方式。

priority?: number

项目的优先级。值越高,项目应显示得越靠左。

返回描述
StatusBarItem

一个新的状态栏项目。

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

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

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

shellPath?: string

可选的自定义shell可执行文件路径,用于在终端中使用。

shellArgs?: string | readonly string[]

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

返回描述
终端

一个新的终端。

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

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

一个描述新终端特性的TerminalOptions对象。

返回描述
终端

一个新的终端。

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

参数描述
options: ExtensionTerminalOptions

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

返回描述
终端

一个新的终端。

创建一个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-scheme 必须是 vscode.env.uriScheme
  • uri-authority 必须是扩展 ID(例如 my.extension);
  • uri-path、-query 和 -fragment 部分是任意的。

例如,如果 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

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

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

参数描述
text: string

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

hideAfterTimeout: number

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

返回描述
Disposable

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

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

参数描述
text: string

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

hideWhenDone: Thenable<any>

当其完成(解决或拒绝)时,消息将被释放的 Thenable 对象。

返回描述
Disposable

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

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

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

参数描述
text: string

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

返回描述
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

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

参数描述
document: NotebookDocument

要显示的文本文档。

options?: NotebookDocumentShowOptions

用于配置显示 笔记本编辑器 行为的 编辑器选项

返回描述
Thenable<NotebookEditor>

一个解析为 笔记本编辑器 的 promise。

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

参数描述
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>

一个 promise,它解析为工作区文件夹或 undefined

在编辑器中显示进度。进度会在执行给定的回调函数时以及其返回的 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 对象。

workspace

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

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

有关工作区概念的更多信息,请参阅 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

事件

配置 发生变化时触发的事件。

笔记本 发生变化时触发的事件。

文本文档 发生变化时触发的事件。这通常发生在 内容 变化时,但也可能在其他情况,如 dirty 状态变化时发生。

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

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

返回描述
字符串

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

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

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

可以通过提供一个带有 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

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

Uint8Array 的内容解码为 string。您必须一次性提供全部内容,以确保编码能正确应用。不要使用此方法分块解码内容,因为这可能导致不正确的结果。

将根据设置和缓冲区内容(例如字节顺序标记)选择编码。

注意,如果您解码的内容不受编码支持,结果可能会包含适当的替换字符。

  • 抛出 - 当内容为二进制时,此方法将抛出错误。
参数描述
content: Uint8Array

要解码的文本内容,形式为 Uint8Array

返回描述
Thenable<string>

一个解析为解码后的 string 的 thenable 对象。

使用提供的编码将 Uint8Array 的内容解码为 string。您必须一次性提供全部内容,以确保编码能正确应用。不要使用此方法分块解码内容,因为这可能导致不正确的结果。

注意,如果您解码的内容不受编码支持,结果可能会包含适当的替换字符。

  • 抛出 - 当内容为二进制时,此方法将抛出错误。
参数描述
content: Uint8Array

要解码的文本内容,形式为 Uint8Array

options: {encoding: string}

选择编码的附加上下文。

返回描述
Thenable<string>

一个解析为解码后的 string 的 thenable 对象。

Uint8Array 的内容解码为 string。您必须一次性提供全部内容,以确保编码能正确应用。不要使用此方法分块解码内容,因为这可能导致不正确的结果。

编码是根据设置和缓冲区内容(例如字节顺序标记)选择的。

注意,如果您解码的内容不受编码支持,结果可能会包含适当的替换字符。

  • 抛出 - 当内容为二进制时,此方法将抛出错误。
参数描述
content: Uint8Array

要解码的内容,形式为 Uint8Array

options: {uri: Uri}

选择编码的附加上下文。

返回描述
Thenable<string>

一个解析为解码后的 string 的 thenable 对象。

string 的内容编码为 Uint8Array

将根据设置选择编码。

参数描述
content: string

要解码的内容,形式为 string

返回描述
Thenable<Uint8Array>

一个解析为编码后的 Uint8Array 的 thenable 对象。

使用提供的编码将 string 的内容编码为 Uint8Array

参数描述
content: string

要解码的内容,形式为 string

options: {encoding: string}

选择编码的附加上下文。

返回描述
Thenable<Uint8Array>

一个解析为编码后的 Uint8Array 的 thenable 对象。

string 的内容编码为 Uint8Array

编码是根据设置选择的。

参数描述
content: string

要解码的内容,形式为 string

options: {uri: Uri}

选择编码的附加上下文。

返回描述
Thenable<Uint8Array>

一个解析为编码后的 Uint8Array 的 thenable 对象。

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

示例

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 对象。如果没有打开 工作区文件夹,将返回无结果。

获取一个工作区配置对象。

如果提供了一个 section-identifier,则只返回该部分的配置。section-identifier 中的点被解释为子访问,例如 { myExt: { setting: { doIt: true }}}getConfiguration('myExt.setting').get('doIt') === true

如果提供了一个 scope,则返回仅限于该范围的配置。Scope 可以是资源、语言标识符或两者兼有。

参数描述
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

标识要打开的资源。

options?: {encoding: string}
返回描述
Thenable<TextDocument>

一个解析为 文档 的 promise。

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

另请参阅 workspace.openTextDocument

参数描述
path: string

磁盘上文件的路径。

options?: {encoding: string}
返回描述
Thenable<TextDocument>

一个解析为 文档 的 promise。

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

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

用于控制文档创建方式的选项。

返回描述
Thenable<TextDocument>

一个解析为 文档 的 promise。

为给定的协议注册一个文件系统提供程序,例如 ftp

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

参数描述
scheme: string

提供程序注册的 uri-scheme

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 只能注册一个提供程序。

参数描述
scheme: string

要注册的 uri-scheme。

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: ...});

删除一个现有的工作区文件夹并以不同的名称重新添加它是有效的,可以用于重命名该文件夹。

注意:onDidChangeWorkspaceFolders() 触发之前多次调用 updateWorkspaceFolders() 是无效的。

参数描述
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

AuthenticationGetSessionPresentationOptions

在使用交互式选项 forceNewSessioncreateIfNone 调用 authentication.getSession 时要使用的可选选项。

属性

当我们要求用户重新进行身份验证时,将向用户显示的可选消息。提供有关您为什么要求用户重新进行身份验证的额外上下文,有助于增加他们接受的可能性。

AuthenticationProvider

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

事件

当会话数组发生变化,或会话内的数据发生变化时触发的 Event

方法

提示用户登录。

如果登录成功,应触发 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

一个 Event,当 AuthenticationSession 被添加、删除或更改时触发。

属性

AuthenticationProvider 中已更改的 AuthenticationSessions。当会话的数据(不包括 id)被更新时,会话会发生更改。例如,会话刷新导致为会话设置了新的访问令牌。

AuthenticationProviderInformation

关于 AuthenticationProvider 的基本信息

属性

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

身份验证提供程序的人类可读名称。

AuthenticationProviderOptions

创建 AuthenticationProvider 的选项。

属性

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

AuthenticationProviderSessionOptions

属性

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

AuthenticationSession

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

属性

访问令牌。此令牌应用于向服务发出请求时进行身份验证。由 OAuth 推广。

与会话关联的帐户。

身份验证会话的标识符。

ID 令牌。此令牌包含有关用户的身份信息。由 OpenID Connect 推广。

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

AuthenticationSessionAccountInformation

AuthenticationSession 关联的帐户信息。

属性

帐户的唯一标识符。

帐户的人类可读名称。

AuthenticationSessionsChangeEvent

一个 Event,当 AuthenticationSession 被添加、删除或更改时触发。

属性

会话已更改的 AuthenticationProvider

AuthenticationWwwAuthenticateRequest

表示基于 WWW-Authenticate 标头值创建会话的参数。当 API 返回 401 并带有 WWW-Authenticate 标头,指示需要额外身份验证时使用。详细信息将传递给身份验证提供程序以创建会话。

  • 注意 - 授权提供程序必须支持处理质询,特别是此 WWW-Authenticate 值中的质询。

属性

如果在 WWW-Authenticate 标头中未找到范围,则使用的备用范围。

触发此质询的原始 WWW-Authenticate 标头值。身份验证提供程序将解析此值以提取必要的质询信息。

AutoClosingPair

描述字符串对,其中输入起始字符串时将自动插入结束字符串。

属性

输入起始字符串时将自动插入的结束字符串。

一组不应自动闭合该配对的标记。

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

BranchCoverage

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

构造函数

参数描述
executed: number | boolean

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

location?: Range | Position

分支位置。

label?: string
返回描述
分支覆盖率

属性

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

分支的标签,用于“未执行 ${label} 分支”之类的上下文中。

分支位置。

Breakpoint

所有断点类型的基类。

构造函数

创建一个新断点

参数描述
enabled?: boolean

断点是否已启用。

condition?: string

条件断点的表达式。

hitCondition?: string

控制断点被忽略多少次的表达式。

logMessage?: string

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

返回描述
断点

属性

条件断点的可选表达式。

断点是否已启用。

一个可选的表达式,用于控制断点被忽略的次数。

断点的唯一 ID。

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

BreakpointsChangeEvent

描述断点集变化的事件。

属性

已添加的断点。

已更改的断点。

已移除的断点。

CallHierarchyIncomingCall

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

构造函数

创建一个新的调用对象。

参数描述
item: CallHierarchyItem

进行调用的项。

fromRanges: Range[]

调用出现的范围。

返回描述
调用层次结构传入调用

属性

进行调用的项。

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

CallHierarchyItem

在调用层次结构上下文中表示编程构造,如函数或构造函数。

构造函数

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

参数描述
kind: SymbolKind
name: string
detail: string
uri: Uri
range: Range
selectionRange: Range
返回描述
调用层次结构项

属性

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

此项的类型。

此项的名称。

包围此符号的范围,不包括前导/尾随空格,但包括其他所有内容,例如注释和代码。

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

此项的标签。

此项的资源标识符。

CallHierarchyOutgoingCall

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

构造函数

创建一个新的调用对象。

参数描述
item: CallHierarchyItem

被调用的项

fromRanges: Range[]

调用出现的范围。

返回描述
调用层次传出调用

属性

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

被调用的项。

CallHierarchyProvider

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

方法

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

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

一个取消令牌。

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

一个或多个调用层次结构项,或解析为此类项的 thenable。可以通过返回 undefinednull 或空数组来表示没有结果。

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

参数描述
item: CallHierarchyItem

应为其计算传入调用的层次结构项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<CallHierarchyIncomingCall[]>

一组传入调用或解析为此类调用的 thenable。可以通过返回 `undefined` 或 `null` 来表示没有结果。

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

参数描述
item: CallHierarchyItem

应为其计算传出调用的层次结构项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<CallHierarchyOutgoingCall[]>

一组传出调用或解析为此类调用的 thenable。可以通过返回 `undefined` 或 `null` 来表示没有结果。

CancellationError

一个错误类型,应用于表示操作的取消。

此类型可用于响应 cancellation token 被取消,或当操作被该操作的执行者取消时。

构造函数

创建一个新的取消错误。

参数描述
返回描述
取消错误

CancellationToken

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

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

属性

当令牌被取消时为 `true`,否则为 `false`。

一个 Event,在取消时触发。

CancellationTokenSource

取消源创建并控制一个 cancellation token

构造函数

参数描述
返回描述
取消令牌源

属性

此源的取消令牌。

方法

在令牌上发出取消信号。

参数描述
返回描述
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 command](#_ChatCommand command) 的名称。

这是当前在 UI 中选择的模型。扩展可以使用此模型,或使用 lm.selectChatModels 选择另一个模型。不要在请求的生命周期之外持有此模型。

用户输入的提示。

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

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

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

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

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

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

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

ChatRequestHandler

ChatRequestTurn

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

属性

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

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

用户输入的提示。

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

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

此消息中使用的引用。

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

ChatResponseAnchorPart

代表聊天响应中作为锚点的部分,渲染为指向目标的链接。

构造函数

创建一个新的 ChatResponseAnchorPart。

参数描述
value: Uri | Location

一个 uri 或 location。

title?: string

与 value 一起渲染的可选标题。

返回描述
ChatResponseAnchorPart

属性

与 value 一起渲染的可选标题。

此锚点的目标。

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 或 location。

title?: string

与 value 一起渲染的可选标题。

返回描述
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 中。

此代码操作执行的 workspace edit

将此操作标记为首选操作。首选操作用于 `自动修复` 命令,并且可以通过键盘绑定进行定位。

如果一个快速修复能够正确解决底层错误,则应将其标记为首选。如果一个重构是可采取的最合理的操作选择,则应将其标记为首选。

代码操作的类型

用于过滤代码操作。

此代码操作的简短、人类可读的标题。

CodeActionContext

包含有关运行代码操作的上下文的附加诊断信息。

属性

诊断数组。

请求返回的操作类型。

不属于此类型的操作在通过灯泡显示之前会被过滤掉。

请求代码操作的原因。

CodeActionKind

代码操作的类型。

类型是由 `.` 分隔的层级标识符列表,例如 `"refactor.extract.function"`。

代码操作类型被编辑器用于 UI 元素,例如重构上下文菜单。用户还可以使用 `editor.action.codeAction` 命令触发具有特定类型的代码操作。

静态

空类型。

适用于整个笔记本范围的所有代码操作的基础类型。使用此类型的 CodeActionKinds 应始终以 `notebook.` 开头

这要求为其创建新的 CodeActions 并通过扩展贡献。预先存在的类型不能简单地添加新的 `notebook.` 前缀,因为该功能对于整个笔记本范围是唯一的。

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` (可能会将所有变量重命名为标准的大小写格式)

快速修复操作的基础类型:`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

调用命令的选择器或范围。如果在当前活动编辑器中请求操作,这始终是selection

context: CodeActionContext

提供有关正在请求何种代码操作的附加信息。您可以使用此信息来查看编辑器正在请求何种特定类型的代码操作,以便返回更相关的操作,并避免返回编辑器将丢弃的无关代码操作。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<Array<Command | T>>

代码操作的数组,例如快速修复或重构。可以通过返回 `undefined`、`null` 或空数组来表示没有结果。

出于历史原因,我们也支持返回 `Command`,但所有新扩展都应返回 `CodeAction` 对象。

给定一个代码操作,填充其 edit 属性。对所有其他属性(如标题)的更改都将被忽略。具有编辑属性的代码操作将不会被解析。

注意,返回命令而不是代码操作的代码操作提供程序无法成功实现此函数。返回命令已被弃用,应改为返回代码操作。

参数描述
codeAction: T

一个代码操作。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

已解析的代码操作或解析为此类操作的 thenable。返回给定的 `item` 是可以的。如果没有返回结果,将使用给定的 `item`。

CodeActionProviderMetadata

关于 CodeActionProvider 提供的代码操作类型的元数据。

属性

一类代码操作的静态文档。

如果满足以下任一条件,将在代码操作菜单中显示提供程序的文档

  • 编辑器请求了 `kind` 类型的代码操作。在这种情况下,编辑器将显示与请求的代码操作类型最匹配的文档。例如,如果提供程序同时有 `Refactor` 和 `RefactorExtract` 的文档,当用户请求 `RefactorExtract` 的代码操作时,编辑器将使用 `RefactorExtract` 的文档,而不是 `Refactor` 的文档。

  • 提供程序返回了任何 `kind` 类型的代码操作。

每个提供程序最多显示一个文档条目。

CodeActionProvider 可能返回的 CodeActionKinds 列表。

此列表用于确定是否应调用给定的 `CodeActionProvider`。为避免不必要的计算,每个 `CodeActionProvider` 都应使用 `providedCodeActionKinds`。类型列表可以是通用的,例如 `[CodeActionKind.Refactor]`,也可以列出提供的每种类型,例如 `[CodeActionKind.Refactor.Extract.append('function'), CodeActionKind.Refactor.Extract.append('constant'), ...]`。

CodeActionTriggerKind

请求代码操作的原因。

枚举成员

代码操作由用户或扩展明确请求。

代码操作是自动请求的。

这通常在文件中当前选择发生变化时发生,但也可能在文件内容变化时触发。

CodeLens

代码镜头表示一个应与源代码文本一起显示的 Command,例如引用数量、运行测试的方式等。

当没有命令与之关联时,代码镜头是*未解析的*。出于性能原因,代码镜头的创建和解析应分两个阶段进行。

另请参阅

构造函数

创建一个新的代码镜头对象。

参数描述
range: Range

此代码镜头适用的范围。

command?: Command

与此代码镜头关联的命令。

返回描述
CodeLens

属性

此代码镜头代表的命令。

当有关联的命令时为 `true`。

此代码镜头有效的范围。应只跨越单行。

CodeLensProvider<T>

代码镜头提供程序向源代码文本添加 commands。这些命令将作为专用的水平线显示在源代码文本之间。

事件

一个可选事件,用于通知此提供程序的代码镜头已更改。

方法

计算镜头列表。此调用应尽快返回,如果计算命令开销很大,实现者应只返回设置了范围的代码镜头对象,并实现resolve

参数描述
document: TextDocument

调用命令的文档。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T[]>

代码镜头数组或解析为此类数组的 thenable。可以通过返回 `undefined`、`null` 或空数组来表示没有结果。

此函数将为每个可见的代码镜头调用,通常在滚动时和调用 compute-lenses 之后。

参数描述
codeLens: T

必须解析的代码镜头。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

给定的、已解析的代码镜头或解析为此类镜头的 thenable。

Color

表示 RGBA 空间中的颜色。

构造函数

创建一个新的颜色实例。

参数描述
red: number

红色分量。

green: number

绿色分量。

blue: number

蓝色分量。

alpha: number

透明度分量。

返回描述
Color

属性

此颜色的透明度分量,范围为 `[0-1]`。

此颜色的蓝色分量,范围为 `[0-1]`。

此颜色的绿色分量,范围为 `[0-1]`。

此颜色的红色分量,范围为 `[0-1]`。

ColorInformation

表示文档中的颜色范围。

构造函数

创建一个新的颜色范围。

参数描述
range: Range

颜色出现的范围。不能为空。

color: Color

颜色的值。

返回描述
ColorInformation

属性

此颜色范围的实际颜色值。

此颜色在文档中出现的范围。

ColorPresentation

颜色表示对象描述了Color应如何表示为文本,以及从源代码引用它需要哪些编辑。

对于某些语言,一种颜色可以有多种表示形式,例如 css 可以用常量 `Red`、十六进制值 `#ff0000` 或 rgba 和 hsla 形式表示红色。在 csharp 中,适用其他表示形式,例如 `System.Drawing.Color.Red`。

构造函数

创建一个新的颜色表示。

参数描述
label: string

此颜色表示的标签。

返回描述
ColorPresentation

属性

一个可选的附加文本编辑数组,在选择此颜色表示时应用。编辑不得与主编辑重叠,也不得与自身重叠。

此颜色表示的标签。它将显示在颜色选择器的标题上。默认情况下,这也是选择此颜色表示时插入的文本。

一个编辑,在为颜色选择此表示时应用于文档。如果为 `falsy`,则使用标签

ColorTheme

表示一个颜色主题。

属性

此颜色主题的种类:浅色、深色、深色高对比度和浅色高对比度。

ColorThemeKind

表示颜色主题的种类。

枚举成员

浅色主题。

深色主题。

深色高对比度主题。

浅色高对比度主题。

Command

表示对命令的引用。提供一个标题,用于在 UI 中表示命令,以及一个可选的参数数组,在调用时将传递给命令处理函数。

属性

命令处理函数应调用的参数。

实际命令处理程序的标识符。

另请参阅 commands.registerCommand

命令的标题,如 `保存`。

在 UI 中表示时,命令的工具提示。

Comment

评论根据其提供方式显示在编辑器内或评论面板中。

属性

评论的作者信息

人类可读的评论正文

评论的上下文值。这可用于贡献评论特定的操作。例如,一个评论被赋予上下文值 `editable`。当使用 `menus` 扩展点向 `comments/comment/title` 贡献操作时,您可以在 `when` 表达式中为 `comment` 键指定上下文值,如 `comment == editable`。

    "contributes": {
        "menus": {
            "comments/comment/title": [
                {
                    "command": "extension.deleteComment",
                    "when": "comment == editable"
                }
            ]
        }
    }

这将仅对 `contextValue` 为 `editable` 的评论显示操作 `extension.deleteComment`。

描述Comment的可选标签。如果存在,标签将呈现在作者姓名旁边。

评论的评论模式

Comment的可选反应

可选的时间戳,将显示在评论中。日期将根据用户的区域设置进行格式化。

CommentAuthorInformation

Comment的作者信息

属性

作者的可选图标路径

评论作者的显示名称

CommentController

评论控制器能够为编辑器提供评论支持,并为用户提供与评论交互的各种方式。

属性

可选的评论范围提供程序。为任何给定的资源 uri 提供一个支持评论的范围列表。

如果未提供,用户将无法留下任何评论。

此评论控制器的 ID。

此评论控制器的人类可读标签。

评论控制器选项

用于在Comment上创建和删除反应的可选反应处理程序。

参数描述
comment: Comment
reaction: CommentReaction
返回描述
Thenable<void>

方法

创建一个评论串。评论串一旦创建,将显示在可见的文本编辑器(如果资源匹配)和评论面板中。

参数描述
uri: Uri

评论串所在文档的 uri。

range: Range

评论串在文档中的范围。

comments: readonly Comment[]

评论串中按顺序排列的评论。

返回描述
CommentThread

销毁此评论控制器。

一旦销毁,此评论控制器创建的所有评论串也将从编辑器和评论面板中移除。

参数描述
返回描述
void

CommentingRangeProvider

评论控制器的评论范围提供程序。

方法

为给定文档提供允许创建新评论串的范围列表,或为 null

参数描述
document: TextDocument
token: CancellationToken
返回描述
ProviderResult<Range[] | CommentingRanges>

CommentingRanges

CommentingRangeProvider 启用评论的范围。

属性

允许在没有特定范围的情况下向文件添加评论。

允许创建新评论串的范围。

CommentMode

Comment的评论模式

枚举成员

显示评论编辑器

显示评论的预览

CommentOptions

属性

一个可选字符串,当评论输入框获得焦点时作为占位符显示。

一个可选字符串,当评论输入框折叠时显示。

CommentReaction

Comment的反应

属性

评论的作者是否对这个反应做出了反应

对这个反应做出反应的用户数量

在 UI 中显示的反应图标。

反应的人类可读标签

CommentReply

在 `comments/commentThread/context` 中注册的操作的命令参数。

属性

评论编辑器中的值

活动的评论串

CommentRule

描述一种语言的评论如何工作。

属性

块注释字符对,如 `/* 块注释 *&#47;`

行注释标记,如 `// 这是注释`

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

可选的人类可读标签,用于描述评论线程

评论线程在文档中的范围。线程图标将显示在范围的最后一行。如果设置为 undefined,则评论将与文件关联,而不是特定范围。

评论线程的可选状态,可能会影响评论的显示方式。

评论串所在文档的 uri。

方法

释放此评论线程。

释放后,此评论线程将适时从可见的编辑器和评论面板中移除。

参数描述
返回描述
void

CommentThreadCollapsibleState

评论线程的可折叠状态。

枚举成员

确定一个项目是折叠的。

确定一个项目是展开的。

CommentThreadState

评论线程的状态。

枚举成员

未解决的线程状态。

已解决的线程状态。

CompletionContext

包含有关触发 完成项提供程序 的上下文的附加信息。

属性

触发完成项提供程序的字符。

如果提供程序不是由字符触发的,则为 undefined

当完成项提供程序被触发时,触发字符已在文档中。

完成项是如何被触发的。

CompletionItem

一个完成项表示一个文本片段,用于补全正在输入的文本。

仅从一个 label 创建一个完成项就足够了。在这种情况下,完成项将用给定的标签或 insertText 替换光标前的 单词。否则将使用给定的 edit

在编辑器中选择一个完成项时,其定义的或合成的文本编辑将应用于所有光标/选择,而 additionalTextEdits 将按提供的方式应用。

另请参阅

构造函数

创建一个新的完成项。

完成项必须至少有一个 标签,该标签将用作插入文本,也用于排序和过滤。

参数描述
label: string | CompletionItemLabel

完成项的标签。

kind?: CompletionItemKind

完成项的 类型

返回描述
CompletionItem

属性

一个可选的附加 文本编辑 数组,在选择此完成项时应用。编辑内容不得与主 编辑 重叠,也不得与自身重叠。

一个可选的 Command,在插入此完成项执行。请注意,对当前文档的附加修改应使用 additionalTextEdits 属性进行描述。

[]

一个可选的字符集,当此完成项处于活动状态时按下这些字符,将首先接受该完成项,然后键入该字符。请注意,所有提交字符的 length 应为 1,多余的字符将被忽略。

一个人类可读的字符串,包含有关此项的附加信息,如类型或符号信息。

一个人类可读的字符串,表示文档注释。

在过滤一组完成项时应使用的字符串。当值为 `falsy` 时,使用 label

请注意,过滤文本是与前导词(前缀)匹配的,该前缀由 range 属性定义。

在选择此完成项时应插入到文档中的字符串或代码片段。当值为 `falsy` 时,使用 label

按原样保留 insertText 的空白。默认情况下,编辑器会调整新行的前导空白,使其与接受该项的行的缩进相匹配——将此项设置为 true 将阻止该行为。

此完成项的类型。编辑器会根据类型选择一个图标。

此完成项的标签。默认情况下,这也是选择此完成项时插入的文本。

显示时选择此项。请注意,只能选择一个完成项,并且由编辑器决定是哪个项。规则是选择匹配度最高的项中的第一个

一个范围或一个插入和替换范围,用于选择应被此完成项替换的文本。

如果省略,则使用 当前单词 的范围作为替换范围,并使用从 当前单词 开始到当前位置的范围作为插入范围。

注意 1:一个范围必须是单行,并且必须包含请求补全的位置注意 2:插入范围必须是替换范围的前缀,这意味着它必须被包含并且从相同位置开始。

在将此项与其他项进行比较时应使用的字符串。当值为 `falsy` 时,使用 label

请注意,sortText 仅用于完成项的初始排序。当有前导词(前缀)时,排序基于完成项与该前缀的匹配程度,只有当完成项匹配程度相同时,才会使用初始排序。前缀由 range 属性定义,因此每个完成项的前缀可能不同。

此完成项的标签。

  • 已弃用 - 请改用 CompletionItem.insertTextCompletionItem.range

选择此完成项时应用于文档的 编辑。如果提供了编辑,则忽略 insertText 的值。

编辑的 Range 必须是单行的,并且与请求 完成项 的行相同。

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

配置范围可以是

  • 表示资源的 Uri
  • 表示打开的文本文档的 TextDocument
  • 表示工作区文件夹的 WorkspaceFolder
  • 一个包含以下内容的对象
    • uri: 一个可选的文本文档 Uri
    • languageId: 文本文档的语言标识符

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

属性

发生编辑的文档。

描述编辑的显示名称。

这将在 UI 中向用户显示,用于撤销/重做操作。

方法

重做编辑操作。

当用户重做此编辑时,编辑器会调用此方法。要实现 redo,您的扩展应将文档和编辑器恢复到此编辑通过 onDidChangeCustomDocument 添加到编辑器内部编辑堆栈后的状态。

参数描述
返回描述
void | Thenable<void>

撤销编辑操作。

当用户撤销此编辑时,编辑器会调用此方法。要实现 undo,您的扩展应将文档和编辑器恢复到此编辑通过 onDidChangeCustomDocument 添加到编辑器内部编辑堆栈之前的状态。

参数描述
返回描述
void | Thenable<void>

CustomDocumentOpenContext

有关打开自定义文档的附加信息。

属性

用于从中恢复文档的备份 ID,如果没有备份,则为 undefined

如果提供了此项,您的扩展应从备份恢复编辑器,而不是从用户的工作区读取文件。

如果 URI 是一个未命名文件,则此处将填充该文件的字节数据。

如果提供了此项,您的扩展应使用此字节数据,而不是在传入的 URI 上执行文件系统 API。

CustomEditorProvider<T>

用于使用自定义文档模型的可编辑自定义编辑器的提供程序。

自定义编辑器使用 CustomDocument 作为其文档模型,而不是 TextDocument。这使扩展能够完全控制编辑、保存和备份等操作。

在处理二进制文件或更复杂的场景时,应使用此类型的自定义编辑器。对于简单的基于文本的文档,请改用 CustomTextEditorProvider

事件

表示自定义编辑器内部发生了编辑。

每当自定义编辑器中发生编辑时,您的扩展必须触发此事件。编辑可以是任何事情,从更改一些文本,到裁剪图像,再到重新排序列表。您的扩展可以自由定义什么是编辑,以及每次编辑时存储什么数据。

触发 onDidChange 会导致编辑器被标记为脏状态。当用户保存或还原文件时,此状态将被清除。

支持撤销/重做的编辑器必须在每次编辑发生时触发一个 CustomDocumentEditEvent。这允许用户使用编辑器的标准键盘快捷键来撤销和重做编辑。如果用户撤销所有编辑回到上次保存的状态,编辑器也会将编辑器标记为不再是脏状态。

支持编辑但无法使用编辑器标准撤销/重做机制的编辑器必须触发一个 CustomDocumentContentChangeEvent。对于不支持撤销/重做的编辑器,用户清除脏状态的唯一方法是 保存还原 文件。

一个编辑器应该只触发 CustomDocumentEditEvent 事件,或者只触发 CustomDocumentContentChangeEvent 事件。

方法

备份一个脏的自定义文档。

备份用于热退出和防止数据丢失。您的 backup 方法应将资源以其当前状态持久化,即应用了编辑。最常见的情况是将资源保存到 ExtensionContext.storagePath 中的磁盘上。当编辑器重新加载并且为某个资源打开了您的自定义编辑器时,您的扩展应首先检查该资源是否存在任何备份。如果有备份,您的扩展应从那里加载文件内容,而不是从工作区中的资源加载。

backup 在用户停止编辑文档大约一秒后触发。如果用户快速编辑文档,backup 将不会被调用,直到编辑停止。

启用 自动保存 时不会调用 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,表示自定义编辑器已解析。

将自定义文档还原到其上次保存的状态。

当用户在自定义编辑器中触发 `文件:还原文件` 时,编辑器会调用此方法。(请注意,这仅用于编辑器的 `文件:还原文件` 命令,而不用于文件的 `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 类型映射的 map。

实现 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() 后的 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 是一个对象,则返回将 DataTransferItem.value 值进行 json 字符串化的结果。

参数描述
返回描述
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

调试会话使用的调试控制台模式,参见 options

枚举成员

调试会话应有独立的调试控制台。

调试会话应与其父会话共享调试控制台。此值对没有父会话的会话无效。

DebugProtocolBreakpoint

DebugProtocolBreakpoint 是对调试适配器协议中定义的 Breakpoint 类型的一个不透明的替代类型。

DebugProtocolMessage

DebugProtocolMessage 是对调试适配器协议中定义的 ProtocolMessage 类型的一个不透明的替代类型。

DebugProtocolSource

DebugProtocolSource 是对调试适配器协议中定义的 Source 类型的一个不透明的替代类型。

DebugSession

一个调试会话。

属性

此会话的“已解析”的调试配置。“已解析”意味着:

  • 所有变量都已被替换,且
  • 特定平台的属性部分已为匹配的平台“扁平化”,并为不匹配的平台移除。

此调试会话的唯一 ID。

调试会话的名称最初取自调试配置。任何更改都将正确反映在 UI 中。

此调试会话的父会话,如果它是作为子会话创建的。

另请参阅 DebugSessionOptions.parentSession

来自调试配置的调试会话类型。

此会话的工作区文件夹,对于无文件夹的设置则为 undefined

方法

向调试适配器发送自定义请求。

参数描述
command: string
args?: any
返回描述
Thenable<any>

将编辑器中的一个断点映射到由调试会话的调试适配器管理的相应调试适配器协议(DAP)断点。如果不存在 DAP 断点(可能是因为编辑器断点尚未注册,或者因为调试适配器对此断点不感兴趣),则返回 undefined 值。

参数描述
breakpoint: Breakpoint

编辑器中的一个断点

返回描述
Thenable<DebugProtocolBreakpoint>

一个解析为调试适配器协议断点或 undefined 的 promise。

DebugSessionCustomEvent

调试会话收到的自定义调试适配器协议事件。

属性

事件特定信息。

事件类型。

接收到自定义事件的调试会话

DebugSessionOptions

用于启动调试会话的选项。

属性

控制调试会话的父会话是否在调用堆栈视图中显示,即使它只有一个子会话。默认情况下,调试会话永远不会隐藏其父会话。如果 compact 为 true,则在调用堆栈视图中隐藏只有一个子会话的调试会话,以使树更紧凑。

控制此会话是否应有独立的调试控制台,或与父会话共享。对没有父会话的会话无效。默认为 Separate。

控制像 'restart' 这样的生命周期请求是发送到新创建的会话还是其父会话。默认情况下(如果该属性为 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[]>

一个定义或一个解析为此类定义的 thenable。可以通过返回 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

表示一个可以释放资源的类型,例如事件监听或计时器。

静态

将多个类可释放对象组合成一个。当您有带有 dispose 函数但不是 Disposable 实例的对象时,可以使用此方法。

参数描述
...disposableLikes: Array<{dispose: () => any}>

至少有一个 dispose 函数成员的对象。请注意,异步的 dispose 函数不会被等待。

返回描述
Disposable

返回一个新的可释放对象,该对象在释放时将释放所有提供的可释放对象。

构造函数

创建一个新的可释放对象,该对象在释放时调用提供的函数。

注意,异步函数不会被等待。

参数描述
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

在拖放时应用的编辑操作。

构造函数

参数描述
insertText: string | SnippetString

要在拖放位置插入的文本或代码片段。

title?: string

描述编辑的人类可读标签。

kind?: DocumentDropOrPasteEditKind

编辑的种类

返回描述
DocumentDropEdit

属性

一个可选的附加编辑,在拖放时应用。

要在拖放位置插入的文本或代码片段。

编辑的种类

描述编辑的人类可读标签。

控制多个编辑的顺序。如果此提供程序让步于其他编辑,它将在列表中显示得更低。

DocumentDropEditProvider<T>

处理将资源拖放到文本编辑器中的提供程序。

这允许用户将资源(包括来自外部应用程序的资源)拖放到编辑器中。在拖放文件时,用户可以按住 shift 键将文件拖放到编辑器中,而不是打开它。需要启用 editor.dropIntoEditor.enabled

方法

提供将正在拖放的内容插入到文档中的编辑。

参数描述
document: TextDocument

发生拖放的文档。

position: Position

文档中发生拖放的位置。

dataTransfer: DataTransfer

一个数据传输对象,包含有关正在拖放内容的数据。

token: CancellationToken

一个取消令牌。

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

一个文档拖放编辑或一个解析为此类编辑的 thenable。可以通过返回 undefinednull 来表示没有结果。

可选方法,在应用编辑之前填充 DocumentDropEdit.additionalEdit

每次编辑都会调用一次此方法,如果生成完整的编辑可能需要很长时间,则应使用此方法。Resolve 只能用于更改 DocumentDropEdit.additionalEdit

参数描述
edit: T

要解析的文档拖放编辑

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

已解析的编辑或一个解析为此类编辑的 thenable。可以返回给定的 edit。如果没有返回结果,则使用给定的 edit

DocumentDropEditProviderMetadata

提供关于文档拖放编辑提供程序工作方式的附加元数据。

属性

提供程序可以处理的数据传输 MIME 类型列表。

这可以是一个确切的 MIME 类型,如 image/png,也可以是一个通配符模式,如 image/*

对于从资源管理器或工作台中其他树视图拖放的资源,请使用 text/uri-list

使用 files 来指示如果数据传输中存在任何文件,则应调用该提供程序。请注意,只有在从编辑器外部拖放内容时(例如从操作系统拖放),才会创建数据传输文件条目。

提供程序可能在 provideDocumentDropEdits 中返回的种类列表。

这用于在请求特定种类的编辑时筛选出提供程序。

DocumentDropOrPasteEditKind

静态

基本文本编辑的根种类。

此种类应用于向文档中插入基本文本的编辑。一个很好的例子是粘贴剪贴板文本的同时,根据粘贴的文本更新文件中的导入。对于这种情况,我们可以使用类似 text.updateImports.someLanguageId 的种类。

尽管大多数拖放/粘贴编辑最终都会插入文本,但您不应将 Text 作为每个编辑的基本种类,因为这是多余的。相反,应使用更具体的种类来描述正在插入的内容类型。例如,如果编辑添加了 Markdown 链接,请使用 markdown.link,因为尽管插入的内容是文本,但更重要的是知道该编辑插入的是 Markdown 语法。

除了插入文本外,还更新文档中导入的编辑的根种类。

构造函数

参数描述
value: string
返回描述
DocumentDropOrPasteEditKind

属性

种类的原始字符串值。

方法

通过向当前种类附加其他作用域来创建新种类。

不修改当前类型。

参数描述
...parts: string[]
返回描述
DocumentDropOrPasteEditKind

检查 other 是否是此 DocumentDropOrPasteEditKind 的子种类。

例如,种类 "text.plain" 包含 "text.plain""text.plain.list",但不包含 "text""unicorn.text.plain"

参数描述
otherDocumentDropOrPasteEditKind

要检查的类型。

返回描述
布尔值

检查此种类是否与 other 相交。

例如,种类 "text.plain"text"text.plain""text.plain.list" 相交,但不与 "unicorn""textUnicorn.plain" 相交。

参数描述
otherDocumentDropOrPasteEditKind

要检查的类型。

返回描述
布尔值

DocumentFilter

文档筛选器通过不同属性来指定一个文档,例如其语言、其资源的协议或应用于其路径的 glob 模式。

示例 应用于磁盘上 typescript 文件的语言筛选器

{ language: 'typescript', scheme: 'file' }

示例 应用于所有 package.json 路径的语言筛选器

{ language: 'json', pattern: '**/package.json' }

属性

语言 ID,例如 typescript

笔记本的类型,例如 jupyter-notebook。这允许缩小单元格文档所属的笔记本类型范围。

注意,设置 notebookType 属性会改变 schemepattern 的解释方式。设置后,它们将根据笔记本 URI 而不是文档 URI 进行评估。

示例 匹配 jupyter 笔记本内尚未存储的 python 文档 (untitled)

{ language: 'python', notebookType: 'jupyter-notebook', scheme: 'untitled' }

一个在文档绝对路径上匹配的 glob 模式。使用相对模式将文档筛选到某个工作区文件夹

一个 Uri 协议,例如 fileuntitled

DocumentFormattingEditProvider

文档格式化提供程序接口定义了扩展和格式化功能之间的契约。

方法

为整个文档提供格式化编辑。

参数描述
document: TextDocument

调用命令的文档。

optionsFormattingOptions

控制格式化的选项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或一个解析为此类编辑的 thenable。可以通过返回 undefinednull 或空数组来表示没有结果。

DocumentHighlight

文档高亮是文本文档中一个值得特别关注的范围。通常,文档高亮通过改变其范围的背景颜色来可视化。

构造函数

创建一个新的文档高亮对象。

参数描述
range: Range

高亮应用的范围。

kind?: DocumentHighlightKind

高亮类型,默认为文本

返回描述
DocumentHighlight

属性

高亮类型,默认为文本

此高亮应用的范围。

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 或空数组来表示没有结果。

给定一个链接,填充其目标。当在 UI 中选择一个不完整的链接时,会调用此方法。提供程序可以实现此方法并从 provideDocumentLinks 方法返回不完整的链接(没有目标),这通常有助于提高性能。

参数描述
link: T

需要解析的链接。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

DocumentPasteEdit

应用粘贴操作的编辑。

构造函数

创建一个新的粘贴编辑。

参数描述
insertText: string | SnippetString

要在粘贴位置插入的文本或代码片段。

title: string

描述编辑的人类可读标签。

kindDocumentDropOrPasteEditKind

编辑的种类

返回描述
DocumentPasteEdit

属性

粘贴时可选应用的附加编辑。

要在粘贴位置插入的文本或代码片段。

如果您的编辑需要更高级的插入逻辑,请将其设置为空字符串并提供一个附加编辑

编辑的种类

描述编辑的人类可读标签。

当多个粘贴编辑可能被应用时,控制排序。

如果此编辑让位于另一个编辑,它将在向用户显示的所有可能的粘贴编辑列表中排在较低的位置。

DocumentPasteEditContext

关于粘贴操作的附加信息。

属性

请求返回的粘贴编辑的种类。

PasteAs 请求了一个明确的种类时,鼓励提供程序在生成所请求种类的编辑时更加灵活。

请求粘贴编辑的原因。

DocumentPasteEditProvider<T>

当用户在 TextDocument 中复制或粘贴时调用的提供程序。

方法

在用户从 文本编辑器 复制后调用的可选方法。

这允许提供程序将有关复制文本的元数据附加到 DataTransfer。此数据传输随后会在 provideDocumentPasteEdits 中回传给提供程序。

请注意,当前对 DataTransfer 的任何更改都仅限于当前的编辑器窗口。这意味着任何添加的元数据都无法被其他编辑器窗口或其他应用程序看到。

参数描述
document: TextDocument

发生复制操作的文本文档。

ranges: readonly Range[]

document 中被复制的范围。

dataTransfer: DataTransfer

与复制相关的数据传输。您可以将附加值存储在此对象上,以便稍后在 provideDocumentPasteEdits 中使用。此对象仅在此方法的持续时间内有效。

token: CancellationToken

一个取消令牌。

返回描述
void | Thenable<void>

可选的 thenable,当对 `dataTransfer` 的所有更改完成后解析。

在用户粘贴到 文本编辑器 之前调用。

返回的编辑可以替换标准的粘贴行为。

参数描述
document: TextDocument

被粘贴入的文档

ranges: readonly Range[]

要粘贴到的 document 中的范围。

dataTransfer: DataTransfer

与粘贴相关的 data transfer。此对象仅在粘贴操作期间有效。

contextDocumentPasteEditContext

粘贴的附加上下文。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T[]>

一组可以应用粘贴的潜在编辑。一次只应用一个返回的DocumentPasteEdit。如果所有提供程序返回了多个编辑,则第一个会自动应用,并显示一个窗口小部件,让用户切换到其他编辑。

在应用编辑前,填充 DocumentPasteEdit.additionalEdit 的可选方法。

每次编辑调用一次,如果生成完整的编辑可能需要很长时间,则应使用此方法。Resolve 只能用于更改 DocumentPasteEdit.insertTextDocumentPasteEdit.additionalEdit

参数描述
pasteEdit: T

要解析的 DocumentPasteEdit

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

已解析的粘贴编辑或一个解析为此类编辑的 thenable。返回给定的 pasteEdit 是可以的。如果没有返回结果,则使用给定的 pasteEdit

DocumentPasteProviderMetadata

提供有关 DocumentPasteEditProvider 如何工作的附加元数据。

属性

prepareDocumentPaste 在复制时可能添加的 Mime 类型。

应为其调用 provideDocumentPasteEdits 的 Mime 类型。

这可以是一个确切的 MIME 类型,如 image/png,也可以是一个通配符模式,如 image/*

对于从资源管理器或工作台中其他树视图拖放的资源,请使用 text/uri-list

使用 files 来表示如果 DataTransfer 中存在任何文件,则应调用提供程序。请注意,DataTransferFile 条目仅在从编辑器外部粘贴内容时创建,例如从操作系统粘贴。

提供程序可能在 provideDocumentPasteEdits 中返回的 种类列表。

这用于在请求特定种类的编辑时筛选出提供程序。

DocumentPasteTriggerKind

请求粘贴编辑的原因。

枚举成员

作为正常粘贴操作的一部分请求粘贴。

用户通过 paste as 命令请求粘贴。

DocumentRangeFormattingEditProvider

文档格式化提供程序接口定义了扩展和格式化功能之间的契约。

方法

为文档中的一个范围提供格式化编辑。

给定的范围是一个提示,提供程序可以决定格式化一个更小或更大的范围。通常这是通过将范围的开始和结束调整到完整的语法节点来完成的。

参数描述
document: TextDocument

调用命令的文档。

range: Range

应被格式化的范围。

optionsFormattingOptions

控制格式化的选项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<TextEdit[]>

一组文本编辑或一个解析为此类编辑的 thenable。可以通过返回 undefinednull 或空数组来表示没有结果。

为文档中的多个范围提供格式化编辑。

此函数是可选的,但允许格式化程序在仅格式化修改过的范围或格式化大量选择时执行得更快。

给定的范围是提示,提供程序可以决定格式化一个更小或更大的范围。通常这是通过将范围的开始和结束调整到完整的语法节点来完成的。

参数描述
document: TextDocument

调用命令的文档。

ranges: Range[]

应该被格式化的范围。

optionsFormattingOptions

控制格式化的选项。

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]。可以使用位标志设置多个标记修饰符,因此 tokenModifier 值为 3 首先被视为二进制 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

应用于变更器的选项,当未提供选项时,将默认为 { applyAtProcessCreation: true }

返回描述
void

从此集合中清除所有变更器。

参数描述
返回描述
void

删除此集合中变量的变更器。

参数描述
variable: string

要删除其变更器的变量。

返回描述
void

遍历此集合中的每个变更器。

参数描述
callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any

为每个条目执行的函数。

thisArg?: any

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

返回描述
void

获取此集合应用于变量的变更器(如果有)。

参数描述
variable: string

要获取其变更器的变量。

返回描述
EnvironmentVariableMutator

向环境变量前置一个值。

请注意,一个扩展只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要前置的变量。

value: string

要前置到变量的值。

options?: EnvironmentVariableMutatorOptions

应用于变更器的选项,当未提供选项时,将默认为 { applyAtProcessCreation: true }

返回描述
void

用一个值替换环境变量。

请注意,一个扩展只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要替换的变量。

value: string

用来替换变量的值。

options?: EnvironmentVariableMutatorOptions

应用于变更器的选项,当未提供选项时,将默认为 { applyAtProcessCreation: true }

返回描述
void

EnvironmentVariableMutator

应用于环境变量的变更类型及其值。

属性

应用于变更器的选项。

将对变量发生的变更类型。

用于变量的值。

EnvironmentVariableMutatorOptions

应用于变更器的选项。

属性

在进程创建前立即应用于环境。默认为 false。

应用于 shell 集成脚本中的环境。请注意,如果 shell 集成被禁用或因某种原因无法工作,这不会应用变更器。默认为 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>

事件发射器可用于创建和管理一个供他人订阅的事件。一个发射器始终拥有一个事件。

如果您想在扩展内部提供事件,例如在 TextDocumentContentProvider 中或在向其他扩展提供 API 时,请使用此类。

构造函数

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

属性

事件监听器可以订阅的事件。

方法

释放此对象并释放资源。

参数描述
返回描述
void

通知事件的所有订阅者。一个或多个监听器的失败不会导致此函数调用失败。

参数描述
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。

一个存储状态的 memento 对象,与当前打开的工作区无关。

扩展可以存储全局状态的绝对文件路径。该目录可能在磁盘上不存在,创建由扩展决定。但是,保证父目录存在。

使用 globalState 来存储键值数据。

扩展可以存储全局状态的目录的 uri。该目录可能在磁盘上不存在,创建由扩展决定。但是,保证父目录存在。

使用 globalState 来存储键值数据。

另请参阅 workspace.fs,了解如何从 uri 读写文件和文件夹。

一个保存有关此扩展如何使用语言模型的信息的对象。

另请参阅 LanguageModelChat.sendRequest

扩展可以创建日志文件的目录的绝对文件路径。该目录可能在磁盘上不存在,创建由扩展决定。但是,保证父目录存在。

  • 已弃用 - 请改用 logUri

扩展可以创建日志文件的目录的 uri。该目录可能在磁盘上不存在,创建由扩展决定。但是,保证父目录存在。

另请参阅 workspace.fs,了解如何从 uri 读写文件和文件夹。

一个存储状态的秘密存储对象,与当前打开的工作区无关。

扩展可以存储私有状态的工作区特定目录的绝对文件路径。该目录可能在磁盘上不存在,创建由扩展决定。但是,保证父目录存在。

使用 workspaceStateglobalState 来存储键值数据。

扩展可以存储私有状态的工作区特定目录的 uri。该目录可能不存在,创建由扩展决定。但是,保证父目录存在。当没有打开工作区或文件夹时,该值为 undefined

使用 workspaceStateglobalState 来存储键值数据。

另请参阅 workspace.fs,了解如何从 uri 读写文件和文件夹。

一个可以添加可释放对象的数组。当此扩展被停用时,这些可释放对象将被释放。

请注意,异步的 dispose 函数不会被等待。

一个在当前打开的工作区上下文中存储状态的 memento 对象。

方法

获取扩展中包含的资源的绝对路径。

请注意,可以通过 Uri.joinPathextensionUri 构建一个绝对 uri,例如 vscode.Uri.joinPath(context.extensionUri, relativePath);

参数描述
relativePath: string

扩展中包含的资源的相对路径。

返回描述
字符串

资源的绝对路径。

ExtensionKind

在远程窗口中,扩展种类描述了扩展是在 UI(窗口)运行的地方运行,还是在远程运行。

枚举成员

扩展在 UI 运行的地方运行。

扩展在远程扩展主机运行的地方运行。

ExtensionMode

ExtensionMode 在 ExtensionContext 上提供,并指示特定扩展运行的模式。

枚举成员

扩展在编辑器中正常安装(例如,从市场或 VSIX 安装)。

扩展从启动编辑器时提供的 --extensionDevelopmentPath 运行。

扩展从 --extensionTestsPath 运行,并且扩展主机正在运行单元测试。

ExtensionTerminalOptions

描述虚拟进程终端应使用哪些选项的值对象。

属性

终端的图标主题颜色。建议使用标准的 terminal.ansi* 主题键,以在不同主题间获得最佳对比度和一致性。

终端的图标路径或 ThemeIcon

选择不使用默认的重启和重新加载时终端持久化功能。这仅在启用 terminal.integrated.enablePersistentSessions 时生效。

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

Pseudoterminal 的实现,允许扩展程序控制终端。

用于验证 Shell 集成序列是否来自受信任来源的随机数。这对用户体验的一个影响示例是,如果报告的命令行带有随机数,则在通过 Shell 集成命令装饰重新运行它之前,将无需与用户验证命令行是否正确。

如果终端包含自定义 Shell 集成支持,则应使用此项。它应设置为一个随机的 GUID。在 Pseudoterminal 实现内部,可以在相关序列中传递此值,使其受到信任。

FileChangeEvent

文件系统提供程序必须用来表示文件更改的事件。

属性

更改的类型。

已更改文件的 URI。

FileChangeType

文件更改类型的枚举。

枚举成员

文件的内容或元数据已更改。

文件已创建。

文件已删除。

FileCoverage

包含文件的覆盖率元数据。

静态

根据覆盖率详细信息创建一个 FileCoverage 实例,并填充计数。

参数描述
uri: Uri

被覆盖文件的 URI

details: readonly FileCoverageDetail[]

详细的覆盖率信息

返回描述
FileCoverage

构造函数

参数描述
uri: Uri

被覆盖文件的 URI

statementCoverage: TestCoverageCount

语句覆盖率信息。如果报告器不提供语句覆盖率信息,则可以改用它来表示行覆盖率。

branchCoverage?: TestCoverageCount

分支覆盖率信息

declarationCoverage?: TestCoverageCount

声明覆盖率信息

includesTests?: TestItem[]

此覆盖率报告中包含的测试用例,请参阅 FileCoverage.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 选项的 FileSystemProviderFileStat 都将被隐式处理为设置了 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 值。否则,可能会有一些优化措施导致编辑器中不显示更改。

方法

复制文件或文件夹。实现此函数是可选的,但会加速复制操作。

  • throws - FileNotFounddestination 的父级不存在时,例如,不需要 mkdirp 逻辑。
  • throws - FileExistsdestination 存在且 overwrite 选项不为 true 时。
参数描述
source: Uri

现有文件。

destination: Uri

目标位置。

options: {overwrite: boolean}

定义是否应覆盖现有文件。

返回描述
void | Thenable<void>

创建一个新目录(注意,新文件是通过 write-调用创建的)。

  • throws - FileNotFounduri 的父级不存在时,例如,不需要 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。

重命名文件或文件夹。

  • throws - FileNotFoundnewUri 的父级不存在时,例如,不需要 mkdirp 逻辑。
  • throws - FileExistsnewUri 存在且 overwrite 选项不为 true 时。
参数描述
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

一个 disposable,告诉提供程序停止监视 uri

将数据写入文件,替换其全部内容。

  • throws - FileNotFounduri 不存在且未设置 create 时。
  • throws - FileNotFounduri 的父级不存在且设置了 create 时,例如,不需要 mkdirp 逻辑。
  • throws - FileExistsuri 已存在,设置了 create 但未设置 overwrite 时。
参数描述
uri: Uri

文件的 URI。

content: Uint8Array

文件的新内容。

options: {create: boolean, overwrite: boolean}

定义是否应创建或必须创建缺失的文件。

返回描述
void | Thenable<void>

FileSystemWatcher

文件系统监视器通知磁盘上或其他FileSystemProviders的文件和文件夹的更改。

要获取 FileSystemWatcher 的实例,请使用 createFileSystemWatcher

事件

在文件/文件夹更改时触发的事件。

在文件/文件夹创建时触发的事件。

在文件/文件夹删除时触发的事件。

属性

如果此文件系统监视器创建时忽略更改文件系统事件,则为 true。

如果此文件系统监视器创建时忽略创建文件系统事件,则为 true。

如果此文件系统监视器创建时忽略删除文件系统事件,则为 true。

方法

释放此对象。

参数描述
返回描述
any

FileType

文件类型的枚举。FileDirectory 类型也可以是符号链接,在这种情况下使用 FileType.File | FileType.SymbolicLinkFileType.Directory | FileType.SymbolicLink

枚举成员

文件类型未知。

常规文件。

目录。

指向文件的符号链接。

FileWillCreateEvent

当文件即将被创建时触发的事件。

要在文件创建之前对工作区进行修改,请调用 waitUntil-函数,并传入一个解析为 工作区编辑 的 thenable。

属性

即将被创建的文件。

一个取消令牌。

方法

允许暂停事件并应用 工作区编辑

注意:此函数只能在事件分发期间调用,不能以异步方式调用。

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

当文件即将被删除时触发的事件。

要在文件删除之前对工作区进行修改,请调用 waitUntil-函数,并传入一个解析为 工作区编辑 的 thenable。

属性

即将被删除的文件。

一个取消令牌。

方法

允许暂停事件并应用 工作区编辑

注意:此函数只能在事件分发期间调用,不能以异步方式调用。

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

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

要在文件重命名之前对工作区进行修改,请调用 waitUntil-函数,并传入一个解析为 工作区编辑 的 thenable。

属性

即将被重命名的文件。

一个取消令牌。

方法

允许暂停事件并应用 工作区编辑

注意:此函数只能在事件分发期间调用,不能以异步方式调用。

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

折叠范围的种类。

返回描述
FoldingRange

属性

要折叠范围的从零开始的结束行。折叠区域以该行的最后一个字符结束。要有效,结束行必须为零或更大,且小于文档中的行数。

描述折叠范围的种类,例如注释区域。该种类用于对折叠范围进行分类,并被“折叠所有注释”等命令使用。请参阅FoldingRangeKind以获取所有种类的枚举。如果未设置,则该范围源自语法元素。

要折叠范围的从零开始的起始行。折叠区域从该行的最后一个字符之后开始。要有效,结束行必须为零或更大,且小于文档中的行数。

FoldingRangeKind

特定折叠范围种类的枚举。FoldingRange 的 kind 是一个可选字段,用于区分特定的折叠范围,例如源自注释的范围。该种类被“折叠所有注释”或“折叠所有区域”等命令使用。如果范围上未设置种类,则该范围源自注释、导入或区域标记之外的语法元素。

枚举成员

表示注释的折叠范围种类。

表示导入的折叠范围种类。

表示源自折叠标记(如 #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
返回描述
FunctionBreakpoint

属性

条件断点的可选表达式。

断点是否已启用。

此断点所附加的函数的名称。

一个可选的表达式,用于控制断点被忽略的次数。

断点的唯一 ID。

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

GlobalEnvironmentVariableCollection

扩展可以应用于进程环境的突变集合。适用于所有作用域。

属性

环境变量集合的描述,将用于在 UI 中描述更改。

该集合是否应为工作区缓存并在窗口重新加载时应用于终端。当为 true 时,集合将立即生效,例如在窗口重新加载时。此外,如果存在缓存版本,此 API 将返回它。当扩展被卸载或集合被清除时,集合将失效。默认为 true。

方法

向环境变量追加一个值。

请注意,一个扩展只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要追加的变量。

value: string

要追加到变量的值。

options?: EnvironmentVariableMutatorOptions

应用于变更器的选项,当未提供选项时,将默认为 { applyAtProcessCreation: true }

返回描述
void

从此集合中清除所有变更器。

参数描述
返回描述
void

删除此集合中变量的变更器。

参数描述
variable: string

要删除其变更器的变量。

返回描述
void

遍历此集合中的每个变更器。

参数描述
callback: (variable: string, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) => any

为每个条目执行的函数。

thisArg?: any

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

返回描述
void

获取此集合应用于变量的变更器(如果有)。

参数描述
variable: string

要获取其变更器的变量。

返回描述
EnvironmentVariableMutator

获取扩展的特定作用域环境变量集合。这使得可以在指定作用域内单独更改终端环境变量,并且它是在全局集合之后(并在此基础上)应用的。

通过此方法获得的每个对象都是独立的,不影响其他作用域的对象,包括全局集合。

参数描述
scope: EnvironmentVariableScope

环境变量集合适用的作用域。

如果省略了作用域参数,则返回适用于该参数所有相关作用域的集合。例如,如果未指定 'workspaceFolder' 参数,则将返回适用于所有工作区文件夹的集合。

返回描述
EnvironmentVariableCollection

传入作用域的环境变量集合。

向环境变量前置一个值。

请注意,一个扩展只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要前置的变量。

value: string

要前置到变量的值。

options?: EnvironmentVariableMutatorOptions

应用于变更器的选项,当未提供选项时,将默认为 { applyAtProcessCreation: true }

返回描述
void

用一个值替换环境变量。

请注意,一个扩展只能对任何一个变量进行一次更改,因此这将覆盖之前对 replace、append 或 prepend 的任何调用。

参数描述
variable: string

要替换的变量。

value: string

用来替换变量的值。

options?: EnvironmentVariableMutatorOptions

应用于变更器的选项,当未提供选项时,将默认为 { 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

悬停(Hover)表示符号或单词的附加信息。悬停信息呈现在一个类似工具提示的小部件中。

构造函数

创建一个新的悬停对象。

参数描述
contents: MarkdownString | MarkedString | Array<MarkdownString | MarkedString>

悬停的内容。

range?: Range

悬停适用的范围。

返回描述
Hover

属性

此悬停的内容。

此悬停适用的范围。如果缺少,编辑器将使用当前位置的单词范围或当前位置本身。

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[]>

一个定义或一个解析为此类定义的 thenable。可以通过返回 undefinednull 来表示没有结果。

IndentAction

描述按下 Enter 键时如何处理缩进。

枚举成员

插入新行并复制上一行的缩进。

插入新行并增加一级缩进(相对于上一行的缩进)。

插入两个新行

  • 第一个新行增加缩进,光标将停留在此处
  • 第二个新行保持相同的缩进级别

插入新行并减少一级缩进(相对于上一行的缩进)。

IndentationRule

描述一种语言的缩进规则。

属性

如果某一行匹配此模式,则其后的所有行都应减少一级缩进(直到有其他规则匹配)。

如果某一行匹配此模式,则其后的所有行都应增加一级缩进(直到有其他规则匹配)。

如果某一行匹配此模式,则仅其后一行应增加一级缩进。

如果某一行匹配此模式,则其缩进不应被更改,也不应根据其他规则进行评估。

InlayHint

内联提示信息。

构造函数

创建一个新的内联提示。

参数描述
position: Position

提示的位置。

label: string | InlayHintLabelPart[]

提示的标签。

kind?: InlayHintKind

提示的 类型

返回描述
内联提示

属性

此提示的类型。内联提示的类型定义了该提示的外观。

此提示的标签。一个人类可读的字符串或一个 标签部分 数组。

请注意,字符串和标签部分都不能为空。

在提示前渲染内边距。内边距将使用编辑器的背景色,而不是提示本身的背景色。这意味着内边距可用于视觉上对齐或分隔内联提示。

在提示后渲染内边距。内边距将使用编辑器的背景色,而不是提示本身的背景色。这意味着内边距可用于视觉上对齐或分隔内联提示。

此提示的位置。

当接受此内联提示时执行的可选 文本编辑。接受内联提示的默认手势是双击。

请注意,编辑操作应更改文档,使得内联提示(或其最接近的变体)现在成为文档的一部分,而内联提示本身则变得过时。

请注意,此属性可以在 解析 内联提示的过程中后期设置。

当您悬停在此项上时显示的工具提示文本。

请注意,此属性可以在 解析 内联提示的过程中后期设置。

InlayHintKind

内联提示的类型。

内联提示的类型定义了其外观,例如使用相应的前景色和背景色。

枚举成员

用于类型注解的内联提示。

用于参数的内联提示。

InlayHintLabelPart

内联提示标签部分允许内联提示具有交互式和复合标签。

构造函数

创建一个新的内联提示标签部分。

参数描述
value: string

该部分的值。

返回描述
内联提示标签部分

属性

此标签部分的可选命令。

编辑器将带有命令的部分渲染为可点击的链接。当标签部分定义了 位置命令 时,该命令会添加到上下文菜单中。

请注意,此属性可以在 解析 内联提示的过程中后期设置。

代表此标签部分的可选 源代码位置

编辑器将使用此位置进行悬停提示和代码导航功能:此部分将成为一个可点击的链接,解析到给定位置符号的定义(不一定是位置本身),它会显示在该位置显示的悬停提示,并显示一个带有进一步代码导航命令的上下文菜单。

请注意,此属性可以在 解析 内联提示的过程中后期设置。

当您悬停在此标签部分上时显示的工具提示文本。

请注意,此属性可以在 解析 内联提示的过程中后期设置。

此标签部分的值。

InlayHintsProvider<T>

内联提示提供程序接口定义了扩展和内联提示功能之间的契约。

事件

一个可选事件,用于通知此提供程序的内联提示已更改。

方法

为给定的范围和文档提供内联提示。

请注意,未被给定范围 包含 的内联提示将被忽略。

参数描述
document: TextDocument

调用命令的文档。

range: Range

应计算内联提示的范围。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T[]>

一个内联提示数组或解析为此类数组的 thenable 对象。

给定一个内联提示,填充其 工具提示文本编辑 或完整的标签 部分

请注意,编辑器最多只会解析一个内联提示一次。

参数描述
hint: T

一个内联提示。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

已解析的内联提示或解析为此类提示的 thenable 对象。返回给定的 item 也是可以的。如果没有返回结果,将使用给定的 item

InlineCompletionContext

提供有关请求内联补全的上下文信息。

属性

如果自动补全小部件可见,则提供有关当前所选项的信息。

如果设置了此项,则提供的内联补全必须扩展所选项的文本并使用相同的范围,否则它们不会作为预览显示。例如,如果文档文本是 console.,所选项是 .log,它替换了文档中的 .,那么内联补全也必须替换 . 并以 .log 开头,例如 .log()

每当所选项更改时,都会再次请求内联补全提供程序。

描述内联补全是如何被触发的。

InlineCompletionItem

内联补全项表示一个文本片段,它以内联方式建议,用于补全正在键入的文本。

另请参阅 InlineCompletionItemProvider.provideInlineCompletionItems

构造函数

创建一个新的内联补全项。

参数描述
insertText: string | SnippetString

用于替换范围的文本。

range?: Range

要替换的范围。如果未设置,将使用请求位置处的单词。

command?: Command

一个可选的 命令,在插入此补全项之后执行。

返回描述
内联补全项

属性

一个可选的 命令,在插入此补全项之后执行。

用于决定是否应显示此内联补全的文本。如果为 falsy,则使用 InlineCompletionItem.insertText

如果待替换的文本是筛选文本的前缀,则显示内联补全。

用于替换范围的文本。必须设置。用于预览和接受操作。

要替换的范围。必须在同一行开始和结束。

当用户删除键入的文本时,优先使用替换而不是插入,以提供更好的体验。

InlineCompletionItemProvider

内联补全项提供程序接口定义了扩展和内联补全功能之间的契约。

提供程序会在用户手势明确请求或在键入时隐式请求时被调用以提供补全项。

方法

为给定的位置和文档提供内联补全项。如果启用了内联补全,则每当用户停止键入时都会调用此方法。当用户明确触发内联补全或明确请求下一个或上一个内联补全时,也会调用此方法。在这种情况下,应返回所有可用的内联补全项。context.triggerKind 可用于区分这些场景。

参数描述
document: TextDocument

请求内联补全的文档。

position: Position

请求内联补全的位置。

context: InlineCompletionContext

一个包含附加信息的上下文对象。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<InlineCompletionList | InlineCompletionItem[]>

一个补全项数组或解析为此类数组的 thenable 对象。

InlineCompletionList

表示要在编辑器中呈现的 内联补全项 集合。

构造函数

创建一个新的内联补全项列表。

参数描述
items: InlineCompletionItem[]
返回描述
内联补全列表

属性

内联补全项。

InlineCompletionTriggerKind

描述 内联补全提供程序 是如何被触发的。

枚举成员

由用户手势明确触发补全。返回多个补全项以启用在它们之间循环切换。

在编辑时自动触发补全。在这种情况下,返回单个补全项就足够了。

InlineValue

内联值信息可以通过不同方式提供

  • 直接作为文本值(InlineValueText 类)。
  • 作为用于变量查找的名称(InlineValueVariableLookup 类)
  • 作为可求值表达式(InlineValueEvaluatableExpression 类)。InlineValue 类型将所有内联值类型组合成一个类型。

InlineValueContext

一个值对象,在从 InlineValuesProvider 请求内联值时包含上下文信息。

属性

执行停止处的堆栈帧(作为 DAP Id)。

执行停止处的文档范围。通常,该范围的结束位置表示显示内联值的行。

InlineValueEvaluatableExpression

通过表达式求值提供内联值。如果只指定了范围,则表达式将从底层文档中提取。可以使用可选表达式来覆盖提取的表达式。

构造函数

创建一个新的 InlineValueEvaluatableExpression 对象。

参数描述
range: Range

从底层文档中提取可评估表达式的范围。

expression?: string

如果指定,则覆盖提取的表达式。

返回描述
可求值的内联值表达式

属性

如果指定,则该表达式将覆盖提取的表达式。

内联值适用的文档范围。该范围用于从底层文档中提取可求值的表达式。

InlineValuesProvider

内联值提供程序接口定义了扩展和编辑器调试器内联值功能之间的契约。在此契约中,提供程序为给定的文档范围返回内联值信息,编辑器在行尾显示此信息。

事件

一个可选事件,用于通知内联值已更改。

另请参阅 EventEmitter

方法

为给定的文档和范围提供“内联值”信息。每当调试在给定文档中停止时,编辑器都会调用此方法。返回的内联值信息将在编辑器的行尾渲染。

参数描述
document: TextDocument

需要内联值信息的文档。

viewPort: Range

应计算内联值的可见文档范围。

context: InlineValueContext

一个包含上下文信息的包,如当前位置。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<InlineValue[]>

一个 InlineValueDescriptors 数组或解析为此类数组的 thenable 对象。可以通过返回 undefinednull 来表示没有结果。

InlineValueText

以文本形式提供内联值。

构造函数

创建一个新的 InlineValueText 对象。

参数描述
range: Range

显示内联值的文档行。

text: string

要为该行显示的值。

返回描述
内联文本值

属性

内联值适用的文档范围。

内联值的文本。

InlineValueVariableLookup

通过变量查找提供内联值。如果只指定了范围,则变量名将从底层文档中提取。可以使用可选的变量名来覆盖提取的名称。

构造函数

创建一个新的 InlineValueVariableLookup 对象。

参数描述
range: Range

显示内联值的文档行。

variableName?: string

要查找的变量的名称。

caseSensitiveLookup?: boolean

如何执行查找。如果缺失,则查找是区分大小写的。

返回描述
内联值变量查找

属性

如何执行查找。

内联值适用的文档范围。该范围用于从底层文档中提取变量名。

如果指定,则为要查找的变量的名称。

InputBox

一个具体的 QuickInput,用于让用户输入文本值。

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

事件

一个事件,在用户表示接受输入值时触发。

一个事件,在值发生变化时触发。

一个事件,在此输入 UI 隐藏时触发。

此 UI 可能因多种原因需要隐藏,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide、用户按下 Esc、打开其他输入 UI 等)

一个事件,在按钮被触发时触发。

属性

UI 是否应显示进度指示器。默认为 false。

例如,在加载更多数据或验证用户输入时,将此项更改为 true。

UI 中的操作按钮。

UI 是否应允许用户输入。默认为 true。

例如,在验证用户输入或为下一步用户输入加载数据时,将此项更改为 false。

UI 是否应在失去焦点时保持打开。默认为 false。此设置在 iPad 上被忽略,始终为 false。

输入值是否应被隐藏。默认为 false。

当没有输入值时显示的可选占位符。

一个可选的提示文本,向用户提供一些询问或解释。

一个可选的当前步骤数。

一个可选的标题。

一个可选的总步骤数。

一个可选的验证消息,指示当前输入值存在问题。通过返回一个字符串,输入框将使用默认的 Error InputBoxValidationSeverity。返回 undefined 将清除验证消息。

当前输入值。

输入值的选择范围。定义为一个包含两个数字的元组,第一个是包含的起始索引,第二个是排除的结束索引。如果为 undefined,则将选择整个预填充的值;如果为空(起始等于结束),则只设置光标;否则将选择定义的范围。

当用户键入或进行选择时,此属性不会更新,但可以通过扩展进行更新。

方法

释放此输入 UI 及其关联的任何资源。如果它仍然可见,则会先隐藏。此调用后,该输入 UI 将不再可用,不应再访问其上的其他方法或属性。应创建一个新的输入 UI。

参数描述
返回描述
void

隐藏此输入 UI。这也将触发一个 QuickInput.onDidHide 事件。

参数描述
返回描述
void

以其当前配置使输入 UI 可见。任何其他输入 UI 将首先触发一个 QuickInput.onDidHide 事件。

参数描述
返回描述
void

InputBoxOptions

配置输入框 UI 行为的选项。

属性

设置为 true 可在焦点移动到编辑器的另一部分或另一个窗口时保持输入框打开。此设置在 iPad 上被忽略,始终为 false。

控制是否显示密码输入。密码输入会隐藏键入的文本。

一个可选字符串,在输入框中作为占位符显示,以指导用户输入。

显示在输入框下方的文本。

一个可选字符串,表示输入框的标题。

在输入框中预填充的值。

预填充 的选择范围。定义为一个包含两个数字的元组,第一个是包含的起始索引,第二个是排除的结束索引。如果为 undefined,则将选择整个预填充的值;如果为空(起始等于结束),则只设置光标;否则将选择定义的范围。

方法

一个可选函数,将用于验证输入并向用户提供提示。

参数描述
value: string

输入框的当前值。

返回描述
string | InputBoxValidationMessage | Thenable<string | InputBoxValidationMessage>

一个人类可读的字符串,作为错误消息呈现;或者一个 InputBoxValidationMessage,可以提供特定的消息严重性。当 'value' 有效时,返回 undefinednull 或空字符串。

InputBoxValidationMessage

用于配置验证消息行为的对象。

属性

要显示的验证消息。

验证消息的严重性。注意:当使用 InputBoxValidationSeverity.Error 时,用户将不被允许接受(按 ENTER)输入。InfoWarning 仍将允许输入框接受输入。

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 将被拒绝。

LanguageModelChatCapabilities

LanguageModelChatInformation 支持的各种功能,如工具调用或图像输入。

属性

模型是否支持图像输入。常见的支持图像是 jpg 和 png,但每个模型支持的 mimetype 会有所不同。

模型是否支持工具调用。如果提供了一个数字,则该数字是可以在请求中提供给模型的最大工具数。

LanguageModelChatInformation

表示由 LanguageModelChatProvider 提供的语言模型。

属性

模型支持的各种功能,如工具调用或图像输入。

一个可选的、人类可读的字符串,将与模型一起呈现。有助于在 UI 中区分同名模型。

语言模型的不透明家族名称。值可能是 gpt-3.5-turbogpt4phi2llama

语言模型的唯一标识符。每个提供程序必须唯一,但不需要全局唯一。

模型可以接受的最大输入令牌数。

模型能够产生的最大令牌数。

语言模型的人类可读名称。

悬停在模型上时呈现的工具提示。用于提供有关模型的更多信息。

模型的不透明版本字符串。这在 LanguageModelChatSelector.version 中用作查找值。例如,GPT 4o 有多个版本,如 2024-11-20 和 2024-08-06

LanguageModelChatMessage

表示聊天中的一条消息。可以扮演不同的角色,如用户或助手。

静态

用于创建新助手消息的实用工具。

参数描述
content: string | Array<LanguageModelTextPart | LanguageModelDataPart | LanguageModelToolCallPart>

消息的内容。

name?: string

消息用户的可选名称。

返回描述
语言模型聊天消息

用于创建新用户消息的实用工具。

参数描述
content: string | Array<LanguageModelTextPart | LanguageModelToolResultPart | LanguageModelDataPart>

消息的内容。

name?: string

消息用户的可选名称。

返回描述
语言模型聊天消息

构造函数

创建一条新的用户消息。

参数描述
role: LanguageModelChatMessageRole

消息的角色。

content: string | LanguageModelInputPart[]

消息的内容。

name?: string

消息用户的可选名称。

返回描述
语言模型聊天消息

属性

一个字符串或异构数组,其中包含消息可以作为内容的内容。对于某些模型,某些部分可能特定于消息类型。

此消息的用户的可选名称。

此消息的角色。

LanguageModelChatMessageRole

代表聊天消息的角色。可以是用户或助手。

枚举成员

用户角色,例如与语言模型互动的人类。

助手角色,例如生成响应的语言模型。

LanguageModelChatProvider<T>

LanguageModelChatProvider 实现了对语言模型的访问,用户可以通过聊天视图或通过获取 LanguageModelChat 的扩展 API 来使用这些模型。一个例子是提供像 gpt-5、o3 等模型的 OpenAI 提供程序。

事件

一个可选事件,当可用的语言模型集发生变化时触发。

方法

获取此提供程序提供的可用语言模型列表

参数描述
options: PrepareLanguageModelChatModelOptions

指定此函数调用上下文的选项

token: CancellationToken

一个取消令牌

返回描述
ProviderResult<T[]>

可用语言模型的列表

返回聊天请求的响应,并将结果传递给进度回调。LanguageModelChatProvider 必须在从语言模型接收到响应部分时将其发送到进度回调。

参数描述
model: T

要使用的语言模型

messages: readonly LanguageModelChatRequestMessage[]

要包含在请求中的消息

options: ProvideLanguageModelChatResponseOptions

请求的选项

progress: Progress<LanguageModelResponsePart>

用于发出流式响应块的进度

token: CancellationToken

一个取消令牌

返回描述
Thenable<void>

一个在响应完成时解析的 promise。结果实际上会传递给进度回调。

使用特定于模型的分词器逻辑返回给定文本的 token 数量

参数描述
model: T

要使用的语言模型

text: string | LanguageModelChatRequestMessage

要计算 token 数量的文本

token: CancellationToken

一个取消令牌

返回描述
Thenable<number>

token 的数量

LanguageModelChatRequestMessage

LanguageModelChatMessage 的提供程序版本。

属性

一个异构数组,包含消息可作为内容包含的各种内容。对于某些模型,某些部分可能是特定于消息类型的。

此消息的用户的可选名称。

此消息的角色。

LanguageModelChatRequestOptions

使用语言模型发出聊天请求的选项。

另请参阅 LanguageModelChat.sendRequest

属性

一条人类可读的消息,解释为什么需要访问语言模型以及它启用了什么功能。

一组控制语言模型行为的选项。这些选项特定于语言模型,需要查阅相应的文档。

要使用的工具选择模式。默认为 LanguageModelChatToolMode.Auto

一个可选的工具列表,可供语言模型使用。这些可以是已注册的工具(可通过 lm.tools 获取),也可以是仅在调用扩展中实现的私有工具。

如果 LLM 请求调用这些工具之一,它将在 LanguageModelChatResponse.stream 中返回一个 LanguageModelToolCallPart。调用者有责任调用该工具。如果是在 lm.tools 中注册的工具,则意味着调用 lm.invokeTool

然后,可以通过创建一个带有 LanguageModelToolCallPart 的助手类型 LanguageModelChatMessage,后跟一个带有 LanguageModelToolResultPart 的用户类型消息,将工具结果提供给 LLM。

LanguageModelChatResponse

代表语言模型响应。

另请参阅 ChatRequest

属性

一个异步可迭代对象,是构成整体响应的文本和工具调用部分的流。 LanguageModelTextPart 是助手响应的一部分,将显示给用户。 LanguageModelToolCallPart 是语言模型调用工具的请求。后者只有在请求中通过 LanguageModelChatRequestOptions.tools 传递了工具时才会返回。`unknown`-type 用作未来部分的占位符,例如图像数据部分。

注意,在接收数据期间发生错误时,此流将出错。流的消费者应相应地处理错误。

要取消流,消费者可以 取消 用于发出请求的 token,或从 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

供语言模型使用的工具调用模式。

枚举成员

语言模型可以选择调用工具或生成消息。这是默认值。

语言模型必须调用提供的工具之一。注意 - 某些模型在使用此模式时仅支持单个工具。

LanguageModelDataPart

包含任意数据的语言模型响应部分。可用于响应聊天消息工具结果和其他语言模型交互中。

静态

为图像创建一个新的 LanguageModelDataPart

参数描述
data: Uint8Array

二进制图像数据

mime: string

图像的 MIME 类型。常见值为 image/pngimage/jpeg

返回描述
LanguageModelDataPart

为 json 创建一个新的 LanguageModelDataPart

注意,此函数不期望“字符串化的 JSON”,而是一个可以被字符串化的对象。当传递的值无法进行 JSON 字符串化时,此函数将抛出错误。

参数描述
value: any

一个可 JSON 字符串化的值。

mime?: string

可选的 MIME 类型,默认为 application/json

返回描述
LanguageModelDataPart

为文本创建一个新的 LanguageModelDataPart

注意,使用 UTF-8 编码器为字符串创建字节。

参数描述
value: string

文本数据

mime?: string

MIME 类型(如果有)。常见值为 text/plaintext/markdown

返回描述
LanguageModelDataPart

构造函数

使用给定内容构造一个通用的数据部分。

参数描述
data: Uint8Array

此部分的字节数据。

mimeType: string

数据的 mime 类型。

返回描述
LanguageModelDataPart

属性

此部分的字节数据。

确定如何解释数据属性的 mime 类型。

LanguageModelError

一种针对语言模型特定错误的错误类型。

语言模型的使用者应检查 code 属性以确定具体的失败原因,例如,对于引用未知语言模型的情况,可以使用 if(someError.code === vscode.LanguageModelError.NotFound.name) {...}。对于未指定的错误,`cause` 属性将包含实际的错误。

静态

请求者被阻止使用此语言模型。

参数描述
message?: string
返回描述
LanguageModelError

请求者没有权限使用此语言模型

参数描述
message?: string
返回描述
LanguageModelError

语言模型不存在。

参数描述
message?: string
返回描述
LanguageModelError

构造函数

参数描述
message?: string
返回描述
LanguageModelError

属性

标识此错误的代码。

可能的值是错误的名称,如 NotFound,或对于语言模型本身的未指定错误为 Unknown。在后一种情况下,`cause` 属性将包含实际的错误。

LanguageModelInputPart

可以通过 LanguageModelChat.sendRequest 发送并由 LanguageModelChatProvider 处理的各种消息类型

LanguageModelPromptTsxPart

一个包含来自 vscode/prompt-tsx 的 PromptElementJSON 的语言模型响应部分。

另请参阅 LanguageModelToolResult

构造函数

使用给定内容构造一个 prompt-tsx 部分。

参数描述
value: unknown

部分的值,即来自 vscode/prompt-tsxrenderElementJSON 的结果。

返回描述
LanguageModelPromptTsxPart

属性

该部分的值。

LanguageModelResponsePart

LanguageModelChatProvider 可以在聊天响应流中发出的各种消息类型

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 的选项。

一个将工具调用与来自 聊天参与者 的聊天请求联系起来的不透明对象。

获取有效工具调用令牌的唯一方法是使用聊天请求中提供的 toolInvocationToken。在这种情况下,进度条将自动显示在聊天响应视图中用于工具调用,并且如果工具需要用户确认,它将内联显示在聊天视图中。

如果在聊天请求之外调用工具,则应传递 undefined,并且除了确认之外不会显示特殊的用户界面。

注意,在其调用期间调用另一个工具的工具可以传递其收到的 toolInvocationToken

LanguageModelToolInvocationPrepareOptions<T>

属性

调用工具时使用的输入。

LanguageModelToolResult

从工具调用返回的结果。如果使用 vscode/prompt-tsx,此结果可以使用 ToolResult 进行渲染。

构造函数

创建一个 LanguageModelToolResult

参数描述
content: unknown[]

工具结果内容部分的列表

返回描述
LanguageModelToolResult

属性

工具结果内容部分的列表。包含 `unknown` 是因为将来可能会用新的内容类型扩展此列表。

另请参阅 lm.invokeTool

LanguageModelToolResultPart

工具调用的结果。这是 工具调用 的对应部分,它只能包含在用户消息的内容中

构造函数

参数描述
callId: string

工具调用的 ID。

content: unknown[]

工具结果的内容。

返回描述
LanguageModelToolResultPart

属性

工具调用的 ID。

注意,这应与工具调用部分的 callId 匹配。

工具结果的值。

LanguageModelToolTokenizationOptions

与工具调用的分词相关的选项。

属性

如果已知,工具应在其结果中发出的最大 token 数。

方法

使用模型特定的分词器逻辑计算消息中的令牌数。

参数描述
text: string

一个字符串。

token?: CancellationToken

可选的取消令牌。有关如何创建,请参阅 CancellationTokenSource

返回描述
Thenable<number>

一个解析为令牌数的 thenable 对象。

LanguageStatusItem

语言状态项是为活动文本编辑器呈现语言状态报告的首选方式,例如选定的 linter 或通知配置问题。

属性

屏幕阅读器与此项交互时使用的辅助功能信息

控制该项是否显示为“忙碌”。默认为 false

此项的 命令

可选的、人类可读的此项详细信息。

此项的标识符。

此项的简称,如“Java 语言状态”等。

一个 选择器,定义此项在哪些编辑器中显示。

此项的严重性。

默认为信息。您可以使用此属性向用户发出信号,表明存在需要注意的问题,例如缺少可执行文件或配置无效。

条目要显示的文本。您可以通过利用语法在文本中嵌入图标

我的文本 $(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

范围或位置。位置将被转换为空范围。

返回描述
位置

属性

此位置的文档范围。

此位置的资源标识符。

表示两个位置的连接。提供比普通位置更多的元数据,包括一个源范围。

属性

此链接的源范围。

用作鼠标定义悬停时的下划线范围。默认为定义位置的单词范围。

此链接的完整目标范围。

此链接的范围。

此链接的目标资源标识符。

LogLevel

日志级别

枚举成员

此级别不记录任何消息。

此级别记录所有消息。

此级别记录调试及更高日志级别的消息。

此级别记录信息及更高日志级别的消息。

此级别记录警告及更高日志级别的消息。

此级别仅记录错误消息。

LogOutputChannel

用于包含日志输出的通道。

要获取 `LogOutputChannel` 的实例,请使用 createOutputChannel

事件

一个事件,当通道的日志级别改变时触发。

属性

通道的当前日志级别。默认为编辑器日志级别

此输出通道的人类可读名称。

方法

将给定值附加到通道。

参数描述
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 将被转义。

McpHttpServerDefinition

McpHttpServerDefinition 代表一个可通过 Streamable HTTP 传输协议访问的 MCP 服务器。

构造函数

参数描述
label: string

服务器的人类可读名称。

uri: Uri

服务器的 URI。

headers?: Record<string, string>

每个请求到服务器时包含的可选附加头信息。

version?: string
返回描述
McpHttpServerDefinition

属性

每个请求到服务器时包含的可选附加头信息。

服务器的人类可读名称。

服务器的 URI。编辑器将向此 URI 发出 POST 请求以开始每个会话。

服务器的可选版本标识。如果此项发生更改,编辑器将指示工具已更改并提示刷新它们。

McpServerDefinition

描述不同类型的模型上下文协议(MCP)服务器的定义,可从 McpServerDefinitionProvider 返回。

McpServerDefinitionProvider<T>

一个可以提供模型上下文协议(MCP)服务器定义的类型。这应在扩展激活期间使用 lm.registerMcpServerDefinitionProvider 进行注册。

事件

可选事件,用于信号通知可用服务器集已更改。

方法

提供可用的 MCP 服务器。编辑器将积极调用此方法以确保语言模型服务器的可用性,因此扩展不应采取需要用户交互的操作,例如身份验证。

参数描述
token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T[]>

一个可用的 MCP 服务器数组

当编辑器需要启动 MCP 服务器时,将调用此函数。此时,扩展可以采取任何可能需要用户交互的操作,例如身份验证。服务器的任何非 `readonly` 属性都可以修改,扩展应返回已解析的服务器。

扩展可以返回 undefined 以指示不应启动服务器,或者抛出错误。如果存在待处理的工具调用,编辑器将取消它并向语言模型返回错误消息。

参数描述
server: T

要解析的 MCP 服务器

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

解析后的服务器或解析为此类服务器的 thenable。这可能是给定的 `server` 定义,其中非只读属性已填充。

McpStdioServerDefinition

McpStdioServerDefinition 表示一个通过运行本地进程并操作其 stdin 和 stdout 流来访问的 MCP 服务器。该进程将作为扩展主机的子进程生成,并且默认情况下不会在 shell 环境中运行。

构造函数

参数描述
label: string

服务器的人类可读名称。

command: string

用于启动服务器的命令。

args?: string[]

传递给服务器的附加命令行参数。

env?: Record<string, string | number>

服务器的可选附加环境信息。

version?: string

服务器的可选版本标识。

返回描述
McpStdioServerDefinition

属性

传递给服务器的附加命令行参数。

用于启动服务器的命令。基于 Node.js 的服务器可以使用 process.execPath 来使用编辑器的 Node.js 版本运行脚本。

用于启动服务器的工作目录。

服务器的可选附加环境信息。此环境中的变量将覆盖或删除(如果为 null)编辑器扩展主机的默认环境变量。

服务器的人类可读名称。

服务器的可选版本标识。如果此项发生更改,编辑器将指示工具已更改并提示刷新它们。

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 Pending](#_NotebookCellExecutionState.Pending Pending) 状态。当在执行任务上调用 start(...) 时,它进入 [NotebookCellExecutionState.Executing Executing](#_NotebookCellExecutionState.Executing Executing) 状态。当调用 end(...) 时,它进入 [NotebookCellExecutionState.Idle Idle](#_NotebookCellExecutionState.Idle 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。如果为 undefined,则不显示复选标记或 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 位整数的数组。

决定如何解释 data-属性的 mime 类型。

笔记本内置支持某些 mime-types,扩展可以添加对新类型的支持并覆盖现有类型。

NotebookCellStatusBarAlignment

表示状态栏项的对齐方式。

枚举成员

左对齐。

右对齐。

NotebookCellStatusBarItem

对单元格状态栏的贡献

构造函数

创建一个新的 NotebookCellStatusBarItem。

参数描述
text: string

要为该项显示的文本。

alignment: NotebookCellStatusBarAlignment

该项是左对齐还是右对齐。

返回描述
NotebookCellStatusBarItem

属性

当屏幕阅读器与此项交互时使用的可访问性信息。

该项是左对齐还是右对齐。

一个可选的命令或点击时运行的命令标识符。

该命令必须是已知的

请注意,如果这是一个命令对象,编辑器只使用命令参数

项的优先级。值越高的项将显示在更左侧。

要为该项显示的文本。

当鼠标悬停在该项上时显示的工具提示。

NotebookCellStatusBarItemProvider

一个可以为显示在单元格编辑器下方的状态栏提供项的提供程序。

事件

一个可选事件,用于表示状态栏项已更改。将再次调用 provide 方法。

方法

当单元格滚动到视图中、其内容、输出、语言或元数据发生变化以及执行状态发生变化时,将调用该提供程序。

参数描述
cell: NotebookCell

为其返回项的单元格。

token: CancellationToken

如果此请求应被取消,则会触发一个令牌。

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

一个或多个单元格状态栏项

NotebookController

笔记本控制器表示可以执行笔记本单元格的实体。这通常被称为内核。

可以有多个控制器,编辑器将让用户选择要用于特定笔记本的控制器。notebookType-属性定义了控制器适用于哪种类型的笔记本,而updateNotebookAffinity-函数允许控制器为特定的笔记本文件设置偏好。当一个控制器被选中时,它的onDidChangeSelectedNotebooks-事件会触发。

当单元格正在运行时,编辑器将调用executeHandler,控制器应该创建并完成一个笔记本单元格执行。然而,控制器也可以自行创建执行。

事件

每当一个控制器被选中或取消选中一个笔记本文件时触发的事件。

一个笔记本可以有多个控制器,在这种情况下,需要选择一个控制器。这是一个用户操作,当与一个建议了控制器的笔记本交互时,会显式或隐式地发生。如果可能,编辑器会建议最有可能被选择的控制器。

请注意,控制器选择是持久化的(通过控制器的id),并在控制器重新创建或打开笔记本时恢复。

属性

人类可读的描述,渲染时不太突出。

人类可读的详细信息,渲染时不太突出。

当 UI 中的运行手势被选择时,例如“运行单元格”、“全部运行”、“运行选择”等,将调用执行处理器。执行处理器负责创建和管理执行对象。

参数描述
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

表示描述笔记本编辑器可见范围变化的事件。

属性

可见范围已更改的笔记本编辑器

NotebookRange

笔记本范围表示两个单元格索引的有序对。保证 start 小于或等于 end。

构造函数

创建一个新的笔记本范围。如果 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

已键入的字符。

optionsFormattingOptions

控制格式化的选项。

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

属性

从零开始的字符值。

字符偏移量使用 UTF-16 代码单元表示。

从零开始的行值。

方法

将此位置与 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

属性

此属性的存在表示在运行工具之前应请求用户确认。对于任何有副作用或可能存在危险的工具,都应请求用户确认。

在工具运行时显示的自定义进度消息。

PrepareLanguageModelChatModelOptions

属性

是否应通过某些 UI 流程提示用户,或者是否应尝试静默解析模型。如果 silent 为 true,由于缺少信息(如 API 密钥),可能无法解析所有模型。

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` 支持显示取消按钮。

进度应显示的位置。

一个人类可读的字符串,将用于描述操作。

ProvideLanguageModelChatResponseOptions

LanguageModelChatRequestOptions 的提供程序版本

属性

一组控制语言模型行为的选项。这些选项特定于语言模型。

要使用的工具选择模式。提供程序必须实现对此的遵守。

一个可选的工具列表,可供语言模型使用。这些可以是已注册的工具(可通过 lm.tools 获取),也可以是仅在调用扩展中实现的私有工具。

如果 LLM 请求调用这些工具之一,它将在 LanguageModelChatResponse.stream 中返回一个 LanguageModelToolCallPart。调用者有责任调用该工具。如果是在 lm.tools 中注册的工具,则意味着调用 lm.invokeTool

然后,可以通过创建一个带有 LanguageModelToolCallPart 的助手类型 LanguageModelChatMessage,后跟一个带有 LanguageModelToolResultPart 的用户类型消息,将工具结果提供给 LLM。

ProviderResult<T>

提供程序结果表示提供程序(如 HoverProvider)可能返回的值。首先,这是实际的结果类型 `T`,如 `Hover`,或一个解析为该类型 `T` 的 thenable。此外,可以返回 `null` 和 `undefined` —— 可以直接返回,也可以从 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` 只会将光标下移一行,您还需要写入 `\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>

一个解析为匹配原始资源 uri 的 thenable。

QuickInput

一个轻量级的用户输入 UI,初始时不可见。通过其属性配置后,扩展可以通过调用 QuickInput.show 使其可见。

此 UI 可能因多种原因需要隐藏,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide、用户按下 Esc、打开其他输入 UI 等)

用户按下回车键或其他暗示接受当前状态的手势并不会自动隐藏此 UI 组件。由扩展决定是否接受用户的输入,以及是否应通过调用 QuickInput.hide 来隐藏 UI。

当扩展不再需要此输入 UI 时,应调用 QuickInput.dispose 以释放与其关联的任何资源。

有关具体的 UI,请参见 QuickPickInputBox

事件

一个事件,在此输入 UI 隐藏时触发。

此 UI 可能因多种原因需要隐藏,扩展将通过 QuickInput.onDidHide 收到通知。(例如:显式调用 QuickInput.hide、用户按下 Esc、打开其他输入 UI 等)

属性

UI 是否应显示进度指示器。默认为 false。

例如,在加载更多数据或验证用户输入时,将此项更改为 true。

UI 是否应允许用户输入。默认为 true。

例如,在验证用户输入或为下一步用户输入加载数据时,将此项更改为 false。

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 是否应在失去焦点时保持打开。默认为 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>)` 语法渲染 主题图标

注意:当 kind 设置为 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 之后或与之相等。

如果 startend 相等,则为 true

如果 `start.line` 和 `end.line` 相等,则为 `true`。

起始位置。它在 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。可以通过返回 `undefined`、`null` 或空数组来表示没有结果。

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

一个文件 glob 模式,如 `*.{ts,js}`,将相对于基本路径进行匹配。

返回描述
RelativePattern

属性

此模式将相对匹配的基本文件路径。

这匹配 RelativePattern.baseUri 的 `fsPath` 值。

注意: 更新此值将更新 RelativePattern.baseUri 为一个 `file` 方案的 uri。

此模式将相对匹配的基本文件路径。文件路径必须是绝对路径,不应有任何尾随路径分隔符,也不应包含任何相对段(`.` 或 `..`)。

一个文件 glob 模式,如 `*.{ts,js}`,将相对于基本路径的文件路径进行匹配。

示例:给定基本路径 `/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}>

要重命名的标识符的范围或范围和占位符文本。可以通过返回 `undefined` 或 `null` 来表示没有结果。

提供一个描述将符号重命名为不同名称所需对一个或多个资源进行的更改的编辑。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

newName: string

符号的新名称。如果给定的名称无效,提供程序必须返回一个被拒绝的 promise。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<WorkspaceEdit>

一个工作区编辑或一个解析为此类编辑的 thenable。可以通过返回 `undefined` 或 `null` 来表示没有结果。

RunOptions

任务的运行选项。

属性

控制在重新运行时是否重新评估任务变量。

SaveDialogOptions

用于配置文件保存对话框行为的选项。

属性

对话框打开时显示的资源。

对话框使用的一组文件过滤器。每个条目都是一个人类可读的标签,如“TypeScript”,以及一个扩展名数组,例如

{
    'Images': ['png', 'jpg'],
    'TypeScript': ['ts', 'tsx']
}

保存按钮的人类可读字符串。

对话框标题。

此参数可能会被忽略,因为并非所有操作系统都在保存对话框上显示标题(例如,macOS)。

SecretStorage

表示一个用于存储秘密(或任何敏感信息)的存储工具,这些信息将被加密存储。秘密存储的实现在每个平台上都不同,并且秘密不会跨机器同步。

事件

当秘密被存储或删除时触发。

方法

从存储中删除一个秘密。

参数描述
key: string

秘密存储时使用的键。

返回描述
Thenable<void>

检索用键存储的秘密。如果没有与该键匹配的密码,则返回 undefined。

参数描述
key: string

秘密存储时使用的键。

返回描述
Thenable<string>

存储的值或 undefined

检索此扩展存储的所有秘密的键。

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

在给定的键下存储一个秘密。

参数描述
key: string

存储秘密时使用的键。

value: string

秘密。

返回描述
Thenable<void>

SecretStorageChangeEvent

当秘密被添加或删除时触发的事件数据。

属性

已更改的秘密的键。

SelectedCompletionInfo

描述当前选定的补全项。

属性

如果接受此补全项,将被替换的范围。

如果接受此补全,范围将被替换成的文本。

Selection

表示编辑器中的文本选择。

构造函数

从两个位置创建一个选择。

参数描述
anchor: Position

一个位置。

active: Position

一个位置。

返回描述
Selection

从四个坐标创建一个选区。

参数描述
anchorLine: number

一个从零开始的行值。

anchorCharacter: number

一个从零开始的字符值。

activeLine: number

一个从零开始的行值。

activeCharacter: number

一个从零开始的字符值。

返回描述
Selection

属性

光标的位置。此位置可能在 anchor 之前或之后。

选区开始的位置。此位置可能在 active 之前或之后。

结束位置。它在 start 之后或与之相等。

如果 startend 相等,则为 true

如果选区的 anchorend 位置,则该选区是反向的。

如果 `start.line` 和 `end.line` 相等,则为 `true`。

起始位置。它在 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

选择范围的父级。

返回描述
SelectionRange

属性

包含此范围的父选择范围。

此选择范围的 Range

SelectionRangeProvider

选择范围提供程序接口定义了扩展和“扩大和缩小选择”功能之间的契约。

方法

为给定位置提供选择范围。

选择范围应针对每个位置单独且独立地计算。编辑器将合并和去重范围,但提供程序必须返回选择范围的层次结构,以便一个范围被其父范围 包含

参数描述
document: TextDocument

调用命令的文档。

positions: readonly Position[]

调用命令的位置。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<SelectionRange[]>

选择范围或一个解析为选择范围的 thenable。可以通过返回 undefinednull 来表示没有结果。

SemanticTokens

表示语义标记,可以是在一个范围内,也可以是在整个文档中。

另请参阅

构造函数

创建新的语义标记。

参数描述
data: Uint32Array

标记数据。

resultId?: string

结果标识符。

返回描述
SemanticTokens

属性

实际的标记数据。

另请参阅 provideDocumentSemanticTokens 以获取格式说明。

标记的结果 ID。

这是将传递给 DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits (如果已实现) 的 ID。

SemanticTokensBuilder

语义标记构建器可以帮助创建一个包含增量编码的语义标记的 SemanticTokens 实例。

构造函数

创建一个语义标记构建器。

参数描述
legend?: SemanticTokensLegend

一个语义标记图例。

返回描述
SemanticTokensBuilder

方法

完成并创建一个 SemanticTokens 实例。

参数描述
resultId?: string
返回描述
SemanticTokens

添加另一个标记。

参数描述
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。

这是将传递给 DocumentSemanticTokensProvider.provideDocumentSemanticTokensEdits (如果已实现) 的 ID。

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:default value} 定义。另请参阅完整的片段语法

构造函数

创建一个新的片段字符串。

参数描述
value?: string

一个片段字符串。

返回描述
SnippetString

属性

片段字符串。

方法

将一个选项 (${1|a,b,c|}) 附加到此片段字符串的 value 的构建器函数。

参数描述
values: readonly string[]

选项的值 - 字符串数组

number?: number

此制表位的编号,默认为从 1 开始的自增值。

返回描述
SnippetString

此片段字符串。

将一个占位符 (${1:value}) 附加到此片段字符串的 value 的构建器函数。

参数描述
value: string | (snippet: SnippetString) => any

此占位符的值 - 可以是一个字符串,也可以是一个用于创建嵌套片段的函数。

number?: number

此制表位的编号,默认为从 1 开始的自增值。

返回描述
SnippetString

此片段字符串。

将一个制表位 ($1, $2 等) 附加到此片段字符串的 value 的构建器函数。

参数描述
number?: number

此制表位的编号,默认为从 1 开始的自增值。

返回描述
SnippetString

此片段字符串。

将给定字符串附加到此片段字符串的 value 的构建器函数。

参数描述
string: string

一个要“按原样”附加的值。该字符串将被转义。

返回描述
SnippetString

此片段字符串。

将一个变量 (${VAR}) 附加到此片段字符串的 value 的构建器函数。

参数描述
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)。

在输入框中显示的占位符字符串,以指导用户。

输入框内容的 setter 和 getter。

控制输入框是否可见(默认为 true)。

SourceControlResourceDecorations

源代码管理资源状态的装饰。可以为亮色和暗色主题独立指定。

属性

暗色主题装饰。

源代码管理资源状态是否应在 UI 中淡化显示。

特定源代码管理资源状态的图标路径。

<感叹 class="ts" id="3960" data-target="#details-3960" data-toggle="collapse" role="button" tabindex="0" aria-expanded="false">light?: SourceControlResourceThemableDecorations

亮色主题装饰。

源代码管理资源状态是否应在 UI 中显示删除线。

特定源代码管理资源状态的标题。

SourceControlResourceGroup

源代码管理资源组是源代码管理资源状态的集合。

属性

资源组的上下文值。这可用于贡献特定于资源组的操作。例如,如果资源组的上下文值为 exportable,则在使用 menus 扩展点向 scm/resourceGroup/context 贡献操作时,可以在 when 表达式中为键 scmResourceGroupState 指定上下文值,如 scmResourceGroupState == exportable

"contributes": {
  "menus": {
    "scm/resourceGroup/context": [
      {
        "command": "extension.export",
        "when": "scmResourceGroupState == exportable"
      }
    ]
  }
}

这将仅对 contextValue 等于 exportable 的资源组显示操作 extension.export

当此源代码管理资源组不包含任何源代码管理资源状态时是否隐藏。

此源代码管理资源组的 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 的选择,以确保条目在所有主题中都可读。

此条目的前景色。

点击时运行的命令或命令标识符。

该命令必须是已知的

请注意,如果这是一个命令对象,编辑器只使用命令参数

此项的标识符。

注意:如果 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

该选项卡表示两个正在以差异比较形式渲染的基于文本的资源。

构造函数

使用给定的 URIs 构造一个新的文本差异比较选项卡输入。

参数描述
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。默认为 undefined,表示任务不属于任何特殊组。

任务是否为后台任务。

任务的名称

显示选项。默认为空字面量。

附加到任务的问题匹配器。默认为空数组。

任务的运行选项

任务的作用域。

描述此 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[]>

任务数组

解析一个没有设置 execution 的任务。任务通常是根据 `tasks.json` 文件中的信息创建的。这类任务缺少如何执行它们的信息,任务提供者必须在 `resolveTask` 方法中填充缺失的信息。此方法不会对从上述 `provideTasks` 方法返回的任务调用,因为那些任务总是完全解析的。`resolveTask` 方法的一个有效默认实现是返回 `undefined`。

请注意,在填充 `task` 的属性时,你必须确保使用完全相同的 `TaskDefinition`,而不是创建一个新的。其他属性可以更改。

参数描述
task: T

要解析的任务。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<T>

已解析的任务

TaskRevealKind

控制终端可见性的行为。

枚举成员

如果任务被执行,总是将终端带到前台。

只有在执行任务时检测到问题(例如任务无法启动)时才将终端带到前台。

执行任务时,终端永远不会出现在前台。

TaskScope

任务的作用域。

枚举成员

该任务是全局任务。目前不支持全局任务。

该任务是工作区任务

TaskStartEvent

一个表示任务执行开始的事件。

此接口不应被实现。

属性

代表已启动任务的任务项。

TelemetryLogger

一个遥测记录器,扩展可以使用它来记录使用情况和错误遥测。

记录器包装了一个发送器,但它保证

  • 尊重用户禁用或调整遥测的设置,并且
  • 潜在的敏感数据被移除

它还启用了一个“回显 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 类型或检测 shell 启动的文件夹很有用。

终端的退出状态,当终端处于活动状态时,此值为 undefined。

示例:当终端以非零退出代码退出时,显示带有退出代码的通知。

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 集成从未激活,此对象可能保持为 undefined。例如,命令提示符不支持 shell 集成,并且用户的 shell 设置可能与自动 shell 集成激活冲突。

Terminal的当前状态。

方法

释放并释放关联的资源。

参数描述
返回描述
void

如果此终端当前正在显示,则隐藏终端面板。

参数描述
返回描述
void

向终端发送文本。文本被写入终端底层 pty 进程(shell)的 stdin。

参数描述
text: string

要发送的文本。

shouldExecute?: boolean

指示发送的文本应该被执行,而不仅仅是插入到终端中。添加的字符是 `\n` 或 `\r\n`,具体取决于平台。默认为 `true`。

返回描述
void

显示终端面板并在 UI 中显示此终端。

参数描述
preserveFocus?: boolean

当为 `true` 时,终端将不会获得焦点。

返回描述
void

TerminalDimensions

表示终端的尺寸。

属性

终端中的列数。

终端中的行数。

TerminalEditorLocationOptions

假设 TerminalLocation 为编辑器,并允许指定 ViewColumnpreserveFocus 属性

属性

一个可选标志,当为 `true` 时,将阻止终端获得焦点。

终端应在编辑器区域中显示的视图列。默认为活动列。不存在的列将根据需要创建,最多可达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 集成序列是否来自受信任来源的随机数。这对用户体验的一个影响示例是,如果报告的命令行带有随机数,则在通过 Shell 集成命令装饰重新运行它之前,将无需与用户验证命令行是否正确。

如果终端包含自定义 shell 集成支持,则应使用此项。它应设置为一个随机的 GUID,该 GUID 将设置 VSCODE_NONCE 环境变量。在 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 集成脚本明确报告(即高置信度)并且它使用随机数进行验证时,此值为 true

已执行的完整命令行,包括命令及其参数。

TerminalShellExecutionCommandLineConfidence

枚举成员

命令行值置信度低。这意味着该值是使用 shell 集成脚本报告的标记从终端缓冲区中读取的。此外,还会满足以下条件之一:

  • 命令从最左边的列开始,这不寻常,或者
  • 命令是多行的,由于换行符和右提示符,这更难准确检测。
  • shell 集成脚本未报告命令行标记。

命令行值置信度中等。这意味着该值是使用 shell 集成脚本报告的标记从终端缓冲区中读取的。该命令是单行的,并且不是从最左边的列开始的(这不寻常)。

命令行值置信度高。这意味着该值是由 shell 集成脚本明确发送的,或者命令是通过 TerminalShellIntegration.executeCommand API 执行的。

TerminalShellExecutionEndEvent

一个事件,表示终端中的执行已结束。

属性

已结束的终端 shell 执行。

shell 报告的退出代码。

当此值为 undefined 时,可能意味着以下几种情况:

  • shell 没有报告退出代码(即 shell 集成脚本行为不当)
  • shell 在命令完成前报告命令已开始(例如,打开了一个子 shell)。
  • 用户通过 ctrl+c 取消了命令。
  • 用户在没有输入时按下了回车键。

通常不应发生这种情况。根据使用情况,最好将其视为失败。

示例

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 以中断任何正在运行的命令。

  • throws - 在不支持此 API 的终端(如任务终端)上运行时抛出异常。

示例

// 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

使用父终端的位置作为终端的位置

属性

要在此终端旁边拆分的父终端。无论父终端是在面板中还是在编辑器区域,此操作都有效。

TerminalState

表示 终端 的状态。

属性

终端是否已与之交互。交互意味着终端已向进程发送数据,这取决于终端的模式。默认情况下,在按下按键或命令或扩展发送文本时发送输入,但根据终端的模式,也可能在以下情况下发生:

  • 指针点击事件
  • 指针滚动事件
  • 指针移动事件
  • 终端焦点进/出

有关可发送数据的事件的更多信息,请参阅 https://invisible-island.net/xterm/ctlseqs/ctlseqs.html 上的“DEC Private Mode Set (DECSET)”

终端检测到的 shell 类型。当没有明确信号表明 shell 是什么,或者 shell 尚不支持时,此值将为 undefined。启动子 shell 时(例如,在 zsh 内运行 bash),此值应更改为子 shell 的 shell 类型。

请注意,可能的值当前定义为以下任何一种:'bash', 'cmd', 'csh', 'fish', 'gitbash', 'julia', 'ksh', 'node', 'nu', 'pwsh', 'python', 'sh', 'wsl', 'zsh'。

TestController

发现和执行测试的入口点。它包含用于填充编辑器 UI 的 TestController.items,并与运行配置文件相关联以允许执行测试。

属性

tests.createTestController 中传入的控制器 ID。此 ID 必须全局唯一。

一个“顶级” TestItem 实例的集合,这些实例可以有自己的 children 以形成“测试树”。

扩展程序控制何时添加测试。例如,当 workspace.onDidOpenTextDocument 触发时,扩展程序应为文件添加测试,以便文件中的测试装饰可见。

但是,编辑器有时可能会使用 resolveHandler 明确请求子项。有关详细信息,请参阅该方法的文档。

测试控制器的人类可读标签。

如果存在此方法,UI 中将显示刷新按钮,单击时将调用此方法。调用时,扩展应扫描工作区以查找任何新的、更改的或删除的测试。

建议扩展程序尝试实时更新测试,例如使用 FileSystemWatcher,并将此方法用作后备。

参数描述
token: CancellationToken
返回描述
void | Thenable<void>

一个在测试刷新后解析的 thenable。

由扩展程序提供的函数,编辑器可以调用它来请求测试项的子项,前提是 TestItem.canResolveChildrentrue。调用时,该项应发现子项并在发现子项时调用 TestController.createTestItem

通常,扩展程序管理测试项的生命周期,但在某些情况下,编辑器可能会请求加载特定项的子项。例如,如果用户在重新加载编辑器后请求重新运行测试,编辑器可能需要调用此方法来解析先前运行的测试。

在函数返回或返回的 thenable 解析之前,资源管理器中的项将自动标记为“繁忙”。

参数描述
item: TestItem

一个正在请求子项的未解析测试项,或 undefined 以解析控制器的初始 items

返回描述
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 中的项,其值为 undefined。

测试项在其 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[]

要运行的特定测试数组,或 undefined 以运行所有测试

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

表示文本文档,例如源文件。文本文档具有并且了解底层资源(如文件)。

属性

保存文档时将使用的此文档的文件编码。

使用 onDidChangeTextDocument-事件以在文档编码更改时获得通知。

请注意,可能的编码值当前定义为以下任何一种:'utf8', 'utf8bom', 'utf16le', 'utf16be', 'windows1252', 'iso88591', 'iso88593', 'iso885915', 'macroman', 'cp437', 'windows1256', 'iso88596', 'windows1257', 'iso88594', 'iso885914', 'windows1250', 'iso88592', 'cp852', 'windows1251', 'cp866', 'cp1125', 'iso88595', 'koi8r', 'koi8u', 'iso885913', 'windows1253', 'iso88597', 'windows1255', 'iso88598', 'iso885910', 'iso885916', 'windows1254', 'iso88599', 'windows1258', 'gbk', 'gb18030', 'cp950', 'big5hkscs', 'shiftjis', 'eucjp', 'euckr', 'windows874', 'iso885911', 'koi8ru', 'koi8t', 'gb2312', 'cp865', 'cp850'。

此文档中主要使用的行尾序列。

关联资源的文件系统路径。TextDocument.uri.fsPath 的简写形式。与 uri 方案无关。

如果文档已关闭,则为 true。关闭的文档不再同步,并且在再次打开相同资源时不会被重用。

如果存在未持久化的更改,则为 true

此文档是否代表一个从未保存过的无标题文件。注意,这并不意味着文档将被保存到磁盘,请使用 Uri.scheme 来确定文档将保存到哪里,例如 fileftp 等。

与此文档关联的语言的标识符。

此文档中的行数。

此文档的关联 URI。

注意,大多数文档使用 file 方案,这意味着它们是磁盘上的文件。然而,并非所有文档都保存在磁盘上,因此在尝试访问底层文件或磁盘上的同级文件之前,必须检查 scheme

另请参阅

此文档的版本号(每次更改后都会严格增加,包括撤销/重做)。

方法

获取此文档的文本。可以通过提供范围来检索子字符串。该范围将被调整

参数描述
range?: Range

仅包含该范围内的文本。

返回描述
字符串

所提供范围内的文本或整个文本。

在给定位置获取单词范围。默认情况下,单词由常见的分隔符定义,如空格、-、_ 等。此外,可以为每种语言定义自定义的[单词定义]。也可以提供自定义的正则表达式。

  • 注意 1:自定义正则表达式不能匹配空字符串,如果匹配,它将被忽略。
  • 注意 2:自定义正则表达式无法匹配多行字符串,并且为了速度,正则表达式不应匹配带空格的单词。对于更复杂的非单词场景,请使用 TextLine.text

该位置将被调整

参数描述
position: Position

一个位置。

regex?: RegExp

描述单词是什么的可选正则表达式。

返回描述
Range

一个跨越一个单词的范围,或 undefined

返回由行号表示的文本行。请注意,返回的对象不是实时的,文档的更改不会反映出来。

参数描述
line: number

一个在 [0, lineCount) 范围内的行号。

返回描述
TextLine

一个

返回由位置表示的文本行。请注意,返回的对象不是实时的,文档的更改不会反映出来。

该位置将被调整

另请参阅 TextDocument.lineAt

参数描述
position: Position

一个位置。

返回描述
TextLine

一个

将位置转换为从零开始的偏移量。

该位置将被调整

参数描述
position: Position

一个位置。

返回描述
number

一个有效的以 UTF-16 代码单元为单位的从零开始的偏移量。

将从零开始的偏移量转换为位置。

参数描述
offset: number

文档中从零开始的偏移量。此偏移量以 UTF-16 代码单元为单位。

返回描述
Position

一个有效的 Position

保存底层文件。

参数描述
返回描述
Thenable<boolean>

一个 promise,当文件保存成功时,将解析为 true。如果保存失败,将返回 false

确保一个位置包含在此文档的范围内。

参数描述
position: Position

一个位置。

返回描述
Position

给定的位置或一个新的、调整后的位置。

确保一个范围完全包含在此文档中。

参数描述
range: Range

一个范围。

返回描述
Range

给定的范围或一个新的、调整后的范围。

TextDocumentChangeEvent

描述事务性 文档 更改的事件。

属性

内容更改的数组。

受影响的文档。

文档被更改的原因。如果原因未知,则为 undefined

TextDocumentChangeReason

文本文档更改的原因。

枚举成员

文本更改是由撤销操作引起的。

文本更改是由重做操作引起的。

TextDocumentContentChangeEvent

描述 文档 文本中单个更改的事件。

属性

被替换的范围。

被替换范围的长度。

被替换范围的偏移量。

该范围的新文本。

TextDocumentContentProvider

文本文档内容提供程序允许向编辑器添加只读文档,例如来自 dll 的源代码或从 md 生成的 html。

内容提供程序是为 uri-scheme 注册的。当要加载具有该方案的 uri 时,会向内容提供程序发出请求。

事件

一个事件,用于表示资源已更改。

方法

为给定的 uri 提供文本内容。

编辑器将使用返回的字符串内容来创建一个只读的文档。当相应的文档关闭时,应释放已分配的资源。

注意:由于行尾序列的规范化,创建的 文档 的内容可能与提供的文本不完全相同。

参数描述
uri: Uri

一个 uri,其方案与此提供程序注册的方案匹配。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<string>

一个字符串或一个解析为此类字符串的 thenable。

TextDocumentSaveReason

表示文本文档被保存的原因。

枚举成员

手动触发,例如用户按保存、开始调试或通过 API 调用。

延迟后自动保存。

当编辑器失去焦点时。

TextDocumentShowOptions

表示用于配置在编辑器中显示文档行为的选项。

属性

一个可选标志,当为 true 时将阻止编辑器获取焦点。

一个可选标志,控制编辑器标签是否显示为预览。预览标签将被替换和重用,直到设置为保留——无论是显式设置还是通过编辑。

注意,如果用户在设置中禁用了预览编辑器,则该标志将被忽略。

一个可选的选择范围,用于在编辑器中应用于文档。

一个可选的视图列,用于显示编辑器。默认为活动列。不存在的列将根据需要创建,最多到ViewColumn.Nine。使用ViewColumn.Beside在当前活动编辑器的旁边打开编辑器。

TextDocumentWillSaveEvent

文档将要被保存时触发的事件。

要在文档保存前对其进行修改,请调用 waitUntil-函数,并传入一个解析为 文本编辑 数组的 thenable。

属性

将要被保存的文档。

触发保存的原因。

方法

允许暂停事件循环并应用保存前编辑。对此函数的后续调用的编辑将按顺序应用。如果文档发生并发修改,这些编辑将被忽略

注意:此函数只能在事件分发期间调用,不能以异步方式调用。

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: EndOfLine

一个行尾序列

返回描述
TextEdit

一个新的文本编辑对象。

构造函数

创建一个新的 TextEdit。

参数描述
range: Range

一个范围。

newText: string

一个字符串。

返回描述
TextEdit

属性

文档中使用的行尾序列。

注意,行尾序列将应用于整个文档。

此编辑将插入的字符串。

此编辑适用的范围。

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?: {keepWhitespace: boolean, 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

对命名图标的引用。目前,支持 FileFolderThemeIcon id。推荐使用主题图标而非自定义图标,因为它让产品主题作者可以更改图标。

注意,主题图标也可以在标签和描述中渲染。支持主题图标的地方会明确说明,并使用 $(<name>) 语法,例如 quickPick.label = "Hello World $(globe)"

静态

对表示文件的图标的引用。图标取自当前文件图标主题,或者使用占位符图标。

对表示文件夹的图标的引用。图标取自当前文件图标主题,或者使用占位符图标。

构造函数

创建对主题图标的引用。

参数描述
id: string
color?: ThemeColor

图标的可选 ThemeColor。该颜色目前仅在 TreeItem 中使用。

返回描述
ThemeIcon

属性

图标的可选 ThemeColor。该颜色目前仅在 TreeItem 中使用。

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 类型来支持所有类型的已拖放文件,无论文件的实际 mime 类型如何。

了解拖动项的 mime 类型

  1. 设置您的 DragAndDropController
  2. 使用 Developer: Set Log Level... 命令将级别设置为 "Debug"
  3. 打开开发人员工具,并将具有未知 mime 类型的项拖到您的树上。mime 类型将被记录到开发人员控制台中。

请注意,无法发送到扩展的 mime 类型将被省略。

方法

当用户开始从此 DragAndDropController 拖动项时,将调用 handleDrag。扩展可以使用 handleDrag 将其 DataTransferItem 项添加到拖放操作中。

handleDrag 中添加的 Mime 类型在应用程序外部不可用。

当这些项被拖放到**同一棵树**中的**另一个树项**上时,您的 DataTransferItem 对象将被保留。使用树的推荐 mime 类型 (application/vnd.code.tree.<treeidlowercase>) 来在数据传输中添加树对象。请参阅 DataTransferItem 的文档,了解如何最好地利用这一点。

要添加一个可以拖动到编辑器中的数据传输项,请使用应用程序特定的 mime 类型 "text/uri-list"。 "text/uri-list" 的数据应该是一个由 \r\n 分隔的、经过 toString() 处理的 Uris 字符串。要在文件中指定光标位置,请将 Uri 的片段设置为 L3,5,其中 3 是行号,5 是列号。

参数描述
source: readonly T[]

拖放操作的源项。

dataTransfer: DataTransfer

与此拖动关联的数据传输。

token: CancellationToken

一个取消令牌,指示拖动已取消。

返回描述
void | Thenable<void>

当拖放操作导致在此 DragAndDropController 所属的树上进行放置时调用。

对于任何需要刷新的元素,扩展应触发 onDidChangeTreeData

参数描述
target: T

放置发生的目标树元素。当为 undefined 时,目标是根。

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

选择树项时应执行的命令

当树项在编辑器中打开某些内容时,请使用 `vscode.open` 或 `vscode.diff` 作为命令 ID。使用这些命令可确保生成的编辑器与其它内置树打开编辑器的方式保持一致。

树项的上下文值。这可用于在树中贡献特定于项的操作。例如,一个树项被赋予一个上下文值 `folder`。当使用 `menus` 扩展点向 `view/item/context` 贡献操作时,您可以在 `when` 表达式中为键 `viewItem` 指定上下文值,如 `viewItem == folder`。

"contributes": {
  "menus": {
    "view/item/context": [
      {
        "command": "extension.deleteFolder",
        "when": "viewItem == folder"
      }
    ]
  }
}

这只会为 `contextValue` 为 `folder` 的项显示操作 `extension.deleteFolder`。

一个人类可读的字符串,其呈现不太突出。当为 `true` 时,它派生自 resourceUri;当为 `falsy` 时,不显示。

树项的图标路径或 ThemeIcon。当为 `falsy` 时,如果项是可折叠的,则分配 Folder Theme Icon,否则分配 File Theme Icon。当指定文件或文件夹 ThemeIcon 时,图标将使用 resourceUri(如果提供)从当前文件图标主题中为指定主题图标派生。

树项的可选 ID,在整个树中必须唯一。该 ID 用于保留树项的选择和展开状态。

如果未提供,则使用树项的标签生成 ID。**请注意**,当标签更改时,ID 也会更改,选择和展开状态将无法保持稳定。

描述此项的人类可读字符串。当为 `falsy` 时,它派生自 resourceUri

表示此项的资源的Uri

当未提供标签时,将用于派生它。当iconPath具有ThemeIcon值时,将用于从当前文件图标主题派生图标。

当您悬停在此项上时显示的工具提示文本。

TreeItemCheckboxState

树项的复选框状态

枚举成员

确定一个项目未被选中

确定一个项目被选中

TreeItemCollapsibleState

树项的可折叠状态

枚举成员

确定一个项既不能折叠也不能展开。意味着它没有子项。

确定一个项目是折叠的。

确定一个项目是展开的。

TreeItemLabel

描述树项的标签

属性

标签中要高亮的范围。范围被定义为两个数字的元组,其中第一个是包含的起始索引,第二个是排除的结束索引

描述树项的人类可读字符串。

TreeView<T>

表示一个树视图

事件

一个事件,用于表示某个元素或根已被选中或取消选中。

选择发生变化时触发的事件

可见性发生变化时触发的事件

当一个元素被折叠时触发的事件

当一个元素被展开时触发的事件

属性

要为此 TreeView 显示的徽章。要移除徽章,请设置为 undefined。

一个可选的、人类可读的描述,在视图标题中以不太突出的方式呈现。将标题描述设置为 null、undefined 或空字符串将从视图中移除该描述。

一个可选的、人类可读的消息,将会在视图中呈现。将消息设置为 null、undefined 或空字符串将从视图中移除该消息。

当前选中的元素。

树视图的标题最初取自扩展的 package.json 文件。对 title 属性的更改将正确反映在视图标题的 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[]>

一个定义或一个解析为此类定义的 thenable。可以通过返回 undefinednull 来表示没有结果。

TypeHierarchyItem

表示类型层次结构中的一个项,如类或接口。

构造函数

创建一个新的类型层次结构项。

参数描述
kind: SymbolKind

项目的类型。

name: string

项目的名称。

detail: string

项目的详细信息。

uri: Uri

项目的 Uri。

range: Range

项目的整个范围。

selectionRange: Range

项目的选择范围。

返回描述
TypeHierarchyItem

属性

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

此项的类型。

此项的名称。

包围此符号的范围,不包括前导/尾随空格,但包括其他所有内容,例如注释和代码。

当选中此符号时应选择并显示的范围,例如类的名称。必须包含在 range 属性内。

此项的标签。

此项的资源标识符。

TypeHierarchyProvider

类型层次结构提供程序接口描述了扩展和类型层次结构功能之间的契约。

方法

通过返回由给定文档和位置表示的项来引导类型层次结构。此项将用作类型图的入口。当给定位置没有项时,提供程序应返回 `undefined` 或 `null`。

参数描述
document: TextDocument

调用命令的文档。

position: Position

调用命令的位置。

token: CancellationToken

一个取消令牌。

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

一个或多个类型层次结构项或一个解析为这些项的 thenable。可以通过返回 `undefined`、`null` 或空数组来表示没有结果。

提供一个项的所有子类型,例如,所有从给定项派生/继承的类型。在图论中,这描述了类型图内部的有向和带注释的边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: TypeHierarchyItem

应为其计算子类型的层次结构项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<TypeHierarchyItem[]>

一组直接子类型或一个解析为这些子类型的 thenable。可以通过返回 `undefined` 或 `null` 来表示没有结果。

提供一个项的所有超类型,例如,一个类型从中派生/继承的所有类型。在图论中,这描述了类型图内部的有向和带注释的边,例如,给定项是起始节点,结果是可以到达的节点。

参数描述
item: TypeHierarchyItem

应为其计算超类型的层次结构项。

token: CancellationToken

一个取消令牌。

返回描述
ProviderResult<TypeHierarchyItem[]>

一组直接超类型或一个解析为此类超类型的 thenable。可以通过返回 `undefined` 或 `null` 来表示没有结果。

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/path`、`file:///usr/home` 或 `scheme:with/path`。

注意,有一段时间接受没有`scheme`的 uris。这是不正确的,因为所有 uris 都应该有一个 scheme。为了避免破坏现有代码,添加了可选的 `strict` 参数。我们强烈建议使用它,例如 `Uri.parse('my:uri', true)`

另见 Uri.toString

参数描述
value: string

Uri 的字符串值。

strict?: boolean

当 `value` 为空或无法解析 `scheme` 时抛出错误。

返回描述
Uri

一个新的 Uri 实例。

构造函数

使用 `file` 和 `parse` 工厂函数创建新的 `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-uris 可能是意想不到的。由于稳定性原因,这一点无法再更改。如果您因编码过于激进而遇到问题,应使用 `skipEncoding` 参数:`uri.toString(true)`。

参数描述
skipEncoding?: boolean

不对结果进行百分比编码,默认为 `false`。请注意,路径中出现的 `#` 和 `?` 字符将始终被编码。

返回描述
字符串

此 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 处理程序负责处理系统范围的 uris

另见 window.registerUriHandler

方法

处理提供的系统范围的 Uri

另见 window.registerUriHandler

参数描述
uri: Uri
返回描述
ProviderResult<void>

ViewBadge

为视图呈现一个值的徽章

属性

在徽章的工具提示中呈现的标签。

要在徽章中呈现的值。

ViewColumn

表示编辑器在窗口中的位置。编辑器可以排列在网格中,每一列代表网格中的一个编辑器位置,按其出现顺序计算编辑器。

枚举成员

一个*符号性的*编辑器列,代表活动列旁边的一列。该值可以在打开编辑器时使用,但编辑器的*解析后*的 viewColumn 值将始终是 `One`、`Two`、`Three` 等,或 `undefined`,但绝不会是 `Beside`。

一个*符号性的*编辑器列,代表当前活动的列。此值可以在打开编辑器时使用,但编辑器的*解析后*的 viewColumn 值将始终是 `One`、`Two`、`Three` 等,或 `undefined`,但绝不会是 `Active`。

第一个编辑器列。

第二个编辑器列。

第三个编辑器列。

第四个编辑器列。

第五个编辑器列。

第六个编辑器列。

第七个编辑器列。

第八个编辑器列。

第九个编辑器列。

Webview

显示 HTML 内容,类似于 iframe。

事件

当 webview 内容发布消息时触发。

Webview 内容可以向扩展程序发回字符串或 JSON 可序列化对象。它们不能发布 `Blob`、`File`、`ImageData` 和其他 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:` uris 直接从工作区或本地文件系统加载资源。`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 序列化的对象。

对于旧版本的 vscode,如果 `message` 中包含 `ArrayBuffer`,它将不会被正确序列化,也不会被 webview 接收。同样,任何 TypedArray,如 `Uint8Array`,序列化效率非常低,并且在 webview 内部也不会被重新创建为类型化数组。

但是,如果您的扩展在其 `package.json` 的 `engines` 字段中指定 vscode 1.57+,那么 `message` 中出现的任何 `ArrayBuffer` 值都将更有效地传输到 webview,并且在 webview 内部也会被正确地重新创建。

返回描述
Thenable<boolean>

一个 promise,当消息发布到 webview 或因消息无法传递而被丢弃时解析。

如果消息已发布到 webview,则返回 `true`。消息只能发布到活动的 webview(即可见的 webview 或设置了 `retainContextWhenHidden` 的隐藏 webview)。

`true` 的响应并不意味着消息已被 webview 实际接收。例如,webview 内部可能没有连接任何消息侦听器,或者在消息发布后但在接收前 webview 可能已被销毁。

如果您想确认消息是否已实际收到,可以尝试让您的 webview 向您的扩展发回一个确认消息。

WebviewOptions

webview 的内容设置。

属性

控制 webview 内容中是否启用命令 uris。

默认为 `false`(命令 uris 被禁用)。

如果你传入一个数组,只有数组中的命令被允许。

控制 webview 内容中是否启用表单。

如果启用了脚本,则默认为 true。否则默认为 false。明确将此属性设置为 true 或 false 会覆盖默认值。

控制 webview 内容中是否启用脚本。

默认为 false(脚本禁用)。

webview 可以使用 `asWebviewUri` 中的 uris 加载本地(文件系统)资源的根路径

默认为当前工作区的根文件夹加上扩展的安装目录。

传入一个空数组以禁止访问任何本地资源。

webview 内部使用的 localhost 端口映射。

端口映射允许 webview 透明地定义 localhost 端口的解析方式。这可以用于允许在 webview 内部使用一个静态的 localhost 端口,该端口被解析为一个服务正在运行的随机端口。

如果 webview 访问 localhost 内容,我们建议您指定端口映射,即使 `webviewPort` 和 `extensionHostPort` 端口相同。

请注意,端口映射仅适用于 `http` 或 `https` url。Websocket url(例如 `ws://: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 内部调用 acquireVsCodeApi().setState() 并传入任何可 json 序列化的对象。要再次恢复状态,请调用 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 而不是 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)

  • throws - 更新时出错
    • 未注册的配置。
    • 窗口配置到工作区文件夹
    • 当没有打开工作区时,配置到工作区或工作区文件夹。
    • 当没有工作区文件夹设置时,配置到工作区文件夹。
    • 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-参数应以宽松的方式解释,因为编辑器将对结果应用自己的高亮和评分。一个好的经验法则是进行不区分大小写的匹配,并简单地检查查询的字符是否按顺序出现在候选符号中。不要使用前缀、子字符串或类似的严格匹配。

为了提高性能,实现者可以实现 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>

取消令牌

操作通常在易变的状态上启动,这些状态在操作完成之前就会发生变化。例如,开始计算智能感知,而用户继续输入,使得该操作的结果变得过时。

暴露于此类行为的 API 将被传递一个 CancellationToken,您可以在其上检查是否已取消 (isCancellationRequested) 或在取消发生时得到通知 (onCancellationRequested)。取消令牌通常是函数调用的最后一个参数,并且是可选的。

可释放对象 (Disposables)

VS Code API 对从 VS Code 获取的资源使用释放模式。这适用于事件监听、命令、与 UI 交互以及各种语言贡献。

例如,setStatusBarMessage(value: string) 函数返回一个 Disposable,调用其 dispose 方法后会再次移除该消息。

事件

VS Code API 中的事件以函数形式公开,您可以使用监听器函数调用它们以进行订阅。订阅调用返回一个 Disposable,在释放时会移除事件监听器。

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 检查

© . This site is unofficial and not affiliated with Microsoft.