内置命令

此文档列出了你可能在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执行数据到笔记本- 调用笔记本序列化器

笔记本类型 - 一种笔记本类型
数据 - 要转换为数据的字节
(返回) - 笔记本数据

vscode执行笔记本到数据- 调用笔记本序列化器

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

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

选项 - 选择内核选项
（返回） - 没有结果

交互.打开- 打开交互Windows并返回笔记本编辑器和输入URI

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

vscode.editorChat.start- 启动新的编辑器聊天会话

运行参数 -
（返回） - 没有结果

vscode执行文档高亮- 执行文档高亮提供者。

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回) - 返回一个解析为DocumentHighlight实例数组的承诺。

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

uri - 文本文件的uri
(返回值) - 返回一个解析为SymbolInformation和DocumentSymbol实例数组的承诺。

vscode执行格式化文档提供者- 执行文档格式提供者。

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

vscode执行格式化范围提供者- 执行范围格式提供者。

uri - 文本文件的uri
范围 - 文档中的一个范围
选项 - 格式化选项
(返回) - 一个解析为 TextEdits 数组的承诺。

vscode执行格式化提供程序- 对类型提供者执行格式化。

uri - 文本文件的uri
位置 - 文档中的一个位置
ch - 触发角色
选项 - 格式化选项
(返回) - 一个解析为 TextEdits 数组的承诺。

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

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回) - 一个解析为Location或LocationLink实例数组的承诺。

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

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回) - 一个解析为Location或LocationLink实例数组的承诺。

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

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回) - 一个解析为Location或LocationLink实例数组的承诺。

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

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回) - 一个解析为Location或LocationLink实例数组的承诺。

vscode执行参考提供者- 执行所有引用提供者。

uri - 文本文件的uri
位置 - 文档中的一个位置
（返回值） - 返回一个解析为Location实例数组的承诺。

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

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回值) - 一个解析为包含多个 Hover 实例的数组的承诺。

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

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

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

查询 - 搜索字符串
(返回值) - 返回一个解析为SymbolInformation实例数组的承诺。

vscode准备调用层次结构- 在文档内准备调用层次

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回值) - 一个解析为CallHierarchyItem实例数组的承诺

vscode.提供入站电话- 计算项目收到的电话

项目 - 调用层次结构项目
(返回值) - 返回一个解析为CallHierarchyIncomingCall实例数组的承诺

vscode.provideOutgoingCalls- 计算项目的所有外出电话

项目 - 调用层次结构项目
(返回) - 返回一个解析为CallHierarchyOutgoingCall实例数组的承诺

vscode.准备重命名- 执行重命名提供程序的 prepareRename。

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

vscode执行文档重命名提供者- 执行重命名提供程序。

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

vscode执行链接提供者- 执行文档链接提供者。

uri - 文本文件的uri
linkResolveCount - （可选）应解析的链接数量，仅在链接未解析时有效。
(返回值) - 一个解析为包含DocumentLink实例的数组的承诺。

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

uri - 文本文件的uri
(返回) - 返回一个解析为SemanticTokensLegend的承诺。

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

uri - 文本文件的uri
(返回) - 返回一个解析为SemanticTokens的承诺。

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

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

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

uri - 文本文件的uri
范围 - 文档中的一个范围
(返回) - 返回一个解析为SemanticTokens的承诺。

vscode执行完成项提供者- 执行完成项提供程序。

uri - 文本文件的uri
位置 - 文档中的一个位置
触发字符 - （可选）当用户输入该字符时触发完成，例如 输入：或输入：(
itemResolveCount - （可选）要解析的完成次数（过大的数字会减慢完成速度）
(返回) - 一个解析为CompletionList实例的承诺。

vscode执行签名帮助提供者- 执行签名帮助提供程序。

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

vscode执行代码片段提供程序- 执行代码视图提供者。

uri - 文本文件的uri
itemResolveCount - （可选）应解析和返回的透镜数量。将仅返回解析的透镜，会影响性能
(返回) - 一个解析为包含 CodeLens 实例的数组的承诺。

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

uri - 文本文件的uri
范围或选择 - 文本文档中的范围。某些代码重构提供程序需要选择对象。
kind - （可选）返回代码操作的代码操作类型
itemResolveCount - （可选）解析的代码操作数（过大的数字会减慢代码操作）
(返回值) - 一个解析为Command实例数组的承诺。

vscode执行文档颜色提供者- 执行文档颜色提供者。

uri - 文本文件的uri
(返回值) - 一个解析为ColorInformation对象数组的承诺。

vscode执行颜色呈现提供者- 执行颜色展示提供者。

颜色 - 显示和插入的颜色
上下文 - 上下文对象带有uri和范围
(返回值) - 返回一个解析为ColorPresentation对象数组的承诺。

vscode执行内联提示提供者- 执行嵌入式提示提供者

uri - 文本文件的uri
范围 - 文档中的一个范围
(返回) - 返回一个解析为Inlay对象数组的承诺

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

uri - 文本文件的uri
(返回值) - 一个解析为折叠范围对象数组的承诺

vscode.resolveNotebookContentProviders- 解决 Notebook 内容提供者

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

vscode执行内联值提供程序- 执行内联值提供者

uri - 文本文件的uri
范围 - 文档中的一个范围
上下文 - 一个内联值上下文
(返回) - 一个解析为 InlineValue 对象数组的承诺

vscode.打开- 在编辑器中打开提供的资源。可以是文本或二进制文件，或http(s) URL。如果您需要更多控制打开文本文件的选项，请使用vscodeWindows显示文本文档相反。

uri - 文本或二进制文件的uri，或http(s)网址
columnOrOptions - （可选）打开的列或编辑器选项，参见 vscode文本文档显示选项
Tab - 编辑器标签（可选）
（返回） - 没有结果

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

资源 - 打开的资源
viewId - 自定义编辑器视图ID或'default'以使用VS Code的默认编辑器
columnOrOptions - （可选）指定在哪个列中打开或编辑器选项，见vscode.TextDocumentShowOptions
（返回） - 没有结果

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

左 - 差异编辑器的左侧资源
右 - 差异编辑器的右侧资源
标题 - 差异编辑器的可读标题
选项 - （可选）要打开的列，或者编辑器选项（见vscode.TextDocumentShowOptions）

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

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

vscode准备类型层次结构- 在文档内准备类型层次结构

uri - 文本文件的uri
位置 - 文档中的一个位置
(返回值) - 一个解析为 TypeHierarchyItem 实例数组的承诺

vscode提供超类型- 计算项目的超级类型

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

vscode提供子类型- 计算项目的子类型

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

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

测试项目 - 一个 VS Code 测试项目。
（返回） - 没有结果

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

名称 - 上下文键名称
值 - 上下文键值
（返回） - 没有结果

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

光标移动参数对象 - 可以通过此参数传递的属性值对：
- 'to': 一个必需的逻辑位置值，提供光标移动的位置。
```
'左', '右', '上', '下', '上一空白行', '下一空白行'
'包裹行起始', '包裹行结束', '包裹行列中心'
'包裹行第一个非空白字符', '包裹行最后一个非空白字符'
'视口顶部', '视口中心', '视口底部', '视口若在外部'
```
- 'by': 移动的单位。默认值是根据'to'值计算的。
```
'line', 'wrappedLine', 'character', 'halfLine'
```
- 'value'：移动的单位数量。默认值是 '1'。
- 'select': 如果为'true'，则进行选择。默认值为'false'。

编辑器滚动- 在给定方向上滚动编辑器

编辑器滚动参数对象 - 可以通过此参数传递的键值对：
- 'to': 一个必需的方向值。
```
'上', '下'
```
- 'by': 移动的单位。默认值是根据'to'值计算的。
```
'line', 'wrappedLine', 'page', 'halfPage', 'editor'
```
- 'value'：移动的单位数量。默认值是 '1'。
- 'revealCursor': 如果为'true'，则在光标在视口外时显示光标。

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

显示行参数对象 - 可以通过此参数传递的属性值对：
- 'lineNumber': 一个必需的行号值。
- 'at': 线需要揭示的逻辑位置。
```
'top', 'center', 'bottom'
```

编辑器.展开- 展开编辑器中的内容

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

编辑器折叠- 折叠编辑器中的内容

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

编辑器.切换折叠- 根据当前状态在编辑器中折叠或展开内容

编辑器.操作.查找带参数- 打开一个新的编辑器查找小部件，带有特定选项。

searchString - 字符串，用于预填充查找输入
replaceString - 用于预填充替换输入的字符串
isRegex - 启用正则表达式
preserveCase - 尽量在替换时保持相同的大小写
findInSelection - 将查找位置限制在当前选择
匹配整个单词
是否区分大小写

编辑器操作：转到位置- 从文件中的一个位置跳转到一个位置

uri - 在其中开始的文本文件
位置 - 开始的位置
位置 - 位置数组。
多个 - 定义在有多余结果时应如何处理，无论是窥视，转到并查看, 或者 `goto
没有结果信息 - 当位置为空时显示的人类可读消息。

编辑器操作.查看位置- 从文件中的一个位置窥视位置

uri - 在其中开始的文本文件
位置 - 开始的位置
位置 - 位置数组。
多个 - 定义在有多余结果时应如何处理，无论是窥视，转到并查看, 或者 `goto

工作台.操作.快速打开- 快速访问

前缀 -

notebook.cell.toggleOutputs- 切换输出

选项 - 单元格范围选项

笔记本折叠- 折叠单元

索引 - 细胞索引

notebook.unfold- 展开单元格

索引 - 细胞索引

notebook.选择内核- 笔记本内核参数

内核信息 - 内核信息

笔记本单元格更改语言- 更改单元格语言

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

笔记本执行- 运行全部

uri - 文档uri

notebook.cell.execute- 执行单元格

选项 - 单元格范围选项

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

选项 - 单元格范围选项

笔记本单元格取消执行- 停止单元格执行

选项 - 单元格范围选项

工作台.操作.在文件中查找- 打开工作区搜索

搜索选项集 -

_interactive.open- 打开交互Windows

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

交互执行- 执行输入框的内容

资源 - 交互式资源Uri

搜索.操作.打开新编辑器- 打开新的搜索编辑器。传递的参数可以包括像${relativeFileDirname}这样的变量。

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

搜索.操作.打开编辑器- 打开新的搜索编辑器。传递的参数可以包括像${relativeFileDirname}这样的变量。

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

搜索.操作.在旁边打开新编辑器- 打开新的搜索编辑器。传递的参数可以包括像${relativeFileDirname}这样的变量。

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

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

uri - （可选）要打开的文件夹或工作区文件的uri。如果未提供，系统对话框将询问用户选择文件夹
选项 - （可选）选项。具有以下属性的对象：强制新Windows是否在新Windows或当前Windows中打开文件夹/工作区。默认情况下在当前Windows中打开。强制重用Windows是否强制在同一个Windows中打开文件夹/工作区。默认为 false。没有最近的条目是否打开的URI会出现在“打开最近”列表中。默认为false。注意，为了向前兼容，选项也可以是布尔类型，表示强制新Windows设置。

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

选项 - （可选）选项。具有以下属性的对象：重用Windows是否在新Windows或相同Windows中打开。默认情况下在新Windows中打开。

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

路径 - 从最近打开的列表中移除的URI或URI字符串。

移动活动编辑器- 通过标签或组移动活动编辑器

活动编辑器移动参数 - 参数属性：
- 'to': 提供移动位置的字符串值。
- 'by': 提供移动单位的字符串值（通过制表或通过组）。
- 'value'：数字值，表示移动多少个位置或绝对位置。

复制活动编辑器- 按组复制活动编辑器

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

vscode.getEditorLayout- 获取编辑器布局

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

工作台.操作.文件.新建无标题文件- 新建未命名文本文件

新的未命名文本文件参数 - 编辑器视图类型或已知语言ID

工作台.扩展.安装扩展- 安装给定的扩展

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

工作台.扩展.卸载扩展- 卸载给定的扩展

要卸载的扩展的ID -

工作台.扩展.搜索- 搜索特定扩展

用于搜索的查询 -

工作台.操作.运行任务- 运行任务

参数 - 筛选快速选择中显示的任务

工作台.操作.打开问题报告器- 打开问题报告工具，可选地预填部分表单。

选项 - 用于预填充问题报告器的数据。

vscode.打开问题报告器- 打开问题报告工具，可选地预填部分表单。

选项 - 用于预填充问题报告器的数据。

工作台.操作.打开日志文件- 工作台.操作.打开日志文件

日志文件 -

工作台.操作.打开指南- 打开指南。

攻略ID - 要打开的攻略ID。
toSide - 在新的编辑器组中打开教程。

简单命令

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

要查看默认设置keybindings.json，运行偏好设置：打开默认键盘快捷键 (JSON)，从命令面板 (⇧⌘P（Windows, Linux Ctrl+Shift+P））。