内置命令
本文档列出了您可能与 vscode.commands.executeCommand
API 一起使用的 Visual Studio Code 命令的子集。
阅读命令指南,了解如何使用命令 API。
以下是如何在 VS Code 中打开一个新文件夹的示例:
let uri = Uri.file('/some/path/to/folder');
let success = await commands.executeCommand('vscode.openFolder', uri);
注意:您可以通过“键盘快捷方式”编辑器查看 VS Code 的所有命令:文件 > 首选项 > 键盘快捷方式。“键盘快捷方式”编辑器列出了 VS Code 内置或扩展贡献的所有命令,以及它们的键绑定和可见性条件。
命令
vscode.executeDataToNotebook
- 调用笔记本序列化器
- notebookType - 笔记本类型
- data - 要转换为数据的字节
- (返回) - 笔记本数据
vscode.executeNotebookToData
- 调用笔记本序列化器
- notebookType - 笔记本类型
- NotebookData - 要转换为字节的笔记本数据
- (返回) - 字节
notebook.selectKernel
- 触发指定笔记本编辑器小部件的内核选择器
- options - 选择内核选项
- (返回) - 无结果
interactive.open
- 打开交互式窗口并返回笔记本编辑器和输入 URI
- showOptions - 显示选项
- resource - 交互式资源 Uri
- controllerId - 笔记本控制器 Id
- title - 交互式编辑器标题
- (返回) - 笔记本和输入 URI
vscode.editorChat.start
- 调用新的编辑器聊天会话
- 运行参数 -
- (返回) - 无结果
vscode.executeDocumentHighlights
- 执行文档高亮提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 DocumentHighlight 实例的数组。
vscode.executeDocumentSymbolProvider
- 执行文档符号提供程序。
- uri - 文本文档的 Uri
- (返回) - 一个 Promise,解析为 SymbolInformation 和 DocumentSymbol 实例的数组。
vscode.executeFormatDocumentProvider
- 执行文档格式化提供程序。
- uri - 文本文档的 Uri
- options - 格式化选项
- (返回) - 一个 Promise,解析为 TextEdit 数组。
vscode.executeFormatRangeProvider
- 执行范围格式化提供程序。
- uri - 文本文档的 Uri
- range - 文本文档中的一个范围
- options - 格式化选项
- (返回) - 一个 Promise,解析为 TextEdit 数组。
vscode.executeFormatOnTypeProvider
- 执行按键格式化提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- ch - 触发字符
- options - 格式化选项
- (返回) - 一个 Promise,解析为 TextEdit 数组。
vscode.executeDefinitionProvider
- 执行所有定义提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Location 或 LocationLink 实例的数组。
vscode.executeTypeDefinitionProvider
- 执行所有类型定义提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Location 或 LocationLink 实例的数组。
vscode.executeDeclarationProvider
- 执行所有声明提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Location 或 LocationLink 实例的数组。
vscode.executeImplementationProvider
- 执行所有实现提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Location 或 LocationLink 实例的数组。
vscode.executeReferenceProvider
- 执行所有引用提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Location 实例的数组。
vscode.executeHoverProvider
- 执行所有悬停提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 Hover 实例的数组。
vscode.executeSelectionRangeProvider
- 执行选择范围提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为范围数组。
vscode.executeWorkspaceSymbolProvider
- 执行所有工作区符号提供程序。
- query - 搜索字符串
- (返回) - 一个 Promise,解析为 SymbolInformation 实例的数组。
vscode.prepareCallHierarchy
- 在文档中指定位置准备调用层次结构
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 CallHierarchyItem 实例的数组
vscode.provideIncomingCalls
- 计算项的传入调用
- item - 调用层次结构项
- (返回) - 一个 Promise,解析为 CallHierarchyIncomingCall 实例的数组
vscode.provideOutgoingCalls
- 计算项的传出调用
- item - 调用层次结构项
- (返回) - 一个 Promise,解析为 CallHierarchyOutgoingCall 实例的数组
vscode.prepareRename
- 执行重命名提供程序的 prepareRename。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为范围和占位符文本。
vscode.executeDocumentRenameProvider
- 执行重命名提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- newName - 新的符号名称
- (返回) - 一个 Promise,解析为 WorkspaceEdit。
vscode.executeLinkProvider
- 执行文档链接提供程序。
- uri - 文本文档的 Uri
- linkResolveCount - (可选) 应解析的链接数量,仅当链接未解析时。
- (返回) - 一个 Promise,解析为 DocumentLink 实例的数组。
vscode.provideDocumentSemanticTokensLegend
- 为文档提供语义标记图例
- uri - 文本文档的 Uri
- (返回) - 一个 Promise,解析为 SemanticTokensLegend。
vscode.provideDocumentSemanticTokens
- 为文档提供语义标记
- uri - 文本文档的 Uri
- (返回) - 一个 Promise,解析为 SemanticTokens。
vscode.provideDocumentRangeSemanticTokensLegend
- 为文档范围提供语义标记图例
- uri - 文本文档的 Uri
- range - (可选) 文本文档中的一个范围
- (返回) - 一个 Promise,解析为 SemanticTokensLegend。
vscode.provideDocumentRangeSemanticTokens
- 为文档范围提供语义标记
- uri - 文本文档的 Uri
- range - 文本文档中的一个范围
- (返回) - 一个 Promise,解析为 SemanticTokens。
vscode.executeCompletionItemProvider
- 执行补全项提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- triggerCharacter - (可选) 当用户输入字符(如
,
或(
)时触发补全 - itemResolveCount - (可选) 要解析的补全数量(数量过大将降低补全速度)
- (返回) - 一个 Promise,解析为 CompletionList 实例。
vscode.executeSignatureHelpProvider
- 执行签名帮助提供程序。
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- triggerCharacter - (可选) 当用户输入字符(如
,
或(
)时触发签名帮助 - (返回) - 一个 Promise,解析为 SignatureHelp。
vscode.executeCodeLensProvider
- 执行代码镜头提供程序。
- uri - 文本文档的 Uri
- itemResolveCount - (可选) 应解析并返回的代码镜头数量。将仅返回已解析的镜头,这会影响性能。
- (返回) - 一个 Promise,解析为 CodeLens 实例的数组。
vscode.executeCodeActionProvider
- 执行代码操作提供程序。
- uri - 文本文档的 Uri
- rangeOrSelection - 文本文档中的范围。某些重构提供程序需要 Selection 对象。
- kind - (可选) 要返回代码操作的代码操作类型
- itemResolveCount - (可选) 要解析的代码操作数量(数量过大将降低代码操作速度)
- (返回) - 一个 Promise,解析为 Command 实例的数组。
vscode.executeDocumentColorProvider
- 执行文档颜色提供程序。
- uri - 文本文档的 Uri
- (返回) - 一个 Promise,解析为 ColorInformation 对象的数组。
vscode.executeColorPresentationProvider
- 执行颜色呈现提供程序。
- color - 要显示和插入的颜色
- context - 包含 uri 和 range 的上下文对象
- (返回) - 一个 Promise,解析为 ColorPresentation 对象的数组。
vscode.executeInlayHintProvider
- 执行内联提示提供程序
- uri - 文本文档的 Uri
- range - 文本文档中的一个范围
- (返回) - 一个 Promise,解析为 Inlay 对象数组
vscode.executeFoldingRangeProvider
- 执行折叠范围提供程序
- uri - 文本文档的 Uri
- (返回) - 一个 Promise,解析为 FoldingRange 对象数组
vscode.resolveNotebookContentProviders
- 解析笔记本内容提供程序
- (返回) - 一个 Promise,解析为 NotebookContentProvider 静态信息对象的数组。
vscode.executeInlineValueProvider
- 执行内联值提供程序
- uri - 文本文档的 Uri
- range - 文本文档中的一个范围
- context - 一个 InlineValueContext
- (返回) - 一个 Promise,解析为 InlineValue 对象数组
vscode.open
- 在编辑器中打开提供的资源。可以是文本或二进制文件,也可以是 http(s) URL。如果您需要对打开文本文件的选项进行更多控制,请改用 vscode.window.showTextDocument
。
- uri - 文本或二进制文件,或 http(s) URL 的 Uri
- columnOrOptions - (可选) 要打开的列,或编辑器选项,请参阅
vscode.TextDocumentShowOptions
- label - 编辑器标签 (可选)
- (返回) - 无结果
vscode.openWith
- 使用特定编辑器打开提供的资源。
- resource - 要打开的资源
- viewId - 自定义编辑器视图 ID 或“default”以使用 VS Code 的默认编辑器
- columnOrOptions - (可选) 要打开的列,或编辑器选项,请参阅 vscode.TextDocumentShowOptions
- (返回) - 无结果
vscode.diff
- 在差异编辑器中打开提供的资源以比较其内容。
- left - 差异编辑器的左侧资源
- right - 差异编辑器的右侧资源
- title - 差异编辑器的人类可读标题
- options - (可选) 要打开的列,或编辑器选项(请参阅 vscode.TextDocumentShowOptions)
vscode.changes
- 在更改编辑器中打开资源列表以比较其内容。
- title - 更改编辑器的人类可读标题
- resourceList - 要比较的资源列表
vscode.prepareTypeHierarchy
- 在文档中指定位置准备类型层次结构
- uri - 文本文档的 Uri
- position - 文本文档中的一个位置
- (返回) - 一个 Promise,解析为 TypeHierarchyItem 实例的数组
vscode.provideSupertypes
- 计算项的超类型
- item - 类型层次结构项
- (返回) - 一个 Promise,解析为 TypeHierarchyItem 实例的数组
vscode.provideSubtypes
- 计算项的子类型
- item - 类型层次结构项
- (返回) - 一个 Promise,解析为 TypeHierarchyItem 实例的数组
vscode.revealTestInExplorer
- 在资源管理器中显示测试实例
- testItem - 一个 VS Code TestItem。
- (返回) - 无结果
setContext
- 设置一个可在 when 子句中使用的自定义上下文键值。
- name - 上下文键名称
- value - 上下文键值
- (返回) - 无结果
vscode.executeMappedEditsProvider
- 执行映射编辑提供程序
- uri - 文本文档的 Uri
- string_array - 字符串数组,
- MappedEditsContext - 映射编辑上下文
- (返回) - 一个 Promise,解析为工作区编辑或 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' 则进行选择。默认值为 'false'。
- 'to': 一个强制性的逻辑位置值,指示光标移动到何处。
editorScroll
- 沿给定方向滚动编辑器
- 编辑器滚动参数对象 - 可以通过此参数传递的属性-值对
- 'to': 一个强制性的方向值。
'up', 'down'
- 'by': 移动单位。默认值根据 'to' 值计算。
'line', 'wrappedLine', 'page', 'halfPage', 'editor'
- 'value': 移动单位数量。默认值为 '1'。
- 'revealCursor': 如果为 'true' 且光标在视图端口外,则显示光标。
- 'to': 一个强制性的方向值。
revealLine
- 在给定逻辑位置显示给定行
- 显示行参数对象 - 可以通过此参数传递的属性-值对
- 'lineNumber': 一个强制性的行号值。
- 'at': 行需要显示所在的逻辑位置。
'top', 'center', 'bottom'
editor.unfold
- 展开编辑器中的内容
- 展开编辑器参数 - 可以通过此参数传递的属性-值对
- 'levels': 要展开的级别数。如果未设置,默认为 1。
- 'direction': 如果为 'up',则向上展开给定数量的级别,否则向下展开。
- 'selectionLines': 要应用展开操作的编辑器选择的起始行(基于 0)数组。如果未设置,将使用活动选择。
editor.fold
- 折叠编辑器中的内容
- 折叠编辑器参数 - 可以通过此参数传递的属性-值对
- 'levels': 要折叠的级别数。
- 'direction': 如果为 'up',则向上折叠给定数量的级别,否则向下折叠。
- 'selectionLines': 要应用折叠操作的编辑器选择的起始行(基于 0)数组。如果未设置,将使用活动选择。如果未设置级别或方向,则折叠指定位置的区域,如果已折叠,则折叠第一个未折叠的父级。
editor.toggleFold
- 根据编辑器内容的当前状态折叠或展开内容
editor.actions.findWithArgs
- 打开带有特定选项的新编辑器内查找小部件。
- searchString - 用于预填充查找输入的字符串
- replaceString - 用于预填充替换输入的字符串
- isRegex - 启用正则表达式
- preserveCase - 替换时尝试保持相同的大小写
- findInSelection - 将查找位置限制在当前选择中
- matchWholeWord
- isCaseSensitive
editor.action.goToLocations
- 从文件中的位置转到位置
- uri - 开始的文本文档
- position - 开始的位置
- locations - 位置数组。
- multiple - 定义当有多个结果时如何操作,可以是
peek
、gotoAndPeek
或 `goto` - noResultsMessage - 当位置为空时显示的人类可读消息。
editor.action.peekLocations
- 从文件中的位置预览位置
- uri - 开始的文本文档
- position - 开始的位置
- locations - 位置数组。
- multiple - 定义当有多个结果时如何操作,可以是
peek
、gotoAndPeek
或 `goto`
workbench.action.quickOpen
- 快速访问
- prefix -
notebook.cell.toggleOutputs
- 切换输出
- options - 单元格范围选项
notebook.fold
- 折叠单元格
- index - 单元格索引
notebook.unfold
- 展开单元格
- index - 单元格索引
notebook.selectKernel
- 笔记本内核参数
- kernelInfo - 内核信息
notebook.cell.changeLanguage
- 更改单元格语言
- range - 单元格范围
- language - 目标单元格语言
notebook.execute
- 全部运行
- uri - 文档 uri
notebook.cell.execute
- 执行单元格
- options - 单元格范围选项
notebook.cell.executeAndFocusContainer
- 执行单元格并聚焦容器
- options - 单元格范围选项
notebook.cell.cancelExecution
- 停止单元格执行
- options - 单元格范围选项
workbench.action.findInFiles
- 打开工作区搜索
- 一组搜索选项 -
_interactive.open
- 打开交互式窗口
- showOptions - 显示选项
- resource - 交互式资源 Uri
- controllerId - 笔记本控制器 Id
- title - 笔记本编辑器标题
interactive.execute
- 执行输入框的内容
- resource - 交互式资源 Uri
search.action.openNewEditor
- 打开一个新的搜索编辑器。传递的参数可以包含诸如 ${relativeFileDirname} 等变量。
- 打开新的搜索编辑器参数 -
search.action.openEditor
- 打开一个新的搜索编辑器。传递的参数可以包含诸如 ${relativeFileDirname} 等变量。
- 打开新的搜索编辑器参数 -
search.action.openNewEditorToSide
- 打开一个新的搜索编辑器。传递的参数可以包含诸如 ${relativeFileDirname} 等变量。
- 打开新的搜索编辑器参数 -
vscode.openFolder
- 在当前窗口或新窗口中打开文件夹或工作区,具体取决于 newWindow 参数。请注意,在同一窗口中打开将关闭当前扩展主机进程并在给定文件夹/工作区上启动一个新进程,除非 newWindow 参数设置为 true。
- uri - (可选) 要打开的文件夹或工作区文件的 Uri。如果未提供,将弹出原生对话框要求用户选择文件夹
- options - (可选) 选项。具有以下属性的对象:
forceNewWindow
:是否在新窗口或同一窗口中打开文件夹/工作区。默认为在同一窗口中打开。forceReuseWindow
:是否强制在同一窗口中打开文件夹/工作区。默认为 false。noRecentEntry
:打开的 URI 是否会出现在“最近打开”列表中。默认为 false。注意,为了向后兼容,options 也可以是布尔类型,表示forceNewWindow
设置。
vscode.newWindow
- 根据 newWindow 参数打开一个新窗口。
- options - (可选) 选项。具有以下属性的对象:
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
- logFile -
workbench.action.openWalkthrough
- 打开演练。
- walkthroughID - 要打开的演练 ID。
- toSide - 在旁边的新编辑器组中打开演练。
简单命令
不需要参数的简单命令可以在默认的 keybindings.json
文件中的键盘快捷方式列表中找到。未绑定的命令列在文件底部的注释块中。
要查看默认的 keybindings.json
,请从命令面板运行首选项:打开默认键盘快捷方式 (JSON)(⇧⌘P(Windows、Linux Ctrl+Shift+P))。