cjke-strings/src/test.ts

a set of Chinese Japanese Korean and Emoji strings helpers

import 'mocha';
import { expect } from 'chai';
import { type CodePointInfo, readFirstCompleteChar } from './firstCompleteChar.js';
import 'source-map-support/register.js';
import { unicodeEscape } from './escapeUnicode.js';
import { stringWidth } from './stringWidth.js';
import { limitWidth } from './limitWidth.js';
import { everything, nothing } from './base.js';

function create(char: string, width: number, winCmd = false) {
	let r: CodePointInfo;
	before(() => {
		r = readFirstCompleteChar(`${char}👌~ working ${char}[${unicodeEscape(char)}]`, winCmd ? nothing : everything);
	});
	it(`should catch output of ${JSON.stringify(char)}`, () => {
		expect(r.data).is.equal(char);
	});
	it(`should has length of ${char.length}`, () => {
		expect(r.length).is.equal(char.length);
	});
	it(`should has width of ${width}`, () => {
		expect(r.width).is.equal(width);
	});
}

// basic
describe('Basic', () => {
	describe('Empty string', () => {
		let r: CodePointInfo;
		before(() => {
			r = readFirstCompleteChar('');
		});
		it('should return empty', () => {
			expect(r.data).is.equal('');
		});
		it(`should has length of "0"`, () => {
			expect(r.length).is.equal(0);
		});
		it(`should has width of "0"`, () => {
			expect(r.width).is.equal(0);
		});
	});

	describe('Simple word', () => create('W', 1));
	const colorEscape = '\x1B[38;5;10m';
	describe(`${colorEscape}escape sequence\x1B[0m`, () => create(colorEscape, 0));

	describe('Escape character', () => create('\x1B', 0));
	describe('Line feed', () => create('\r', 0));
	describe('New line', () => create('\n', 0));
	describe('BELL', () => create('\x07', 0));
});

// CJK
describe('CJK', () => {
	describe('chinese word', () => create('啊', 2));
	describe('japanese word', () => create('あ', 2));
	describe('korean word', () => create('깦', 2));
});

// combining
describe('Combining', () => {
	describe('Ansi words', () => create('A\u0300', 1));
	describe('Ansi words (cmd)', () => create('A\u0300', 2, true));

	describe('CJK words', () => create('啊\u0300', 2));
	describe('CJK words (cmd)', () => create('啊\u0300', 3, true));

	describe('Multiple words', () => create('A\u0300\u0300\u0300', 1));
	describe('Multiple words (cmd)', () => create('A\u0300\u0300\u0300', 4, true));

	describe('Character Only', () => create('\u0300', 0));
	describe('Character Only (cmd)', () => create('\u0300', 1, true));

	describe('Multiple characters Only', () => create('\u0300\u0300\u0300', 0));
	describe('Multiple characters Only (cmd)', () => create('\u0300\u0300\u0300', 3, true));
});

// emoji
describe('Emojis', () => {
	describe('😂', () => create('😂', 2));
	describe('👍 (cmd)', () => create('👍', 2, true));

	describe('combined 😂\u0300', () => create('😂\u0300', 2));
	describe('combined 😂\u0300 (cmd)', () => create('😂\u0300', 3, true));

	describe('sequence 👍🏽', () => create('👍🏽', 2));
	describe('sequence 👍🏽 (cmd)', () => create('👍🏽', 4, true));

	describe('combined sequence 👍🏽\u0300', () => create('👍🏽\u0300', 2));
	describe('combined sequence 👍🏽\u0300 (cmd)', () => create('👍🏽\u0300', 5, true));
});
// emoji
describe('Big code page', () => {
	describe('should work', () => create('😂', 2));
});

// basic width counting
describe('#stringWidth', () => {
	describe('Width of 𠮟', () => {
		it('should be 2', () => {
			expect(stringWidth('𠮟')).to.equal(2);
		});
	});
	describe('Width of D834 DD1E', () => {
		it('should be 1', () => {
			expect(stringWidth('\uD834\uDD1E')).to.equal(1);
		});
	});
	describe('Width of D834 DD1E (cmd)', () => {
		it('should be 2', () => {
			expect(stringWidth('\uD834\uDD1E', nothing)).to.equal(2);
		});
	});
	describe('Width of 𠮟👍🏽', () => {
		it('should be 4', () => {
			expect(stringWidth('𠮟👍🏽')).to.equal(4);
		});
	});
	describe('Width of 😂😂😂', () => {
		it('should be 6', () => {
			expect(stringWidth('😂😂😂')).to.equal(6);
		});
	});
	describe('Width of A\u0300', () => {
		it('should be 1', () => {
			expect(stringWidth('A\u0300')).to.equal(1);
		});
	});
	describe('Width of A\u0300 (on cmd)', () => {
		it('should be 2', () => {
			expect(stringWidth('A\u0300', nothing)).to.equal(2);
		});
	});
	describe('Width of 😂\u0300', () => {
		it('should be 2', () => {
			expect(stringWidth('😂\u0300')).to.equal(2);
		});
	});
	describe('Width of 😂\u0300 (on cmd)', () => {
		it('should be 3', () => {
			expect(stringWidth('😂\u0300', nothing)).to.equal(3);
		});
	});
});

// limit width
describe('#limitWidth', () => {
	function repeat(char: string, n: number) {
		return new Array(n).fill('').join(char);
	}

	function limit(s: string, width: number, expectWidth: number, expectLength: number) {
		const ret = limitWidth(s, width);
		expect(ret.result).has.length(expectLength);
		expect(ret.width).to.equal(expectWidth);
	}

	it('can limit ansi', () => {
		limit(repeat('-', 30), 20, 20, 20);
	});
	it('can limit cjk', () => {
		limit(repeat('啊', 30), 20, 20, 10);
		limit(repeat('啊', 30), 19, 18, 9);
	});
	it('can limit simple emoji', () => {
		limit(repeat('😂', 30), 20, 20, 20);
		limit(repeat('😂', 30), 19, 18, 18);
	});
	it('can limit seq emoji', () => {
		limit(repeat('👍🏽', 60), 20, 20, 40);
		limit(repeat('👍🏽', 60), 19, 18, 36);
	});
});