Visual Studio Code

内置命令

本文档列出了您可能会与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 - 文本文档中的一个位置
  • (返回) - 一个解析为DocumentHighlight实例数组的promise。

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

  • uri - 文本文档的Uri
  • (返回) - 一个解析为 SymbolInformation 和 DocumentSymbol 实例数组的 promise。

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

  • uri - 文本文档的Uri
  • options - 格式化选项
  • (返回) - 一个解析为TextEdits数组的承诺。

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

  • uri - 文本文档的Uri
  • range - 文本文档中的一个范围
  • options - 格式化选项
  • (返回) - 一个解析为TextEdits数组的promise。

vscode.executeFormatOnTypeProvider - 执行类型提供者的格式化。

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • ch - 触发字符
  • options - 格式化选项
  • (返回) - 一个解析为TextEdits数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为Location或LocationLink实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为Location或LocationLink实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回值) - 一个解析为Location或LocationLink实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为Location或LocationLink实例数组的promise。

vscode.executeReferenceProvider - 执行所有引用提供者。

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为Location实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回值) - 一个解析为Hover实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为范围数组的承诺。

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

  • query - 搜索字符串
  • (返回) - 一个解析为SymbolInformation实例数组的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回值) - 一个解析为CallHierarchyItem实例数组的promise

vscode.provideIncomingCalls - 计算项目的传入调用

  • item - 调用层次结构项
  • (返回) - 一个解析为CallHierarchyIncomingCall实例数组的promise

vscode.provideOutgoingCalls - 计算项目的传出调用

  • item - 调用层次结构项
  • (返回) - 一个解析为CallHierarchyOutgoingCall实例数组的promise

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回) - 一个解析为范围和占位符文本的承诺。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • newName - 新的符号名称
  • (返回值) - 一个解析为WorkspaceEdit的承诺。

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

  • uri - 文本文档的Uri
  • linkResolveCount - （可选）应解析的链接数量，仅在链接未解析时使用。
  • (返回) - 一个解析为DocumentLink实例数组的promise。

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

  • uri - 文本文档的Uri
  • (返回值) - 一个解析为SemanticTokensLegend的promise。

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

  • uri - 文本文档的Uri
  • (返回值) - 一个解析为SemanticTokens的promise。

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

  • uri - 文本文档的Uri
  • range - （可选）文本文档中的一个范围
  • (返回值) - 一个解析为SemanticTokensLegend的承诺。

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

  • uri - 文本文档的Uri
  • range - 文本文档中的一个范围
  • (返回值) - 一个解析为SemanticTokens的promise。

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • triggerCharacter - （可选）当用户输入字符时触发补全，例如 , 或 (
  • itemResolveCount - （可选）要解析的完成项数量（过大的数字会减慢完成速度）
  • (返回值) - 一个解析为CompletionList实例的promise。

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

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

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

  • uri - 文本文档的Uri
  • itemResolveCount - （可选）应解析并返回的镜头数量。仅返回已解析的镜头，会影响性能
  • (返回值) - 一个解析为CodeLens实例数组的promise。

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

  • uri - 文本文档的Uri
  • rangeOrSelection - 文本文档中的范围。某些重构提供者需要Selection对象。
  • kind - （可选）要返回代码操作的代码操作类型
  • itemResolveCount - （可选）要解析的代码操作数量（过大的数字会减慢代码操作的速度）
  • (返回值) - 一个解析为Command实例数组的promise。

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

  • uri - 文本文档的Uri
  • (返回) - 一个解析为ColorInformation对象数组的promise。

vscode.executeColorPresentationProvider - 执行颜色表示提供者。

  • color - 显示和插入的颜色
  • context - 包含uri和范围的上下文对象
  • (返回值) - 一个解析为ColorPresentation对象数组的promise。

vscode.executeInlayHintProvider - 执行内嵌提示提供者

  • uri - 文本文档的Uri
  • range - 文本文档中的一个范围
  • (返回) - 一个解析为Inlay对象数组的promise

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

  • uri - 文本文档的Uri
  • (返回) - 一个解析为FoldingRange对象数组的promise

vscode.resolveNotebookContentProviders - 解析笔记本内容提供者

  • (返回) - 一个解析为NotebookContentProvider静态信息对象数组的promise。

vscode.executeInlineValueProvider - 执行内联值提供程序

  • uri - 文本文档的Uri
  • range - 文本文档中的一个范围
  • context - 一个 InlineValueContext
  • (返回值) - 一个解析为InlineValue对象数组的promise

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

  • Uri -

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

  • resource - 要打开的资源
  • viewId - 自定义编辑器视图ID或使用VS Code的默认编辑器的'default'
  • columnOrOptions - （可选）要打开的列或编辑器选项，请参阅 vscode.TextDocumentShowOptions
  • (返回) - 无结果

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

  • left - 差异编辑器的左侧资源
  • right - 差异编辑器的右侧资源
  • title - 差异编辑器的人类可读标题
  • options - （可选）要打开的列，或编辑器选项（参见 vscode.TextDocumentShowOptions）

vscode.changes - 在更改编辑器中打开资源列表以比较它们的内容。

  • title - 变更编辑器的人类可读标题
  • resourceList - 要比较的资源列表

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

  • uri - 文本文档的Uri
  • position - 文本文档中的一个位置
  • (返回值) - 一个解析为 TypeHierarchyItem 实例数组的 promise

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

  • item - 类型层次结构项
  • (返回) - 一个解析为TypeHierarchyItem实例数组的承诺

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

  • item - 类型层次结构项
  • (返回) - 一个解析为 TypeHierarchyItem 实例数组的 promise

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

  • testItem - 一个 VS Code 测试项。
  • (返回) - 无结果

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

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

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

  • uri - 文本文档的Uri
  • string_array - 字符串数组，
  • MappedEditsContext - 映射编辑上下文
  • (返回) - 一个解析为工作区编辑或null的promise

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'。

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.toggleFold - 根据当前状态折叠或展开编辑器中的内容

editor.actions.findWithArgs - 使用特定选项打开一个新的编辑器内查找小部件。

  • searchString - 用于预填充查找输入的字符串
  • replaceString - 用于预填充替换输入的字符串
  • isRegex - 启用正则表达式
  • preserveCase - 尝试在替换时保持相同的大小写
  • findInSelection - 将查找位置限制在当前选区内
  • matchWholeWord
  • 区分大小写

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））。

12/11/2024