Fix clearing in some cases

Fixes #121

Author: sindresorhus

index.js

@@ -15,6 +15,7 @@ class Ora {
 	#lineCount = 0;
 	#frameIndex = -1;
 	#lastSpinnerFrameTime = 0;
+	#lastIndent = 0;
 	#options;
 	#spinner;
 	#stream;
@@ -162,44 +163,44 @@ class Ora {
 		return this.#id !== undefined;
 	}
 
-	#getFullPrefixText(prefixText = this.#prefixText, postfix = ' ') {
-		if (typeof prefixText === 'string' && prefixText !== '') {
-			return prefixText + postfix;
-		}
-
-		if (typeof prefixText === 'function') {
-			return prefixText() + postfix;
+	#formatAffix(value, separator, placeBefore = false) {
+		const resolved = typeof value === 'function' ? value() : value;
+		if (typeof resolved === 'string' && resolved !== '') {
+			return placeBefore ? (separator + resolved) : (resolved + separator);
 		}
 
 		return '';
 	}
 
+	#getFullPrefixText(prefixText = this.#prefixText, postfix = ' ') {
+		return this.#formatAffix(prefixText, postfix, false);
+	}
+
 	#getFullSuffixText(suffixText = this.#suffixText, prefix = ' ') {
-		if (typeof suffixText === 'string' && suffixText !== '') {
-			return prefix + suffixText;
-		}
+		return this.#formatAffix(suffixText, prefix, true);
+	}
 
-		if (typeof suffixText === 'function') {
-			return prefix + suffixText();
+	#computeLineCountFrom(text, columns) {
+		let count = 0;
+		for (const line of stripAnsi(text).split('\n')) {
+			count += Math.max(1, Math.ceil(stringWidth(line) / columns));
 		}
 
-		return '';
+		return count;
 	}
 
 	#updateLineCount() {
 		const columns = this.#stream.columns ?? 80;
 
-		// Use simple approximations for line calculation to avoid calling functions
+		// Simple side-effect free approximation (do not call functions)
 		const prefixText = typeof this.#prefixText === 'function' ? '' : this.#prefixText;
 		const suffixText = typeof this.#suffixText === 'function' ? '' : this.#suffixText;
-		const fullPrefixText = (typeof prefixText === 'string' && prefixText !== '') ? prefixText + '-' : '';
-		const fullSuffixText = (typeof suffixText === 'string' && suffixText !== '') ? '-' + suffixText : '';
-		const fullText = ' '.repeat(this.#indent) + fullPrefixText + '--' + this.#text + '--' + fullSuffixText;
+		const fullPrefixText = (typeof prefixText === 'string' && prefixText !== '') ? prefixText + ' ' : '';
+		const fullSuffixText = (typeof suffixText === 'string' && suffixText !== '') ? ' ' + suffixText : '';
+		const spinnerChar = '-';
+		const fullText = ' '.repeat(this.#indent) + fullPrefixText + spinnerChar + (typeof this.#text === 'string' ? ' ' + this.#text : '') + fullSuffixText;
 
-		this.#lineCount = 0;
-		for (const line of stripAnsi(fullText).split('\n')) {
-			this.#lineCount += Math.max(1, Math.ceil(stringWidth(line, {countAnsiEscapeCodes: true}) / columns));
-		}
+		this.#lineCount = this.#computeLineCountFrom(fullText, columns);
 	}
 
 	get isEnabled() {
@@ -264,11 +265,11 @@ class Ora {
 			this.#stream.clearLine(1);
 		}
 
-		if (this.#indent || this.lastIndent !== this.#indent) {
+		if (this.#indent || this.#lastIndent !== this.#indent) {
 			this.#stream.cursorTo(this.#indent);
 		}
 
-		this.lastIndent = this.#indent;
+		this.#lastIndent = this.#indent;
 		this.#linesToClear = 0;
 
 		return this;
@@ -282,15 +283,16 @@ class Ora {
 		this.clear();
 
 		let frameContent = this.frame();
-		let actualLineCount = this.#lineCount;
+		const columns = this.#stream.columns ?? 80;
+		let actualLineCount = this.#computeLineCountFrom(frameContent, columns);
 
 		// If content would exceed viewport height, truncate it to prevent garbage
 		const consoleHeight = this.#stream.rows;
-		if (consoleHeight && consoleHeight > 1 && this.#lineCount > consoleHeight) {
+		if (consoleHeight && consoleHeight > 1 && actualLineCount > consoleHeight) {
 			const lines = frameContent.split('\n');
 			const maxLines = consoleHeight - 1; // Reserve one line for truncation message
 			frameContent = [...lines.slice(0, maxLines), '... (content truncated to fit terminal)'].join('\n');
-			actualLineCount = maxLines + 1; // Truncated lines + message line
+			actualLineCount = this.#computeLineCountFrom(frameContent, columns);
 		}
 
 		this.#stream.write(frameContent);

index.test-d.ts

@@ -13,6 +13,7 @@ ora({spinner: 'squish'});
 ora({spinner: {frames: ['-', '+', '-']}});
 ora({spinner: {interval: 80, frames: ['-', '+', '-']}});
 ora({color: 'cyan'});
+ora({color: false});
 ora({hideCursor: true});
 ora({indent: 1});
 ora({interval: 80});
@@ -22,6 +23,7 @@ ora({isSilent: false});
 ora({discardStdin: true});
 
 spinner.color = 'yellow';
+spinner.color = false;
 spinner.text = 'Loading rainbows';
 expectType<boolean>(spinner.isSpinning);
 spinner.spinner = 'dots';

readme.md

@@ -80,7 +80,7 @@ Type: `string | boolean`\
 Default: `'cyan'`\
 Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | boolean`
 
-The color of the spinner.
+The color of the spinner. Set to `false` to disable coloring.
 
 ##### hideCursor
 

test.js

@@ -434,6 +434,18 @@ test('.stopAndPersist() with prefixText and suffixText', macro, spinner => {
 	spinner.stopAndPersist({symbol: '@', text: 'foo'});
 }, /bar @ foo baz\n$/, {prefixText: 'bar', suffixText: 'baz'});
 
+test('.stopAndPersist() with dynamic prefixText and suffixText', macro, spinner => {
+	spinner.stopAndPersist({symbol: '#', text: 'work'});
+}, /pre # work post\n$/, {prefixText: () => 'pre', suffixText: () => 'post'});
+
+test('.stopAndPersist() with dynamic empty prefixText and suffixText has no stray spaces', macro, spinner => {
+	spinner.stopAndPersist({symbol: '#', text: 'work'});
+}, /# work\n$/, {prefixText: () => '', suffixText: () => ''});
+
+test('.stopAndPersist() with empty symbol does not add separator', macro, spinner => {
+	spinner.stopAndPersist({symbol: '', text: 'done'});
+}, /done\n$/, {});
+
 // New clear method tests
 
 const currentClearMethod = transFormTTY => {
@@ -1173,6 +1185,79 @@ test('frame() should display both dynamic prefixText and suffixText from functio
 	t.not(frame1, frame2);
 });
 
+test('frame() should not add leading space when prefixText() returns empty', t => {
+	const spinner = ora({
+		text: 'test',
+		prefixText: () => '',
+		color: false,
+	});
+
+	const frame = spinner.frame();
+	// First character should be the spinner frame, not a space
+	t.not(frame[0], ' ');
+});
+
+test('frame() should not add trailing space when suffixText() returns empty', t => {
+	const spinner = ora({
+		text: 'test',
+		suffixText: () => '',
+		color: false,
+	});
+
+	const frame = spinner.frame();
+	t.false(frame.endsWith(' '));
+});
+
+test('render() uses actual content for line counts with dynamic prefixText', t => {
+	const stream = getPassThroughStream();
+	stream.isTTY = true;
+	stream.columns = 10;
+
+	let call = 0;
+	const spinner = ora({
+		stream,
+		text: 'hello',
+		prefixText() {
+			call++;
+			return call === 1 ? 'p' : 'pppppppppppp';
+		},
+		color: false,
+		isEnabled: true,
+	});
+
+	spinner.render();
+	const first = spinner._linesToClear;
+	spinner.render();
+	const second = spinner._linesToClear;
+
+	t.true(second >= first);
+});
+
+test('render() uses actual content for line counts with dynamic suffixText', t => {
+	const stream = getPassThroughStream();
+	stream.isTTY = true;
+	stream.columns = 10;
+
+	let call = 0;
+	const spinner = ora({
+		stream,
+		text: 'hello',
+		suffixText() {
+			call++;
+			return call === 1 ? '' : 'ssssssssssss';
+		},
+		color: false,
+		isEnabled: true,
+	});
+
+	spinner.render();
+	const first = spinner._linesToClear;
+	spinner.render();
+	const second = spinner._linesToClear;
+
+	t.true(second >= first);
+});
+
 test('frame() should handle mixed static and dynamic text', t => {
 	let counter = 0;
 	const spinner = ora({
@@ -1236,3 +1321,56 @@ test('frame() functions should only be called during frame() execution, not duri
 	t.is(constructorCalls, 2);
 	t.true(frame2.includes('Called 2'));
 });
+
+test('updateLineCount() does not call prefix/suffix functions when changing text', t => {
+	let calls = 0;
+	const spinner = ora({
+		text: 'test',
+		prefixText() {
+			calls++;
+			return 'pref';
+		},
+		suffixText() {
+			calls++;
+			return 'suf';
+		},
+		color: false,
+	});
+
+	// Change text which triggers #updateLineCount(); functions must not run
+	spinner.text = 'changed';
+	t.is(calls, 0);
+
+	// Only frame() should call them
+	spinner.frame();
+	t.is(calls, 2);
+});
+
+test('dynamic prefix can trigger truncation', t => {
+	const stream = getPassThroughStream();
+	stream.rows = 5;
+	stream.columns = 80;
+	stream.isTTY = true;
+
+	let wrote = '';
+	const originalWrite = stream.write;
+	stream.write = function (content) {
+		wrote = content;
+		return originalWrite.call(this, content);
+	};
+
+	const spinner = ora({
+		stream,
+		text: 'base',
+		prefixText: () => Array.from({length: 20}, (_, i) => `L${i + 1}`).join('\n'),
+		color: false,
+		isEnabled: true,
+	});
+
+	spinner.start();
+	spinner.render();
+
+	t.true(wrote.includes('(content truncated to fit terminal)'));
+
+	spinner.stop();
+});