# @opensumi/ide-terminal-next

> ## 实现方式

Latest version **3.9.0** (published 2025-05-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install @opensumi/ide-terminal-next
pnpm add @opensumi/ide-terminal-next
yarn add @opensumi/ide-terminal-next
bun add @opensumi/ide-terminal-next
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 3.9.0 |
| Published | 2025-05-20 |
| First published | 2021-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3654 |
| Maintainers | ensorrow, jinboker, ricbet, hacke2, lengthmin, erha19, sakuraash, yantze |

## Links

- npm: https://www.npmjs.com/package/@opensumi/ide-terminal-next
- Repository: https://github.com/opensumi/core
- Homepage: https://github.com/opensumi/core#readme
- Issues: https://github.com/opensumi/core/issues
- npm.io page: https://npm.io/package/@opensumi/ide-terminal-next

## Dependencies (12)

- [node-pty](https://npm.io/package/node-pty.md) 1.0.0
- [os-locale](https://npm.io/package/os-locale.md) ^4.0.0
- [@xterm/xterm](https://npm.io/package/@xterm/xterm.md) 5.5.0
- [@xterm/addon-fit](https://npm.io/package/@xterm/addon-fit.md) 0.10.0
- [@xterm/addon-webgl](https://npm.io/package/@xterm/addon-webgl.md) 0.18.0
- [@opensumi/ide-utils](https://npm.io/package/@opensumi/ide-utils.md) 3.9.0
- [@xterm/addon-canvas](https://npm.io/package/@xterm/addon-canvas.md) 0.7.0
- [@xterm/addon-search](https://npm.io/package/@xterm/addon-search.md) 0.15.0
- [@opensumi/ide-core-node](https://npm.io/package/@opensumi/ide-core-node.md) 3.9.0
- [@opensumi/ide-connection](https://npm.io/package/@opensumi/ide-connection.md) 3.9.0
- [@opensumi/ide-core-common](https://npm.io/package/@opensumi/ide-core-common.md) 3.9.0
- [@opensumi/ide-file-service](https://npm.io/package/@opensumi/ide-file-service.md) 3.9.0

## Recent versions

- 3.9.0 (latest) — 2025-05-20
- 3.9.1-next-1789996105.0 (next) — 2026-09-21
- 2.27.3-rc-1715227667.0 (rc) — 2024-05-09
- 3.9.1-next-1788263965.0 — 2026-09-01
- 3.9.1-next-1788253557.0 — 2026-09-01
- 3.9.1-next-1788150617.0 — 2026-08-31
- 3.9.1-next-1787646115.0 — 2026-08-25
- 3.9.1-next-1787303337.0 — 2026-08-21
- 3.9.1-next-1787197346.0 — 2026-08-20
- 3.9.1-next-1786069412.0 — 2026-08-07
- 3.9.1-next-1784688644.0 — 2026-07-22
- 3.9.1-next-1784643835.0 — 2026-07-21
- 3.9.1-next-1784623944.0 — 2026-07-21
- 3.9.1-next-1784553929.0 — 2026-07-20
- 3.9.1-next-1783436180.0 — 2026-07-07
- … 1885 more at https://npm.io/package/@opensumi/ide-terminal-next/versions

## README

# 终端

## 实现方式

实现 src/common/term.ts 文件中的 ITerminalService 类型，并在 src/browser/index.ts 中替换默认的 service 类型。

```ts
export interface ITerminalService {
  /**
   * 集成方自定义会话唯一标识的函数
   */
  makeId(): string;
  /**
   * 集成方自定义写入到 localStorage 的键值的函数
   */
  restore(): string;
  /**
   * 当关闭 IDE 的时候，允许集成方额外向每一个会话标识写入一个字符串字段，
   * 信息内容由集成方决定
   *
   * @param sessionId 会话唯一标识
   */
  meta(sessionId: string): string;
  /**
   * Xterm 终端的构造选项
   */
  getOptions(): ITerminalOptions;
  /**
   * 用于获取特定会话的相关信息，包括进程 id 以及进程描述的 name，
   * 这个函数允许返回为空
   *
   * @param sessionId 会话唯一标识
   */
  intro(sessionId: string): { pid: number, name: string } | undefined;
  /**
   *
   * @param id 会话唯一标识
   * @param message 发送的字符串信息
   */
  sendText(id: string, message: string): Promise<void>;
  /**
   *
   * @param sessionId 会话唯一标识
   * @param term 返回的 Xterm 终端实例
   * @param restore 是否是恢复一个终端
   * @param meta 恢复终端所需要的额外字段
   * @param attachMethod 将 websocket 连接和 xterm 连接起来的函数
   * @param options 创建一个新终端的进程选项
   */
  attach(sessionId: string, term: Terminal, restore: boolean, meta: string, attachMethod: (s: WebSocket) => void, options?: TerminalOptions): Promise<void>;
  /**
   *
   * @param sessionId 会话唯一标识
   * @param cols resize 的列数
   * @param rows resize 的行数
   */
  resize(sessionId: string, cols: number, rows: number): Promise<void>;
  /**
   * 销毁一个终端进程
   *
   * @param sessionId 会话唯一标识
   */
  disposeById(sessionId: string): void;
  /**
   * 异步向后端获取一个会话的进程 id
   *
   * @param sessionId 会话唯一标识
   */
  getProcessId(sessionId: string): Promise<number>;

  /**
   * 报错处理的事件
   *
   * @param handler
   */
  onError(handler: (error: ITerminalError) => void): void;
}
```

## 外部和内部 API

对于 common 中默认导出的 api 认为为外部 api，而对于 common 中没有默认导出的类型则认为为内部 api，内部 api 依然可以通过子名称获取到类型进行覆盖或者使用，但是内部 api 的任何 api 修改不作为 bk，不推荐直接使用内部 api。

## 接下来

* [ ] 终端首次初始化使用对比的外层 dom 节点需要可指定，这里可能需要使用 core 内部 api 手动计算
* [ ] 终端 Singleton 模式
* [ ] 终端后端 Pty 代码优化，需要支持开发时重连
* [ ] Vim 显示优化

---
_Source: https://npm.io/package/@opensumi/ide-terminal-next · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._