waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5559 from Tyriar/2117_2

Browse Source 
Add tests for CSI `Ps K`, `? Ps K`, `Ps S`, `Ps T`, `Ps X`, `Ps Z`, `Ps ^`, `Ps \``
This commit is contained in:
Daniel Imms
2025-12-30 07:06:37 -08:00
committed by GitHub
parent 7d8ef60860 da4243cf02
commit a8f26bb758
3 changed files with 80 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/copilot-instructions.md
+2 -1
View File
@@ -24,7 +24,8 @@ npm run build && npm run esbuild # Build all TypeScript and bundle
- Unit tests filtering to file: `npm run test-unit -- **/fileName.ts
- Per-addon unit tests: `npm run test-unit addons/addon-image/out-esbuild/*.test.js`
- Integration tests: `npm run test-integration` (Playwright across Chrome/Firefox/WebKit)
- Per-addon integration tests: `npm run test-integration --suite=addon-search`
- Integration tests by file: `npm run test-integration -- test/playwright/InputHandler.test.ts`. Never use grep to filter tests, it doesn't work
- Integration tests by addon: `npm run test-integration --suite=addon-search`. Suites always follow the format `addon-<something>`
## Addon Development Pattern
src/common/InputHandler.ts
+1
View File
@@ -240,6 +240,7 @@ export class InputHandler extends Disposable implements IInputHandler {
this._parser.registerCsiHandler({ final: 'T' }, params => this.scrollDown(params));
this._parser.registerCsiHandler({ final: 'X' }, params => this.eraseChars(params));
this._parser.registerCsiHandler({ final: 'Z' }, params => this.cursorBackwardTab(params));
this._parser.registerCsiHandler({ final: '^' }, params => this.scrollDown(params));
this._parser.registerCsiHandler({ final: '`' }, params => this.charPosAbsolute(params));
this._parser.registerCsiHandler({ final: 'a' }, params => this.hPositionRelative(params));
this._parser.registerCsiHandler({ final: 'b' }, params => this.repeatPrecedingCharacter(params));
test/playwright/InputHandler.test.ts
+77 -16
View File
@@ -26,6 +26,7 @@ test.describe('InputHandler Integration Tests', () => {
});
test.beforeEach(async () => {
recordedData.length = 0;
await ctx.proxy.resize(80, 24);
});
test.describe('CSI', () => {
@@ -150,11 +151,41 @@ test.describe('InputHandler Integration Tests', () => {
await pollFor(ctx.page, () => ctx.proxy.buffer.active.length, 5);
await pollFor(ctx.page, () => getLinesAsArray(5), [' 4', ' 5', 'abc', 'def', 'ghi']);
});
test.skip('CSI Ps K - EL: Erase in Line, VT100', async () => {
// TODO: Implement
test('CSI Ps K - EL: Erase in Line, VT100', async () => {
const fixture = 'abcde\x1b[1;3H';
// Default: Erase to Right
await ctx.proxy.write(fixture + '\x1b[K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['ab']);
// 0: Erase to Right
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[0K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['ab']);
// 1: Erase to Left
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[1K');
await pollFor(ctx.page, () => getLinesAsArray(1), [' de']);
// 2: Erase All
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[2K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['']);
});
test.skip('CSI ? Ps K - DECSEL: Erase in Line, VT220', async () => {
// TODO: Implement
test('CSI ? Ps K - DECSEL: Erase in Line, VT220', async () => {
const fixture = 'abcde\x1b[1;3H';
// Default: Erase to Right
await ctx.proxy.write(fixture + '\x1b[?K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['ab']);
// 0: Erase to Right
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[?0K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['ab']);
// 1: Erase to Left
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[?1K');
await pollFor(ctx.page, () => getLinesAsArray(1), [' de']);
// 2: Erase All
await ctx.proxy.reset();
await ctx.proxy.write(fixture + '\x1b[?2K');
await pollFor(ctx.page, () => getLinesAsArray(1), ['']);
});
test('CSI Ps L - IL: Insert Ps Line(s) (default = 1)', async () => {
// Default
@@ -186,14 +217,28 @@ test.describe('InputHandler Integration Tests', () => {
test.skip('CSI # R - XTREPORTCOLORS: Report the current entry on the palette stack, and the number of palettes stored on the stack, using the same form as XTPOPCOLOR (default = 0), xterm', async () => {
// TODO: Implement
});
test.skip('CSI Ps S - SU: Scroll up Ps lines (default = 1), VT420, ECMA-48', async () => {
// TODO: Implement
test('CSI Ps S - SU: Scroll up Ps lines (default = 1), VT420, ECMA-48', async () => {
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await pollFor(ctx.page, () => getLinesAsArray(5), ['1', '2', '3', '4', '5']);
await ctx.proxy.write('\x1b[S');
await pollFor(ctx.page, () => getLinesAsArray(5), ['2', '3', '4', '5', '']);
await ctx.proxy.reset();
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await ctx.proxy.write('\x1b[2S');
await pollFor(ctx.page, () => getLinesAsArray(5), ['3', '4', '5', '', '']);
});
test.skip('CSI ? Pi ; Pa ; Pv S - XTSMGRAPHICS: Set or request graphics attribute, xterm', async () => {
// TODO: Implement
});
test.skip('CSI Ps T - SD: Scroll down Ps lines (default = 1), VT420', async () => {
// TODO: Implement
test('CSI Ps T - SD: Scroll down Ps lines (default = 1), VT420', async () => {
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await pollFor(ctx.page, () => getLinesAsArray(5), ['1', '2', '3', '4', '5']);
await ctx.proxy.write('\x1b[T');
await pollFor(ctx.page, () => getLinesAsArray(5), ['', '1', '2', '3', '4']);
await ctx.proxy.reset();
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await ctx.proxy.write('\x1b[2T');
await pollFor(ctx.page, () => getLinesAsArray(5), ['', '', '1', '2', '3']);
});
test.skip('CSI Ps ; Ps ; Ps ; Ps ; Ps T - XTHIMOUSE: Initiate highlight mouse tracking (XTHIMOUSE), xterm', async () => {
// TODO: Implement
@@ -201,17 +246,33 @@ test.describe('InputHandler Integration Tests', () => {
test.skip('CSI > Pm T - XTRMTITLE: Reset title mode features to default value, xterm', async () => {
// TODO: Implement
});
test.skip('CSI Ps X - ECH: Erase Ps Character(s) (default = 1)', async () => {
// TODO: Implement
test('CSI Ps X - ECH: Erase Ps Character(s) (default = 1)', async () => {
await ctx.proxy.write('abcdef\x1b[1;1H\x1b[X');
await pollFor(ctx.page, () => getLinesAsArray(1), [' bcdef']);
await ctx.proxy.reset();
await ctx.proxy.write('abcdef\x1b[1;1H\x1b[3X');
await pollFor(ctx.page, () => getLinesAsArray(1), [' def']);
});
test.skip('CSI Ps Z - CBT: Cursor Backward Tabulation Ps tab stops (default = 1)', async () => {
// TODO: Implement
test('CSI Ps Z - CBT: Cursor Backward Tabulation Ps tab stops (default = 1)', async () => {
await ctx.proxy.write('\x1b[17Ga\x1b[17G\x1b[Zb');
await pollFor(ctx.page, () => getLinesAsArray(1), [' b a']);
});
test.skip('CSI Ps ^ - SD: Scroll down Ps lines (default = 1) (SD), ECMA-48', async () => {
// TODO: Implement
test('CSI Ps ^ - SD: Scroll down Ps lines (default = 1) (SD), ECMA-48', async () => {
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await pollFor(ctx.page, () => getLinesAsArray(5), ['1', '2', '3', '4', '5']);
await ctx.proxy.write('\x1b[^');
await pollFor(ctx.page, () => getLinesAsArray(5), ['', '1', '2', '3', '4']);
await ctx.proxy.reset();
await ctx.proxy.write('1\r\n2\r\n3\r\n4\r\n5');
await ctx.proxy.write('\x1b[2^');
await pollFor(ctx.page, () => getLinesAsArray(5), ['', '', '1', '2', '3']);
});
test.skip('CSI Ps ` - HPA: Character Position Absolute [column] (default = [row,1])', async () => {
// TODO: Implement
test('CSI Ps ` - HPA: Character Position Absolute [column] (default = [row,1])', async () => {
// Default
await ctx.proxy.write('foo\x1b[`a');
// Explicit
await ctx.proxy.write('\x1b[10`b');
await pollFor(ctx.page, () => getLinesAsArray(1), ['aoo b']);
});
test.skip('CSI Ps a - ', async () => {
// TODO: Implement