cursor-helpers.tsx

import test from 'ava';
import ansiEscapes from 'ansi-escapes';
import {
	cursorPositionChanged,
	buildCursorSuffix,
	buildReturnToBottom,
	buildCursorOnlySequence,
	buildReturnToBottomPrefix,
} from '../src/cursor-helpers.js';

const showCursorEscape = '\u001B[?25h';
const hideCursorEscape = '\u001B[?25l';

// CursorPositionChanged

test('cursorPositionChanged - both undefined returns false', t => {
	t.false(cursorPositionChanged(undefined, undefined));
});

test('cursorPositionChanged - same position returns false', t => {
	t.false(cursorPositionChanged({x: 1, y: 2}, {x: 1, y: 2}));
});

test('cursorPositionChanged - different x returns true', t => {
	t.true(cursorPositionChanged({x: 1, y: 2}, {x: 3, y: 2}));
});

test('cursorPositionChanged - different y returns true', t => {
	t.true(cursorPositionChanged({x: 1, y: 2}, {x: 1, y: 3}));
});

test('cursorPositionChanged - undefined vs defined returns true', t => {
	t.true(cursorPositionChanged(undefined, {x: 0, y: 0}));
	t.true(cursorPositionChanged({x: 0, y: 0}, undefined));
});

// BuildCursorSuffix

test('buildCursorSuffix - returns empty string when cursorPosition is undefined', t => {
	t.is(buildCursorSuffix(3, undefined), '');
});

test('buildCursorSuffix - moves up and positions cursor', t => {
	const result = buildCursorSuffix(3, {x: 5, y: 1});
	t.is(
		result,
		ansiEscapes.cursorUp(2) + ansiEscapes.cursorTo(5) + showCursorEscape,
	);
});

test('buildCursorSuffix - no cursorUp when cursor is at last visible line', t => {
	const result = buildCursorSuffix(3, {x: 0, y: 3});
	t.is(result, ansiEscapes.cursorTo(0) + showCursorEscape);
});

test('buildCursorSuffix - cursor at first line of single-line output', t => {
	const result = buildCursorSuffix(1, {x: 4, y: 0});
	t.is(
		result,
		ansiEscapes.cursorUp(1) + ansiEscapes.cursorTo(4) + showCursorEscape,
	);
});

// BuildReturnToBottom

test('buildReturnToBottom - returns empty string when previousCursorPosition is undefined', t => {
	t.is(buildReturnToBottom(4, undefined), '');
});

test('buildReturnToBottom - moves down to bottom', t => {
	const result = buildReturnToBottom(4, {x: 5, y: 0});
	t.is(result, ansiEscapes.cursorDown(3) + ansiEscapes.cursorTo(0));
});

test('buildReturnToBottom - no cursorDown when cursor already at bottom', t => {
	const result = buildReturnToBottom(4, {x: 0, y: 3});
	t.is(result, ansiEscapes.cursorTo(0));
});

// BuildCursorOnlySequence

test('buildCursorOnlySequence - builds full sequence with hide prefix when cursor was shown', t => {
	const result = buildCursorOnlySequence({
		cursorWasShown: true,
		previousLineCount: 2,
		previousCursorPosition: {x: 0, y: 0},
		cursorPosition: {x: 3, y: 0},
	});
	const expected =
		hideCursorEscape +
		buildReturnToBottom(2, {x: 0, y: 0}) +
		buildCursorSuffix(1, {x: 3, y: 0});
	t.is(result, expected);
});

test('buildCursorOnlySequence - no hide prefix when cursor was not shown', t => {
	const result = buildCursorOnlySequence({
		cursorWasShown: false,
		previousLineCount: 0,
		previousCursorPosition: undefined,
		cursorPosition: {x: 3, y: 0},
	});
	t.false(result.startsWith(hideCursorEscape));
	t.true(result.includes(showCursorEscape));
});

// BuildReturnToBottomPrefix

test('buildReturnToBottomPrefix - returns empty string when cursor was not shown', t => {
	t.is(buildReturnToBottomPrefix(false, 4, {x: 0, y: 0}), '');
});

test('buildReturnToBottomPrefix - returns hide + returnToBottom when cursor was shown', t => {
	const result = buildReturnToBottomPrefix(true, 4, {x: 0, y: 0});
	t.is(result, hideCursorEscape + buildReturnToBottom(4, {x: 0, y: 0}));
});

test('buildReturnToBottomPrefix - with undefined previousCursorPosition still hides cursor', t => {
	const result = buildReturnToBottomPrefix(true, 4, undefined);
	t.is(result, hideCursorEscape + buildReturnToBottom(4, undefined));
});