Files
Codeman/packages/xterm-zerolag-input/test/zerolag-input-addon.test.ts
T
arkonandClaude Opus 4.6 d14ac9de65 feat: add xterm-zerolag-input standalone library
Extract Claudeman's local echo overlay into a reusable xterm.js addon
at packages/xterm-zerolag-input/. Provides instant keystroke feedback
via a DOM overlay, eliminating perceived input latency over high-RTT
connections (SSH, mobile, cloud IDEs).

- Zero dependencies, compatible with xterm v5.x and @xterm/xterm v5.4+
- Configurable prompt detection (character, regex, or custom function)
- Flushed text tracking for tab-switch / deferred echo scenarios
- Per-character grid-aligned rendering matching xterm's canvas output
- 56 tests passing (prompt finder, overlay renderer, full addon lifecycle)
- Dual CJS/ESM build with full TypeScript declarations

Claudeman source is unchanged — migration to consume this lib is a
separate follow-up.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-02-22 10:14:37 +01:00

298 lines
10 KiB
TypeScript

import { describe, it, expect, afterEach } from 'vitest';
import { createMockTerminal } from './helpers.js';
import { ZerolagInputAddon } from '../src/zerolag-input-addon.js';
import type { Terminal } from '../src/types.js';
function setup(lines: string[] = ['$ '], promptChar = '$') {
const mock = createMockTerminal({ buffer: { lines } });
const addon = new ZerolagInputAddon({
prompt: { type: 'character', char: promptChar, offset: 2 },
});
mock.terminal.loadAddon(addon);
return { addon, mock };
}
let cleanups: (() => void)[] = [];
afterEach(() => {
for (const fn of cleanups) fn();
cleanups = [];
});
function tracked(lines?: string[], promptChar?: string) {
const result = setup(lines, promptChar);
cleanups.push(() => {
result.addon.dispose();
result.mock.cleanup();
});
return result;
}
describe('ZerolagInputAddon', () => {
describe('lifecycle', () => {
it('creates overlay element in .xterm-screen', () => {
const { addon, mock } = tracked();
const screen = mock.terminal.element.querySelector('.xterm-screen');
expect(screen!.children.length).toBeGreaterThan(0);
const overlay = screen!.lastElementChild as HTMLDivElement;
expect(overlay.style.zIndex).toBe('7');
expect(overlay.style.display).toBe('none');
addon.dispose();
});
it('dispose removes overlay from DOM', () => {
const { addon, mock } = tracked();
const screen = mock.terminal.element.querySelector('.xterm-screen')!;
const before = screen.children.length;
addon.dispose();
expect(screen.children.length).toBe(before - 1);
});
});
describe('addChar / pendingText', () => {
it('adds characters to pendingText', () => {
const { addon } = tracked();
addon.addChar('a');
addon.addChar('b');
addon.addChar('c');
expect(addon.pendingText).toBe('abc');
});
it('hasPending is true when text exists', () => {
const { addon } = tracked();
expect(addon.hasPending).toBe(false);
addon.addChar('x');
expect(addon.hasPending).toBe(true);
});
});
describe('appendText', () => {
it('appends multiple characters (paste)', () => {
const { addon } = tracked();
addon.addChar('h');
addon.appendText('ello');
expect(addon.pendingText).toBe('hello');
});
it('ignores empty string', () => {
const { addon } = tracked();
addon.appendText('');
expect(addon.pendingText).toBe('');
expect(addon.hasPending).toBe(false);
});
});
describe('removeChar', () => {
it('removes last character from pendingText', () => {
const { addon } = tracked();
addon.addChar('a');
addon.addChar('b');
const removed = addon.removeChar();
expect(removed).toBe(true);
expect(addon.pendingText).toBe('a');
});
it('returns false when nothing to remove', () => {
const { addon } = tracked();
expect(addon.removeChar()).toBe(false);
});
it('decrements flushed when pending is empty', () => {
const { addon } = tracked();
addon.setFlushed(3, 'abc');
expect(addon.removeChar()).toBe(true);
expect(addon.getFlushed().count).toBe(2);
expect(addon.getFlushed().text).toBe('ab');
});
it('removes pending before flushed', () => {
const { addon } = tracked();
addon.setFlushed(2, 'ab');
addon.addChar('c');
expect(addon.removeChar()).toBe(true);
expect(addon.pendingText).toBe('');
expect(addon.getFlushed().count).toBe(2); // flushed unchanged
});
it('hides overlay when both pending and flushed become empty', () => {
const { addon } = tracked();
addon.addChar('x');
addon.removeChar();
expect(addon.hasPending).toBe(false);
});
});
describe('clear', () => {
it('resets all state', () => {
const { addon } = tracked();
addon.setFlushed(3, 'abc');
addon.addChar('d');
addon.clear();
expect(addon.pendingText).toBe('');
expect(addon.getFlushed().count).toBe(0);
expect(addon.getFlushed().text).toBe('');
expect(addon.hasPending).toBe(false);
});
});
describe('flushed text', () => {
it('setFlushed stores count and text', () => {
const { addon } = tracked();
addon.setFlushed(5, 'hello');
expect(addon.getFlushed()).toEqual({ count: 5, text: 'hello' });
expect(addon.hasPending).toBe(true);
});
it('clearFlushed resets flushed state', () => {
const { addon } = tracked();
addon.setFlushed(3, 'abc');
addon.clearFlushed();
expect(addon.getFlushed()).toEqual({ count: 0, text: '' });
});
it('clearFlushed preserves pending text', () => {
const { addon } = tracked();
addon.setFlushed(3, 'abc');
addon.addChar('d');
addon.clearFlushed();
expect(addon.pendingText).toBe('d');
expect(addon.hasPending).toBe(true);
});
});
describe('state snapshot', () => {
it('returns current state', () => {
const { addon } = tracked();
addon.setFlushed(2, 'hi');
addon.addChar('!');
const state = addon.state;
expect(state.pendingText).toBe('!');
expect(state.flushedLength).toBe(2);
expect(state.flushedText).toBe('hi');
});
it('state is read-only copy', () => {
const { addon } = tracked();
addon.addChar('a');
const s1 = addon.state;
addon.addChar('b');
const s2 = addon.state;
expect(s1.pendingText).toBe('a');
expect(s2.pendingText).toBe('ab');
});
});
describe('prompt detection', () => {
it('findPrompt returns position for character prompt', () => {
const { addon } = tracked(['$ hello world']);
const pos = addon.findPrompt();
expect(pos).toEqual({ row: 0, col: 0 });
});
it('findPrompt returns null when no prompt', () => {
const { addon } = tracked(['no prompt here']);
const pos = addon.findPrompt();
expect(pos).toBeNull();
});
it('readPromptText reads text after prompt', () => {
const { addon } = tracked(['$ hello world']);
const text = addon.readPromptText();
expect(text).toBe('hello world');
});
it('readPromptText returns null when no prompt', () => {
const { addon } = tracked(['no prompt']);
const text = addon.readPromptText();
expect(text).toBeNull();
});
});
describe('buffer detection', () => {
it('detectBufferText picks up existing text after prompt', () => {
const { addon } = tracked(['$ existing text']);
const text = addon.detectBufferText();
expect(text).toBe('existing text');
expect(addon.getFlushed().count).toBe(13);
expect(addon.getFlushed().text).toBe('existing text');
});
it('detectBufferText returns null for empty prompt', () => {
const { addon } = tracked(['$ ']);
const text = addon.detectBufferText();
expect(text).toBeNull();
});
it('detectBufferText is guarded (only runs once)', () => {
const { addon } = tracked(['$ text']);
addon.detectBufferText();
addon.clearFlushed(); // clear what was detected
// Should not detect again (guard is set)
const text = addon.detectBufferText();
expect(text).toBeNull();
});
it('resetBufferDetection allows re-detection', () => {
const { addon } = tracked(['$ text']);
addon.detectBufferText();
addon.clearFlushed();
addon.resetBufferDetection();
const text = addon.detectBufferText();
expect(text).toBe('text');
});
it('clear resets buffer detection guard', () => {
const { addon } = tracked(['$ text']);
addon.detectBufferText();
addon.clear();
// After clear, detection should work again
const text = addon.detectBufferText();
expect(text).toBe('text');
});
});
describe('custom prompt configurations', () => {
it('works with > prompt character', () => {
const { addon } = tracked(['> hello'], '>');
const text = addon.readPromptText();
expect(text).toBe('hello');
});
it('works with Unicode prompt', () => {
const mock = createMockTerminal({ buffer: { lines: ['\u276f hello'] } });
const addon = new ZerolagInputAddon({
prompt: { type: 'character', char: '\u276f', offset: 2 },
});
mock.terminal.loadAddon(addon);
cleanups.push(() => { addon.dispose(); mock.cleanup(); });
const text = addon.readPromptText();
expect(text).toBe('hello');
});
});
describe('rerender / refreshFont', () => {
it('rerender does not crash when no text', () => {
const { addon } = tracked();
expect(() => addon.rerender()).not.toThrow();
});
it('refreshFont does not crash', () => {
const { addon } = tracked();
expect(() => addon.refreshFont()).not.toThrow();
});
it('rerender re-renders when hasPending', () => {
const { addon } = tracked();
addon.addChar('x');
expect(() => addon.rerender()).not.toThrow();
expect(addon.hasPending).toBe(true);
});
});
});