VS Code API

一个事件，当认证提供程序的认证会话被添加、删除或更改时触发。

获取用户登录的指定提供者的所有账户。 与getSession一起使用，以获取特定账户的认证会话。

目前，只有两个认证提供者是来自编辑器内置扩展的，它们实现了GitHub和Microsoft认证：它们的providerId分别是'github'和'microsoft'。

Note: Getting accounts does not imply that your extension has access to that account or its authentication sessions. You can verify access to the account by calling getSession.

Get an authentication session matching the desired scopes or satisfying the WWW-Authenticate request. Rejects if a provider with providerId is not registered, or if the user does not consent to sharing authentication information with the extension. If there are multiple sessions with the same scopes, the user will be shown a quickpick to select which account they would like to use.

Built-in auth providers include:

• 'github' - For GitHub.com
• 'microsoft' For both personal & organizational Microsoft accounts
• (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
• (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds

Get an authentication session matching the desired scopes or request. Rejects if a provider with providerId is not registered, or if the user does not consent to sharing authentication information with the extension. If there are multiple sessions with the same scopes, the user will be shown a quickpick to select which account they would like to use.

Built-in auth providers include:

• 'github' - For GitHub.com
• 'microsoft' For both personal & organizational Microsoft accounts
• (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
• (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds

获取一个匹配所需范围或请求的认证会话。如果未注册具有 providerId 的提供者，或用户不 consent 共享认证信息给扩展，则拒绝。如果有多于一个具有相同范围的会话，将显示快速选择，让用户选择他们希望使用的帐户。

Built-in auth providers include:

• 'github' - For GitHub.com
• 'microsoft' For both personal & organizational Microsoft accounts
• (less common) 'github-enterprise' - for alternative GitHub hostings, GHE.com, GitHub Enterprise Server
• (less common) 'microsoft-sovereign-cloud' - for alternative Microsoft clouds

注册一个认证提供者。

每个id只能有一个提供者，并且当id已被另一个提供者使用时，会抛出一个错误。id是区分大小写的。

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

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

• 注释 1: 当执行编辑器命令时，并非所有类型都可以作为参数传递。允许的类型是基本类型字符串，布尔， 数字，未定义，和无，以及位置、范围、Uri和位置。
• 注释 2： 在执行由扩展贡献的命令时没有限制。

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

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

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

Registers a text editor command that can be invoked via a keyboard shortcut, a menu item, an action, or directly.

Text editor commands are different from ordinary commands as they only execute when there is an active editor when the command is called. Also, the command handler of an editor command has access to the active editor and to an edit-builder. Note that the edit-builder is only valid while the callback executes.

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

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

当前活动的调试会话或未定义. 活动调试会话是通过调试操作浮动Windows表示的会话，或者当前显示在调试操作浮动Windows的下拉菜单中。 如果没有活动的调试会话，则该值为未定义输入：.

当前聚焦的线程或堆栈框架，或未定义如果没有任何线程或堆栈聚焦。线程可以在任何时候有活动的调试会话时聚焦，而堆栈帧只能在会话暂停并且已检索到调用堆栈时聚焦。

断点列表。

一个事件，当活动调试会话 改变时触发。注意，该事件也会在活动调试会话更改为未定义输入：.

一个在debug.activeStackItem改变时触发的事件。

一个事件，当断点集被添加、移除或更改时发出。

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

一个事件，当一个新的调试会话开始时触发。

一个事件，当调试会话终止时触发。

添加断点。

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

如果“Source”描述符提供的信息不足以创建Uri，则会抛出错误。

Register a debug adapter descriptor factory for a specific debug type. An extension is only allowed to register a DebugAdapterDescriptorFactory for the debug type(s) defined by the extension. Otherwise an error is thrown. Registering more than one DebugAdapterDescriptorFactory for a debug type results in an error.

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

注册一个特定调试类型的调试配置提供者。 这个可选的触发类型可以用来指定提供调试配置提供者的方法被触发。 目前有两种触发方式：使用值初始（或者如果没有触发类型参数）的提供调试配置方法用于提供初始调试配置，这些配置将被复制到新创建的launch.json中。 使用触发类型动态的提供调试配置 method is used to dynamically determine debug configurations to be presented to the user (in addition to the static configurations from the launch.json). Please note that the triggerKind argument only applies to the provideDebugConfigurations method: so the resolveDebugConfiguration methods are not affected at all. Registering a single provider with resolve methods for different trigger kinds, results in the same resolve methods called multiple times. More than one provider can be registered for the same type.

移除断点。

Start debugging by using either a named launch or named compound configuration, or by directly passing a DebugConfiguration. The named configurations are looked up in '.vscode/launch.json' found in the given folder. Before debugging starts, all unsaved files are saved and the launch configurations are brought up-to-date. Folder specific variables used in the configuration (e.g. '${workspaceFolder}') are resolved against the given folder.

停止指定的调试会话或如果未指定会话，则停止所有调试会话。

应用程序托管的位置 在桌面端，这是“desktop” 在网页端，这是指定的嵌入者，即“github.dev”、“codespaces”或“web”，如果嵌入者 不提供该信息

编辑器的名称，例如 'VS Code'。

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

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

系统剪贴板。

表示这是该应用程序的新安装。 真如果在安装的第一天内，否则假的输入：.

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

代表首选用户语言，例如德语-瑞士，输入：fr，或英语-美国输入：.

当前编辑器的日志级别。

计算机的唯一标识符。

一个远程的名称。由扩展定义，流行的示例是适用于 Linux 的 Windows 子系统适用于 Linux 的 Windows 子系统或ssh-远程对于使用安全外壳的遥控器。

注意该值是未定义 当没有远程扩展主机，但在所有扩展主机（本地和远程）中定义了该值的情况下使用。如果存在远程扩展主机，则所有扩展主机都定义该值。使用 Extension.extensionKind 来判断特定扩展是否在远程运行或不运行。

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

检测到的扩展主机的默认 shell，这被覆盖 终端.集成.默认配置文件扩展主机平台的设置。请注意，在不支持 shell 的环境中，该值为空字符串。

UI种类属性表示从哪个UI扩展进行访问。例如，扩展可以从桌面应用程序或网页浏览器中访问。

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

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

一个事件，当默认外壳更改时触发。此事件会传递新的外壳路径。

一个事件，当用户启用或禁用遥测时触发。 真如果用户已启用遥测或假的如果用户已禁用遥测。

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

对不起，我无法处理包含http链接的文本。如果你能提供具体的文本内容，我可以帮你翻译。或对不起，我无法访问特定的网页链接。如果你能提供网页上的具体文本，我可以帮你翻译。计划

解析一个外部uri，例如一个对不起，我无法处理包含http链接的文本。如果你能提供具体的文本内容，我可以帮你翻译。或对不起，我无法访问特定的网页链接。如果你能提供网页上的具体文本，我可以帮你翻译。 link, from where the extension is running to a uri to the same resource on the client machine.

This is a no-op if the extension is running on the client machine.

If the extension is running remotely, this function automatically establishes a port forwarding tunnel from the local machine to target on the remote and returns a local uri to the tunnel. The lifetime of the port forwarding tunnel is managed by the editor and the tunnel can be closed by the user.

Note that uris passed through openExternal are automatically resolved and you should not call asExternalUri on them.

vscode.env.uriScheme

Creates a uri that - if opened in a browser (e.g. via openExternal) - will result in a registered UriHandler to trigger.

Extensions should not make any assumptions about the resulting uri and should not alter it in any way. Rather, extensions can e.g. use this uri in an authentication flow, by adding the uri as callback query argument to the server to authenticate to.

Note that if the server decides to add additional query parameters to the uri (e.g. a token or secret), it will appear in the uri that is passed to the UriHandler.

Example of an authentication flow:

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);

Note that extensions should not cache the result of asExternalUri as the resolved uri may become invalid due to a system or user action — for example, in remote cases, a user may close a port forwarding tunnel that was opened by asExternalUri.

Any other scheme

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

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

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

• 一个浏览器 (对不起，我无法处理包含http链接的文本。如果你能提供具体的文本内容，我可以帮你翻译。，对不起，我无法访问特定的网页链接。如果你能提供网页上的具体文本，我可以帮你翻译。)
• 一个邮件客户端 (mailto:)
• VSCode本身 (vscode:从vscode.env.uriScheme)

注意，showTextDocument是正确在编辑器内打开文本文件的方法，而不是这个函数。

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

一个在...触发的事件扩展.全部更改。这可能发生在安装、卸载、启用或禁用扩展时。

通过其完整的标识符获取扩展名，格式如下：出版商名称输入：.

已加载到扩展的本地化字符串包。 如果未加载任何包，则该包未定义。通常情况下，如果没有找到包或者我们使用默认语言运行时，不会加载包。

已加载到扩展的本地化包的URI。 如果未加载任何包，则未定义。通常情况下，如果没有找到包或我们在使用默认语言时，不会加载包。

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

Example

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

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

示例

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

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

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

创建诊断收集。

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

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

获取所有诊断。

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

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

比赛根据以下规则进行计算：

1. 当DocumentSelector是一个数组时，为其中的每个元素计算匹配文档过滤器 or language identifier and take the maximum value.
2. A string will be desugared to become the language-part of a DocumentFilter, so "fooLang" is like { language: "fooLang" }.
3. A DocumentFilter will be matched against the document by comparing its parts with the document. The following rules apply:
   1. When the DocumentFilter is empty ({}) the result is 0
   2. When scheme, language, pattern, or notebook are defined but one doesn't match, the result is 0
   3. Matching against * gives a score of 5, matching via equality or via a glob-pattern gives a score of 10
   4. The result is the maximum value of each match

Samples:

// 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: '*' }, 文档); // 5

注册调用层次结构提供者。

注册代码行动提供者。

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

注册代码透镜提供者。

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

Register a color provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a completion provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and groups of equal score are sequentially asked for completion items. The process stops when one or many providers of a group return a result. A failing provider (rejected promise or exception) will not fail the whole operation.

A completion item provider can be associated with a set of triggerCharacters. When trigger characters are being typed, completions are requested but only from providers that registered the typed character. Because of that trigger characters should be different than word characters, a common trigger character is . to trigger member completions.

Register a declaration provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a definition provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Registers a new DocumentDropEditProvider.

Multiple drop providers can be registered for a language. When dropping content into an editor, all registered providers for the editor's language will be invoked based on the mimetypes they handle as specified by their DocumentDropEditProviderMetadata.

Each provider can return one or more DocumentDropEdits. The edits are sorted using the DocumentDropEdit.yieldTo property. By default the first edit will be applied. If there are any additional edits, these will be shown to the user as selectable drop options in the drop widget.

Register a formatting provider for a document.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a document highlight provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and groups sequentially asked for document highlights. The process stops when a provider returns a non-falsy or non-failure result.

Register a document link provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Registers a new DocumentPasteEditProvider.

Multiple providers can be registered for a language. All registered providers for a language will be invoked for copy and paste operations based on their handled mimetypes as specified by the DocumentPasteProviderMetadata.

For copy operations, changes to the DataTransfer made by each provider will be merged into a single DataTransfer that is used to populate the clipboard.

For [DocumentPasteEditProvider.providerDocumentPasteEdits paste operations](#_DocumentPasteEditProvider.providerDocumentPasteEdits paste operations), each provider will be invoked and can return one or more DocumentPasteEdits. The edits are sorted using the DocumentPasteEdit.yieldTo property. By default the first edit will be applied and the rest of the edits will be shown to the user as selectable paste options in the paste widget.

Register a formatting provider for a document range.

Note: A document range provider is also a document formatter which means there is no need to register a document formatter when also registering a range provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a semantic tokens provider for a document range.

Note: If a document has both a DocumentSemanticTokensProvider and a DocumentRangeSemanticTokensProvider, the range provider will be invoked only initially, for the time in which the full document provider takes to resolve the first request. Once the full document provider resolves the first request, the semantic tokens provided via the range provider will be discarded and from that point forward, only the document provider will be used.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a semantic tokens provider for a whole document.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider is used. Failure of the selected provider will cause a failure of the whole operation.

Register a document symbol provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a provider that locates evaluatable expressions in text documents. The editor will evaluate the expression in the active debug session and will show the result in the debug hover.

If multiple providers are registered for a language an arbitrary provider will be used.

Register a folding range provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. If multiple folding ranges start at the same position, only the range of the first registered provider is used. If a folding range overlaps with an other range that has a smaller position, it is also ignored.

A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a hover provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register an implementation provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a inlay hints provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Registers an inline completion provider.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a provider that returns data for the debugger's 'inline value' feature. Whenever the generic debugger has stopped in a source file, providers registered for the language of the file are called to return textual data that will be shown in the editor at the end of lines.

Multiple providers can be registered for a language. In that case providers are asked in parallel and the results are merged. A failing provider (rejected promise or exception) will not cause a failure of the whole operation.

Register a linked editing range provider.

Multiple providers can be registered for a language. In that case providers are sorted by their score and the best-matching provider that has a result is used. Failure of the selected provider will cause a failure of the whole operation.