内置命令

OpenSumi 提供了一套内置命令,部分实现了 VS Code 内置实现的命令,这些命令可能会在某些插件被使用,如果遇到了没有实现的内置命令,可以前往 OpenSumi Issues 提适配需求。

内置命令集

命令功能参数
revealInExplorer在资源管理器界面定位文件uri: URI
setContext设置 Context 变量值key:键, value:值
workbench.action.closeActiveEditor关闭当前激活的编辑器
workbench.action.revertAndCloseActiveEditor恢复当前文件内容同时关闭激活的编辑器
workbench.action.splitEditorRight向右拆分当前编辑器
workbench.action.splitEditorDown向下拆分当前编辑器
workbench.action.files.newUntitledFile新建临时的编辑器文件
workbench.action.closeAllEditors关闭所有编辑器
workbench.action.closeOtherEditors关闭其他编辑器
workbench.action.files.save保存当前文件
workbench.action.splitEditor打开文件并向右拆分resource : ResourceArgs
workbench.action.splitEditorOrthogonal打开文件并向下拆分resource : ResourceArgs
workbench.action.navigateLeft切换到左侧编辑器
workbench.action.navigateUp切换到顶部编辑器
workbench.action.navigateRight切换到右侧编辑器
workbench.action.navigateDown切换到底部编辑器
workbench.action.navigateEditorGroups切换编辑器组
workbench.action.nextEditor切换至下个文件
workbench.action.previousEditor切换至上个文件
workbench.action.openEditorAtIndex通过下标位置打开编辑器
workbench.action.files.revert恢复当前激活的文件内容
workbench.action.terminal.clear清理当前激活的终端窗口内容
workbench.action.terminal.toggleTerminal打开/关闭 终端窗口
workbench.files.action.focusFilesExplorer打开激活的编辑器组
vscode.open打开文件(仅在 Electron 下可用)uri: URI, newWindow: boolean
vscode.openFolder打开文件夹(仅在 Electron 下可用)uri: URI, newWindow: boolean
workbench.action.reloadWindow (reload_window)重载窗口
copyFilePath复制文件绝对路径uri: URI
copyRelativeFilePath复制文件相对路径uri: URI
workbench.action.openSettings打开设置面板
workbench.action.navigateBack前往上一个编辑器
workbench.action.navigateForward前往下一个编辑器
workbench.action.files.saveAll保存全部文件
workbench.action.debug.stepInto调试步入
workbench.action.debug.stepOut调试步出
workbench.action.debug.stepOver调试步进
workbench.action.debug.continue调试继续
workbench.action.debug.run (workbench.action.debug.start)调试运行
workbench.action.debug.pause调试暂停
workbench.action.debug.restart调试重启
workbench.action.debug.stop调试终止
workbench.action.showAllSymbols展示所有符号

用法

例如使用 vscode.open 打开一个带协议的文件

import * as sumi from 'sumi';

// 参数说明
type VSCodeOpen = (
  resource: vscode.Uri,
  columnOrOptions?: vscode.ViewColumn | vscode.TextDocumentShowOptions,
  label?: string
) => void;

sumi.commands.executeCommand(
  'vscode.open',
  {
    preserveFocus: true,
    preview: false
  } as vscode.TextDocumentShowOptions,
  'test-title'
);