内置命令

本文档列出了您可以与 API 一起使用的 Visual Studio Code 命令的子集vscode.commands.executeCommand。

请阅读命令指南，了解如何使用命令 API。

以下是如何在 VS Code 中打开新文件夹的示例：

let uri = Uri.file('/some/path/to/folder');
let success = await commands.executeCommand('vscode.openFolder', uri);

注意：您可以通过键盘快捷键编辑器“文件” > “首选项” > “键盘快捷键”查看完整的 VS Code 命令集。键盘快捷键编辑器列出了 VS Code 中内置的或由扩展提供的所有命令，以及它们的键绑定和可见性 when 子句。

命令

vscode.executeDataToNotebook- 调用笔记本序列化器

notebookType - 笔记本类型
data - 要转换为数据的字节
（返回） - 笔记本数据

vscode.executeNotebookToData- 调用笔记本序列化器

notebookType - 笔记本类型
NotebookData - 要转换为字节的笔记本数据
（返回） - 字节

notebook.selectKernel- 触发指定笔记本编辑器小部件的内核选择器

options - 选择内核选项
(返回) - 没有结果

interactive.open- 打开交互窗口并返回笔记本编辑器并输入 URI

showOptions - 显示选项
资源- 交互式资源 Uri
controllerId - 笔记本控制器 ID
title - 交互式编辑器标题
(返回) - 笔记本和输入 URI

vscode.editorChat.start- 调用新的编辑器聊天会话

运行参数-
(返回) - 没有结果

vscode.executeDocumentHighlights- 执行文档突出显示提供程序。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 DocumentHighlight 实例数组的承诺。

vscode.executeDocumentSymbolProvider- 执行文档符号提供程序。

uri - 文本文档的 URI
（返回） - 解析为 SymbolInformation 和 DocumentSymbol 实例数组的 Promise。

vscode.executeFormatDocumentProvider- 执行文档格式提供程序。

uri - 文本文档的 URI
选项- 格式选项
（返回） - 解析为 TextEdit 数组的承诺。

vscode.executeFormatRangeProvider- 执行范围格式提供程序。

uri - 文本文档的 URI
range - 文本文档中的范围
选项- 格式选项
（返回） - 解析为 TextEdit 数组的承诺。

vscode.executeFormatOnTypeProvider- 在类型提供者上执行格式。

uri - 文本文档的 URI
位置- 文本文档中的位置
ch - 触发字符
选项- 格式选项
（返回） - 解析为 TextEdit 数组的承诺。

vscode.executeDefinitionProvider- 执行所有定义提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 Location 或 LocationLink 实例数组的承诺。

vscode.executeTypeDefinitionProvider- 执行所有类型定义提供程序。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 Location 或 LocationLink 实例数组的承诺。

vscode.executeDeclarationProvider- 执行所有声明提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 Location 或 LocationLink 实例数组的承诺。

vscode.executeImplementationProvider- 执行所有实施提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 Location 或 LocationLink 实例数组的承诺。

vscode.executeReferenceProvider- 执行所有参考提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为位置实例数组的承诺。

vscode.executeHoverProvider- 执行所有悬停提供程序。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为悬停实例数组的承诺。

vscode.executeSelectionRangeProvider- 执行选择范围提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为一系列范围的承诺。

vscode.executeWorkspaceSymbolProvider- 执行所有工作区符号提供程序。

查询- 搜索字符串
（返回） - 解析为 SymbolInformation 实例数组的 Promise。

vscode.prepareCallHierarchy- 在文档内的某个位置准备调用层次结构

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 CallHierarchyItem 实例数组的承诺

vscode.provideIncomingCalls- 计算某个项目的来电

item - 调用层次结构项
（返回） - 解析为 CallHierarchyIncomingCall 实例数组的承诺

vscode.provideOutgoingCalls- 计算某个项目的拨出呼叫

item - 调用层次结构项
（返回） - 解析为 CallHierarchyOutgoingCall 实例数组的承诺

vscode.prepareRename- 执行重命名提供者的prepareRename。

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为范围和占位符文本的承诺。

vscode.executeDocumentRenameProvider- 执行重命名提供商。

uri - 文本文档的 URI
位置- 文本文档中的位置
newName - 新交易品种名称
（返回） - 解析为 WorkspaceEdit 的承诺。

vscode.executeLinkProvider- 执行文档链接提供程序。

uri - 文本文档的 URI
linkResolveCount - （可选）仅当链接未解析时应解析的链接数。
（返回） - 解析为 DocumentLink 实例数组的承诺。

vscode.provideDocumentSemanticTokensLegend- 为文档提供语义标记图例

uri - 文本文档的 URI
（返回） - 解析为 SemanticTokensLegend 的承诺。

vscode.provideDocumentSemanticTokens- 为文档提供语义标记

uri - 文本文档的 URI
（返回） - 解析为 SemanticTokens 的承诺。

vscode.provideDocumentRangeSemanticTokensLegend- 为文档范围提供语义标记图例

uri - 文本文档的 URI
range - （可选）文本文档中的范围
（返回） - 解析为 SemanticTokensLegend 的承诺。

vscode.provideDocumentRangeSemanticTokens- 为文档范围提供语义标记

uri - 文本文档的 URI
range - 文本文档中的范围
（返回） - 解析为 SemanticTokens 的承诺。

vscode.executeCompletionItemProvider- 执行完成项目提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
triggerCharacter - （可选）当用户键入字符时触发完成，例如,或(
itemResolveCount - （可选）要解决的完成数（数字太大会减慢完成速度）
（返回） - 解析为 CompletionList 实例的承诺。

vscode.executeSignatureHelpProvider- 执行签名帮助提供者。

uri - 文本文档的 URI
位置- 文本文档中的位置
triggerCharacter -（可选）当用户键入字符时触发签名帮助，例如,或(
（返回） - 解析为 SignatureHelp 的承诺。

vscode.executeCodeLensProvider- 执行代码镜头提供者。

uri - 文本文档的 URI
itemResolveCount -（可选）应解析和返回的镜头数量。只会返回解析镜头，会影响性能
（返回） - 解析为 CodeLens 实例数组的承诺。

vscode.executeCodeActionProvider- 执行代码操作提供者。

uri - 文本文档的 URI
rangeOrSelection - 文本文档中的范围。某些重构提供程序需要 Selection 对象。
kind - （可选）返回代码操作的代码操作类型
itemResolveCount - （可选）要解析的代码操作数（数字太大会减慢代码操作速度）
（返回） - 解析为命令实例数组的承诺。

vscode.executeDocumentColorProvider- 执行文档颜色提供程序。

uri - 文本文档的 URI
（返回） - 解析为 ColorInformation 对象数组的承诺。

vscode.executeColorPresentationProvider- 执行颜色呈现提供程序。

color - 要显示和插入的颜色
context - 具有 uri 和范围的上下文对象
（返回） - 解析为 ColorPresentation 对象数组的承诺。

vscode.executeInlayHintProvider- 执行嵌入提示提供程序

uri - 文本文档的 URI
range - 文本文档中的范围
（返回） - 解析为 Inlay 对象数组的 Promise

vscode.executeFoldingRangeProvider- 执行折叠范围提供者

uri - 文本文档的 URI
（返回） - 解析为 FoldingRange 对象数组的承诺

vscode.resolveNotebookContentProviders- 解决笔记本内容提供商

（返回） - 解析为 NotebookContentProvider 静态信息对象数组的承诺。

vscode.executeInlineValueProvider- 执行内联值提供者

uri - 文本文档的 URI
range - 文本文档中的范围
context - InlineValueContext
（返回） - 解析为 InlineValue 对象数组的 Promise

vscode.open- 在编辑器中打开提供的资源。

乌里-

vscode.openWith- 使用特定编辑器打开提供的资源。

资源- 要打开的资源
viewId - 自定义编辑器视图 ID 或“默认”以使用 VS Code 的默认编辑器
columnOrOptions - （可选）要在其中打开的列或编辑器选项，请参阅 vscode.TextDocumentShowOptions
(返回) - 没有结果

vscode.diff- 在差异编辑器中打开提供的资源以比较其内容。

left - diff 编辑器的左侧资源
right - diff 编辑器的右侧资源
title - 差异编辑器的人类可读标题

vscode.prepareTypeHierarchy- 在文档内的某个位置准备类型层次结构

uri - 文本文档的 URI
位置- 文本文档中的位置
（返回） - 解析为 TypeHierarchyItem 实例数组的承诺

vscode.provideSupertypes- 计算项目的超类型

item - 类型层次结构项
（返回） - 解析为 TypeHierarchyItem 实例数组的承诺

vscode.provideSubtypes- 计算项目的子类型

item - 类型层次结构项
（返回） - 解析为 TypeHierarchyItem 实例数组的承诺

vscode.revealTestInExplorer- 在资源管理器中显示测试实例

testItem - VS Code 测试项。
(返回) - 没有结果

setContext- 设置可在when 子句中使用的自定义上下文键值。

name - 上下文键名称
value - 上下文键值
(返回) - 没有结果

vscode.executeMappedEditsProvider- 执行映射编辑提供程序

uri - 文本文档的 URI
string_array - 字符串数组，
MappedEditsContext - 映射编辑上下文
（返回） - 解析为工作区编辑或 null 的承诺

cursorMove- 将光标移动到视图中的逻辑位置

光标移动参数对象- 可以通过此参数传递的属性值对：

'to'：强制逻辑位置值，提供光标移动的位置。

'left', 'right', 'up', 'down', 'prevBlankLine', 'nextBlankLine',
'wrappedLineStart', 'wrappedLineEnd', 'wrappedLineColumnCenter'
'wrappedLineFirstNonWhitespaceCharacter', 'wrappedLineLastNonWhitespaceCharacter'
'viewPortTop', 'viewPortCenter', 'viewPortBottom', 'viewPortIfOutside'

'by'：要移动的单位。默认值是根据“to”值计算的。
```
'line', 'wrappedLine', 'character', 'halfLine'
```
'value'：要移动的单位数。默认值为“1”。
'select'：如果'true'则进行选择。默认为“假”。

editorScroll- 沿给定方向滚动编辑器

编辑器滚动参数对象- 可以通过此参数传递的属性值对：
- 'to'：强制方向值。
```
'up', 'down'
```
- 'by'：要移动的单位。默认值是根据“to”值计算的。
```
'line', 'wrappedLine', 'page', 'halfPage', 'editor'
```
- 'value'：要移动的单位数。默认值为“1”。
- 'revealCursor'：如果为'true'，则显示光标（如果它位于视口之外）。

revealLine- 在给定的逻辑位置显示给定的行

显示行参数对象- 可以通过此参数传递的属性值对：
- 'lineNumber'：强制行号值。
- 'at'：必须显示该行的逻辑位置。
```
'top', 'center', 'bottom'
```

editor.unfold- 在编辑器中展开内容

展开编辑器参数- 可以通过此参数传递的属性值对：
- 'levels'：要展开的级别数。如果未设置，则默认为 1。
- 'direction'：如果为'up'，则向上展开给定数量的级别，否则向下展开。
- 'selectionLines'：要应用展开操作的编辑器选择的起始行（从 0 开始）的数组。如果未设置，将使用活动选择。

editor.fold- 折叠编辑器中的内容

折叠编辑器参数- 可以通过此参数传递的属性值对：
- 'levels'：要折叠的层数。
- 'direction'：如果为'up'，则向上折叠给定数量的级别，否则向下折叠。
- 'selectionLines'：要应用折叠操作的编辑器选择的起始行（从 0 开始）的数组。如果未设置，将使用活动选择。如果未设置级别或方向，则在相应位置折叠区域，或者如果已经折叠，则折叠第一个未折叠的父级。

editor.actions.findWithArgs- 打开一个新的编辑器内查找小部件。

打开一个新的编辑器内查找小部件参数-

editor.action.goToLocations- 从文件中的位置转到位置

uri - 开始的文本文档
位置- 开始的位置
位置- 位置数组。
multiple - 定义当有多个结果时要执行的操作，可以是peek、gotoAndPeek或 `goto
noResultsMessage - 当位置为空时显示的人类可读消息。

editor.action.peekLocations- 从文件中的某个位置查看位置

uri - 开始的文本文档
位置- 开始的位置
位置- 位置数组。
multiple - 定义当有多个结果时要执行的操作，可以是peek、gotoAndPeek或 `goto

workbench.action.quickOpen- 快速访问

前缀-

notebook.cell.toggleOutputs- 切换输出

options - 单元格范围选项

notebook.fold- 折叠细胞

index - 单元格索引

notebook.unfold- 展开单元格

index - 单元格索引

notebook.selectKernel- 笔记本内核参数

kernelInfo - 内核信息

notebook.cell.changeLanguage- 更改单元语言

range - 单元格范围
语言- 目标细胞语言

notebook.execute- 运行全部

uri - 文档 uri

notebook.cell.execute- 执行单元

options - 单元格范围选项

notebook.cell.executeAndFocusContainer- 执行单元和焦点容器

options - 单元格范围选项

notebook.cell.cancelExecution- 停止单元执行

options - 单元格范围选项

workbench.action.findInFiles- 打开工作区搜索

一组搜索选项-

_interactive.open- 打开互动窗口

showOptions - 显示选项
资源- 交互式资源 Uri
controllerId - 笔记本控制器 ID
title - 笔记本编辑器标题

interactive.execute- 执行输入框的内容

资源- 交互式资源 Uri

search.action.openNewEditor- 打开新的搜索编辑器。传递的参数可以包括 ${relativeFileDirname} 等变量。

打开新的搜索编辑器参数-

search.action.openEditor- 打开新的搜索编辑器。传递的参数可以包括 ${relativeFileDirname} 等变量。

打开新的搜索编辑器参数-

search.action.openNewEditorToSide- 打开新的搜索编辑器。传递的参数可以包括 ${relativeFileDirname} 等变量。

打开新的搜索编辑器参数-

vscode.openFolder- 根据 newWindow 参数在当前窗口或新窗口中打开文件夹或工作区。请注意，在同一窗口中打开将关闭当前扩展主机进程并在给定文件夹/工作空间上启动一个新进程，除非 newWindow 参数设置为 true。

uri -（可选）要打开的文件夹或工作区文件的 URI。如果未提供，本机对话框将询问用户该文件夹
选项-（可选）选项。具有以下属性的对象：forceNewWindow：是否在新窗口中打开文件夹/工作区或相同。默认在同一窗口中打开。forceReuseWindow：是否在同一窗口中强制打开文件夹/工作区。默认为 false。noRecentEntry：打开的 URI 是否出现在“最近打开”列表中。默认为 false。请注意，为了向后兼容，选项也可以是布尔类型，表示forceNewWindow设置。

vscode.newWindow- 根据 newWindow 参数打开一个新窗口。

选项-（可选）选项。对象具有以下属性：reuseWindow：是否打开新窗口或相同。默认在新窗口中打开。

vscode.removeFromRecentlyOpened- 从最近打开的列表中删除具有给定路径的条目。

path - 要从最近打开的内容中删除的 URI 或 URI 字符串。

moveActiveEditor- 通过选项卡或组移动活动编辑器

活动编辑器移动参数- 参数属性：
- 'to'：提供移动位置的字符串值。
- 'by'：提供移动单位的字符串值（按选项卡或按组）。
- 'value'：提供要移动的位置或绝对位置的数值。

copyActiveEditor- 按组复制活动编辑器

活动编辑器复制参数- 参数属性：
- 'to'：提供复制位置的字符串值。
- 'value'：提供要复制的位置或绝对位置的数值。

vscode.getEditorLayout- 获取编辑器布局

（返回） - 一个编辑器布局对象，格式与 vscode.setEditorLayout 相同

workbench.action.files.newUntitledFile- 新的无标题文本文件

新的无标题文本文件参数- 编辑器视图类型或语言 ID（如果已知）

workbench.extensions.installExtension- 安装给定的扩展

extensionIdOrVSIXUri - 扩展 ID 或 VSIX 资源 uri
options - （可选）安装扩展的选项。具有以下属性的对象：installOnlyNewlyAddedFromExtensionPackVSIX：启用后，VS Code 仅安装扩展包 VSIX 中新添加的扩展。仅在安装 VSIX 时才考虑此选项。

workbench.extensions.uninstallExtension- 卸载给定的扩展

要卸载的扩展程序的 ID -

workbench.extensions.search- 搜索特定扩展名

在搜索中使用的查询-

workbench.action.tasks.runTask- 运行任务

args - 过滤快速选择中显示的任务

workbench.action.openIssueReporter- 打开问题报告器并可选择预填写部分表格。

options - 用于预先填写问题报告者的数据。

vscode.openIssueReporter- 打开问题报告器并可选择预填写部分表格。

options - 用于预先填写问题报告者的数据。

workbench.action.openLogFile-workbench.action.openLogFile

日志文件-

简单的命令

不需要参数的简单命令可以在默认keybindings.json文件的键盘快捷键列表中找到。未绑定的命令列在文件底部的注释块中。

要查看默认值keybindings.json，请运行首选项：从命令面板打开默认键盘快捷键 (JSON) ( ⇧⌘P (Windows、Linux Ctrl+Shift+P ) )。

11/1/2023