https://github.com/kaynewang/local-terminal
A local terminal for xterm
https://github.com/kaynewang/local-terminal
father terminal typescript xterm
Last synced: 2 months ago
JSON representation
A local terminal for xterm
- Host: GitHub
- URL: https://github.com/kaynewang/local-terminal
- Owner: KayneWang
- Created: 2020-05-26T13:06:07.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-08T12:15:57.000Z (about 5 years ago)
- Last Synced: 2025-03-18T11:12:44.555Z (3 months ago)
- Topics: father, terminal, typescript, xterm
- Language: TypeScript
- Size: 23.4 KB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://xtermjs.org/)
[](https://www.tslang.cn/index.html)
# Local Terminal
> 为 xterm 打造本地终端模拟功能
由于直接使用 xterm 模拟本地终端十分困难，官方 demo 也很简单，不能满足复杂需求。
所以，该项目希望提供一套常用的终端操作，帮助快速模拟本地终端。
## 特性
* 支持 xterm 4.x
* 支持 ts
* 支持多行输入
* 支持历史命令记录
* 支持命令自动补全
## 使用方法
``` shell
$ npm install local-terminal
```
安装完成之后参考 [demo](https://github.com/KayneWang/local-terminal/blob/master/src/demos/react.stories.js) 使用
## Example
仓库克隆下来之后，执行：
``` shell
$ npm install
$ npm run storybook
```
## API
### constructor(xterm, option)
* xterm: xterm.js 实例
* option(可选): local-terminal 配置
option 的默认配置如下：
```
{
historySize: 10, // 记录历史命令条数
maxAutocompleteEntries: 100 // 自动补全命令条数
}
```
### read(prompt, continuationPrompt) -> Promise
* prompt: 命令行提示符
* continuationPrompt(可选): 多行输入时的提示符
读取输入后的单行命令，返回一个 Promise 用于处理完成输入后的操作:
``` js
const local = new localTerminal(xterm)
local.read("~ ")
.then(input => console.log("command line: " + input))
.catch(error => console.error("error: " + error))
```
### print(message)
输入命令
### clear()
清屏
### addAutocompleteHandler(index, tokens) -> string[]
* index: 当前自动完成命令下标
* tokens: 当前请求命令数组
使用 TAB 自动补全命令，该方法需要返回一个命令集合：
``` js
// 自动补全命令
function autocompleteCommonCommands(index, tokens) {
if (index == 0) return ["cp", "mv", "ls", "chown"];
return [];
}
// 自动补全文件名
function autocompleteCommonFiles(index, tokens) {
if (index == 0) return [];
return [".git", ".gitignore", "package.json"];
}
// Register the handlers
local.addAutocompleteHandler(autocompleteCommonCommands);
local.addAutocompleteHandler(autocompleteCommonFiles);
```