Cursor AgentandDaniel Imms
9a96b27566
Replace common/*, browser/*, and headless/* path-mapped imports with relative paths across src/, addons/, test/, and demo/. Remove paths from all tsconfig.json files and include addon typings directly. Addon sources import shared code via out-esbuild/ so unit tests resolve compiled modules with runtime const enums. Fix benchmark bare imports and normalize corrupted tsconfig formatting. Resolves #5896 Co-authored-by: Daniel Imms <Tyriar@users.noreply.github.com>
@xterm/addon-serialize
An addon for xterm.js that enables xterm.js to serialize a terminal framebuffer into string or html. This addon requires xterm.js v4+.
⚠️ This is an experimental addon that is still under construction ⚠️
Install
npm install --save @xterm/addon-serialize
Usage
import { Terminal } from "@xterm/xterm";
import { SerializeAddon } from "@xterm/addon-serialize";
const terminal = new Terminal();
const serializeAddon = new SerializeAddon();
terminal.loadAddon(serializeAddon);
terminal.write("something...", () => {
console.log(serializeAddon.serialize());
});
See the full API for more advanced usage.
Benchmark
⚠️ Ensure you have lolcat, hexdump programs installed in your computer
$ git clone https://github.com/xtermjs/xterm.js.git
$ cd xterm.js
$ npm ci
$ cd addons/addon-serialize
$ npm run benchmark && npm run benchmark-baseline
$ # change some code in `@xterm/addon-serialize`
$ npm run benchmark-eval