Cursor AgentandDaniel Imms
c569e5ab19
- Add composite TypeScript projects for common/primitives and common/runtime - Decouple primitives from runtime (buffer service interfaces, UnicodeProperties, CellTypes, etc.) - Move Types.ts to runtime; re-export primitive types from runtime/Types - Rename src/browser -> src/target-browser, src/headless -> src/target-headless - Update import paths (target-browser/*, target-headless/*) across repo - Fix esbuild outbase so common/* and target-* resolve under out-esbuild/ - Point unicode addons at primitives for UnicodeTypes/UnicodeProperties - Update ARCHITECTURE.md and AGENTS.md 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