Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add extension develop docs #94

Merged
merged 2 commits into from
Mar 21, 2023
Merged

doc: add extension develop docs #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95c3f7c
doc: add extension develop docs
erha19 Mar 21, 2023
247f512
chore: update titles
erha19 Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions docs/extension/opensumi-api/built-in-command.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
id: built-in-command
title: Built-in Command
slug: built-in-command
order: 2
---

OpenSumi provides a set of built-in commands, which partially implement the built-in commands of VS Code. These commands may be used in some plug-ins. If you encounter built-in commands that are not implemented, you can go to [OpenSumi Issues](https://github .com/opensumi/core/issues) for adaptation requirements.

## Built-in command set

| command | function | parameter |
| --------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------- |
| revealInExplorer | Locate file in explorer interface | `uri`: URI |
| setContext | Set Context variable value | `key`: key, `value`: value |
| workbench.action.closeActiveEditor | Close the currently active editor | |
| workbench.action.revertAndCloseActiveEditor | Reverts the current file content and closes the active editor | |
| workbench.action.splitEditorRight | Split the current editor to the right | |
| workbench.action.splitEditorDown | Split the current editor down | |
| workbench.action.files.newUntitledFile | Create a new temporary editor file | |
| workbench.action.closeAllEditors | close all editors | |
| workbench.action.closeOtherEditors | close other editors | |
| workbench.action.files.save | Save current file | |
| workbench.action.splitEditor | Open file and split right | `resource`: ResourceArgs | URI, `editorGroup?`: EditorGroup |
| workbench.action.splitEditorOrthogonal | Open file and split down | `resource`: ResourceArgs | URI, `editorGroup?`: EditorGroup |
| workbench.action.navigateLeft | Switch to left editor | |
| workbench.action.navigateUp | switch to top editor | |
| workbench.action.navigateRight | Switch to right editor | |
| workbench.action.navigateDown | switch to bottom editor | |
| workbench.action.navigateEditorGroups | Navigate Editor Groups | |
| workbench.action.nextEditor | Switch to next file | |
| workbench.action.previousEditor | Switch to previous file | |
| workbench.action.openEditorAtIndex | Open editor by subscript position | |
| workbench.action.files.revert | Reverts the currently active file content | |
| workbench.action.terminal.clear | Clear the contents of the currently active terminal window | |
| workbench.action.terminal.toggleTerminal | Toggle Terminal Window | |
| workbench.files.action.focusFilesExplorer | Open the active editor group | |
| vscode.open | Open file (only available under Electron) | `uri`: URI, `newWindow`: boolean |
| vscode.openFolder | open folder (only available under Electron) | `uri`: URI, `newWindow`: boolean |
| workbench.action.reloadWindow (reload_window) | reload window | |
| copyFilePath | Copy file absolute path | `uri`: URI |
| copyRelativeFilePath | Relative file path to copy | `uri`: URI |
| workbench.action.openSettings | Open Settings panel | |
| workbench.action.navigateBack | Go to previous editor | |
| workbench.action.navigateForward | Navigate to the next editor | |
| workbench.action.files.saveAll | save all files | |
| workbench.action.debug.stepInto | Debug StepInto | |
| workbench.action.debug.stepOut | Debug step out | |
| workbench.action.debug.stepOver | Debug stepping | |
| workbench.action.debug.continue | debug continue | |
| workbench.action.debug.run (workbench.action.debug.start) | debug run | |
| workbench.action.debug.pause | debug pause | |
| workbench.action.debug.restart | debug restart | |
| workbench.action.debug.stop | debug stop | |
| workbench.action.showAllSymbols | Show all symbols | |

## Usage

> For example, use `vscode.open` to open a file with a protocol

```typescript
import * as sumi from 'sumi';

// Parameter Description
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'
);
```
79 changes: 79 additions & 0 deletions docs/extension/opensumi-api/built-in-command.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
id: built-in-command
title: 内置命令
slug: built-in-command
order: 2
---

OpenSumi 提供了一套内置命令，部分实现了 VS Code 内置实现的命令，这些命令可能会在某些插件被使用，如果遇到了没有实现的内置命令，可以前往 [OpenSumi Issues](https://github.com/opensumi/core/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 | URI, `editorGroup?`：EditorGroup |
| workbench.action.splitEditorOrthogonal | 打开文件并向下拆分 | `resource` ： ResourceArgs | URI, `editorGroup？`: EditorGroup |
| 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` 打开一个带协议的文件

```typescript
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'
);
```
Loading