@depup/ora 9.3.0-depup.0

package/index.d.ts

@@ -0,0 +1,334 @@
+import {type SpinnerName} from 'cli-spinners';
+
+export type Spinner = {
+	readonly interval?: number;
+	readonly frames: string[];
+};
+
+export type Color =
+	| 'black'
+	| 'red'
+	| 'green'
+	| 'yellow'
+	| 'blue'
+	| 'magenta'
+	| 'cyan'
+	| 'white'
+	| 'gray';
+
+export type PrefixTextGenerator = () => string;
+
+export type SuffixTextGenerator = () => string;
+
+export type Options = {
+	/**
+	The text to display next to the spinner.
+	*/
+	readonly text?: string;
+
+	/**
+	Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.
+	*/
+	readonly prefixText?: string | PrefixTextGenerator;
+
+	/**
+	Text or a function that returns text to display after the spinner text. No suffix text will be displayed if set to an empty string.
+	*/
+	readonly suffixText?: string | SuffixTextGenerator;
+
+	/**
+	The name of one of the provided spinners. See `example.js` in this repo if you want to test out different spinners. On Windows (except for Windows Terminal), it will always use the line spinner as the Windows command-line doesn't have proper Unicode support.
+
+	@default 'dots'
+
+	Or an object like:
+
+	@example
+	```
+	{
+		frames: ['-', '+', '-'],
+		interval: 80 // Optional
+	}
+	```
+	*/
+	readonly spinner?: SpinnerName | Spinner;
+
+	/**
+	The color of the spinner.
+
+	@default 'cyan'
+	*/
+	readonly color?: Color | boolean;
+
+	/**
+	Set to `false` to stop Ora from hiding the cursor.
+
+	@default true
+	*/
+	readonly hideCursor?: boolean;
+
+	/**
+	Indent the spinner with the given number of spaces.
+
+	@default 0
+	*/
+	readonly indent?: number;
+
+	/**
+	Interval between each frame.
+
+	Spinners provide their own recommended interval, so you don't really need to specify this.
+
+	Default: Provided by the spinner or `100`.
+	*/
+	readonly interval?: number;
+
+	/**
+	Stream to write the output.
+
+	You could for example set this to `process.stdout` instead.
+
+	@default process.stderr
+	*/
+	readonly stream?: NodeJS.WritableStream;
+
+	/**
+	Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
+
+	Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text.
+	*/
+	readonly isEnabled?: boolean;
+
+	/**
+	Disable the spinner and all log text. All output is suppressed and `isEnabled` will be considered `false`.
+
+	@default false
+	*/
+	readonly isSilent?: boolean;
+
+	/**
+	Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on `Enter` key presses, and prevents buffering of input while the spinner is running.
+
+	This has no effect on Windows as there is no good way to implement discarding stdin properly there.
+
+	Note: `discardStdin` puts stdin into raw mode. In raw mode, `Ctrl+C` no longer generates `SIGINT` from the terminal. Ora re-emits `Ctrl+C` from stdin input, but if your code blocks the event loop with synchronous work, `Ctrl+C` handling is delayed until the blocking work ends. Use async APIs, a worker thread, or a child process to keep `Ctrl+C` responsive, or set `discardStdin` to `false`.
+
+	@default true
+	*/
+	readonly discardStdin?: boolean;
+};
+
+export type PersistOptions = {
+	/**
+	Symbol to replace the spinner with.
+
+	@default ' '
+	*/
+	readonly symbol?: string;
+
+	/**
+	Text to be persisted after the symbol.
+
+	Default: Current `text`.
+	*/
+	readonly text?: string;
+
+	/**
+	Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string.
+
+	Default: Current `prefixText`.
+	*/
+	readonly prefixText?: string | PrefixTextGenerator;
+
+	/**
+	Text or a function that returns text to be persisted after the text after the symbol. No suffix text will be displayed if set to an empty string.
+
+	Default: Current `suffixText`.
+	*/
+	readonly suffixText?: string | SuffixTextGenerator;
+};
+
+export type PromiseOptions<T> = {
+	/**
+	The new text of the spinner when the promise is resolved.
+
+	Keeps the existing text if `undefined`.
+	*/
+	successText?: string | ((result: T) => string) | undefined;
+
+	/**
+	The new text of the spinner when the promise is rejected.
+
+	Keeps the existing text if `undefined`.
+	*/
+	failText?: string | ((error: Error) => string) | undefined;
+} & Options;
+
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export interface Ora {
+	/**
+	Change the text after the spinner.
+	*/
+	text: string;
+
+	/**
+	Change the text or function that returns text before the spinner.
+
+	No prefix text will be displayed if set to an empty string.
+	*/
+	prefixText: string;
+
+	/**
+	Change the text or function that returns text after the spinner text.
+
+	No suffix text will be displayed if set to an empty string.
+	*/
+	suffixText: string;
+
+	/**
+	Change the spinner color.
+	*/
+	color: Color | boolean;
+
+	/**
+	Change the spinner indent.
+	*/
+	indent: number;
+
+	/**
+	Get the spinner.
+	*/
+	get spinner(): Spinner;
+
+	/**
+	Set the spinner.
+	*/
+	set spinner(spinner: SpinnerName | Spinner);
+
+	/**
+	A boolean indicating whether the instance is currently spinning.
+	*/
+	get isSpinning(): boolean;
+
+	/**
+	The interval between each frame.
+
+	The interval is decided by the chosen spinner.
+	*/
+	get interval(): number;
+
+	/**
+	Start the spinner.
+
+	@param text - Set the current text.
+	@returns The spinner instance.
+	*/
+	start(text?: string): this;
+
+	/**
+	Stop and clear the spinner.
+
+	@returns The spinner instance.
+	*/
+	stop(): this;
+
+	/**
+	Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided.
+
+	@param text - Will persist text if provided.
+	@returns The spinner instance.
+	*/
+	succeed(text?: string): this;
+
+	/**
+	Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided.
+
+	@param text - Will persist text if provided.
+	@returns The spinner instance.
+	*/
+	fail(text?: string): this;
+
+	/**
+	Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided.
+
+	@param text - Will persist text if provided.
+	@returns The spinner instance.
+	*/
+	warn(text?: string): this;
+
+	/**
+	Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided.
+
+	@param text - Will persist text if provided.
+	@returns The spinner instance.
+	*/
+	info(text?: string): this;
+
+	/**
+	Stop the spinner and change the symbol or text.
+
+	@returns The spinner instance.
+	*/
+	stopAndPersist(options?: PersistOptions): this;
+
+	/**
+	Clear the spinner.
+
+	@returns The spinner instance.
+	*/
+	clear(): this;
+
+	/**
+	Manually render a new frame.
+
+	@returns The spinner instance.
+	*/
+	render(): this;
+
+	/**
+	Get a new frame.
+
+	@returns The spinner instance text.
+	*/
+	frame(): string;
+}
+
+/**
+Elegant terminal spinner.
+
+@param options - If a string is provided, it is treated as a shortcut for `options.text`.
+
+@example
+```
+import ora from 'ora';
+
+const spinner = ora('Loading unicorns').start();
+
+setTimeout(() => {
+	spinner.color = 'yellow';
+	spinner.text = 'Loading rainbows';
+}, 1000);
+```
+*/
+export default function ora(options?: string | Options): Ora;
+
+/**
+Starts a spinner for a promise or promise-returning function. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects.
+
+@param action - The promise to start the spinner for or a promise-returning function.
+@param options - If a string is provided, it is treated as a shortcut for `options.text`.
+@returns The given promise.
+
+@example
+```
+import {oraPromise} from 'ora';
+
+await oraPromise(somePromise);
+```
+*/
+export function oraPromise<T>(
+	action: PromiseLike<T> | ((spinner: Ora) => PromiseLike<T>),
+	options?: string | PromiseOptions<T>
+): Promise<T>;
+
+export {default as spinners} from 'cli-spinners';

package/index.js

@@ -0,0 +1,633 @@
+import process from 'node:process';
+import {stripVTControlCharacters} from 'node:util';
+import chalk from 'chalk';
+import cliCursor from 'cli-cursor';
+import cliSpinners from 'cli-spinners';
+import logSymbols from 'log-symbols';
+import stringWidth from 'string-width';
+import isInteractive from 'is-interactive';
+import isUnicodeSupported from 'is-unicode-supported';
+import stdinDiscarder from 'stdin-discarder';
+
+// Constants
+const RENDER_DEFERRAL_TIMEOUT = 200; // Milliseconds to wait before re-rendering after partial chunk write
+const SYNCHRONIZED_OUTPUT_ENABLE = '\u001B[?2026h';
+const SYNCHRONIZED_OUTPUT_DISABLE = '\u001B[?2026l';
+
+// Global state for concurrent spinner detection
+const activeHooksPerStream = new Map(); // Stream → ora instance
+
+class Ora {
+	#linesToClear = 0;
+	#frameIndex = -1;
+	#lastFrameTime = 0;
+	#options;
+	#spinner;
+	#stream;
+	#id;
+	#hookedStreams = new Map();
+	#isInternalWrite = false;
+	#drainHandler;
+	#deferRenderTimer;
+	#isDiscardingStdin = false;
+	color;
+
+	// Helper to execute writes while preventing hook recursion
+	#internalWrite(fn) {
+		this.#isInternalWrite = true;
+		try {
+			return fn();
+		} finally {
+			this.#isInternalWrite = false;
+		}
+	}
+
+	// Helper to render if still spinning
+	#tryRender() {
+		if (this.isSpinning) {
+			this.render();
+		}
+	}
+
+	#stringifyChunk(chunk, encoding) {
+		if (chunk === undefined || chunk === null) {
+			return '';
+		}
+
+		if (typeof chunk === 'string') {
+			return chunk;
+		}
+
+		/* eslint-disable n/prefer-global/buffer */
+		if (Buffer.isBuffer(chunk) || ArrayBuffer.isView(chunk)) {
+			const normalizedEncoding = (typeof encoding === 'string' && encoding && encoding !== 'buffer') ? encoding : 'utf8';
+			return Buffer.from(chunk).toString(normalizedEncoding);
+		}
+		/* eslint-enable n/prefer-global/buffer */
+
+		return String(chunk);
+	}
+
+	#chunkTerminatesLine(chunkString) {
+		if (!chunkString) {
+			return false;
+		}
+
+		const lastCharacter = chunkString.at(-1);
+		return lastCharacter === '\n' || lastCharacter === '\r';
+	}
+
+	#scheduleRenderDeferral() {
+		// If already deferred, don't reset timer - let it complete
+		if (this.#deferRenderTimer) {
+			return;
+		}
+
+		this.#deferRenderTimer = setTimeout(() => {
+			this.#deferRenderTimer = undefined;
+
+			if (this.isSpinning) {
+				this.#tryRender();
+			}
+		}, RENDER_DEFERRAL_TIMEOUT);
+
+		if (typeof this.#deferRenderTimer?.unref === 'function') {
+			this.#deferRenderTimer.unref();
+		}
+	}
+
+	#clearRenderDeferral() {
+		if (this.#deferRenderTimer) {
+			clearTimeout(this.#deferRenderTimer);
+			this.#deferRenderTimer = undefined;
+		}
+	}
+
+	// Helper to build complete line with symbol, text, prefix, and suffix
+	#buildOutputLine(symbol, text, prefixText, suffixText) {
+		const fullPrefixText = this.#getFullPrefixText(prefixText, ' ');
+		const separatorText = symbol ? ' ' : '';
+		const fullText = (typeof text === 'string') ? separatorText + text : '';
+		const fullSuffixText = this.#getFullSuffixText(suffixText, ' ');
+		return fullPrefixText + symbol + fullText + fullSuffixText;
+	}
+
+	constructor(options) {
+		if (typeof options === 'string') {
+			options = {
+				text: options,
+			};
+		}
+
+		this.#options = {
+			color: 'cyan',
+			stream: process.stderr,
+			discardStdin: true,
+			hideCursor: true,
+			...options,
+		};
+
+		// Public
+		this.color = this.#options.color;
+
+		this.#stream = this.#options.stream;
+
+		// Normalize isEnabled and isSilent into options
+		if (typeof this.#options.isEnabled !== 'boolean') {
+			this.#options.isEnabled = isInteractive({stream: this.#stream});
+		}
+
+		if (typeof this.#options.isSilent !== 'boolean') {
+			this.#options.isSilent = false;
+		}
+
+		// Set *after* `this.#stream`.
+		// Store original interval before spinner setter clears it
+		const userInterval = this.#options.interval;
+		// It's important that these use the public setters.
+		this.spinner = this.#options.spinner;
+		this.#options.interval = userInterval;
+		this.text = this.#options.text;
+		this.prefixText = this.#options.prefixText;
+		this.suffixText = this.#options.suffixText;
+		this.indent = this.#options.indent;
+
+		if (process.env.NODE_ENV === 'test') {
+			this._stream = this.#stream;
+			this._isEnabled = this.#options.isEnabled;
+
+			Object.defineProperty(this, '_linesToClear', {
+				get() {
+					return this.#linesToClear;
+				},
+				set(newValue) {
+					this.#linesToClear = newValue;
+				},
+			});
+
+			Object.defineProperty(this, '_frameIndex', {
+				get() {
+					return this.#frameIndex;
+				},
+			});
+
+			Object.defineProperty(this, '_lineCount', {
+				get() {
+					const columns = this.#stream.columns ?? 80;
+					const prefixText = typeof this.#options.prefixText === 'function' ? '' : this.#options.prefixText;
+					const suffixText = typeof this.#options.suffixText === 'function' ? '' : this.#options.suffixText;
+					const fullPrefixText = (typeof prefixText === 'string' && prefixText !== '') ? prefixText + ' ' : '';
+					const fullSuffixText = (typeof suffixText === 'string' && suffixText !== '') ? ' ' + suffixText : '';
+					const spinnerChar = '-';
+					const fullText = ' '.repeat(this.#options.indent) + fullPrefixText + spinnerChar + (typeof this.#options.text === 'string' ? ' ' + this.#options.text : '') + fullSuffixText;
+					return this.#computeLineCountFrom(fullText, columns);
+				},
+			});
+		}
+	}
+
+	get indent() {
+		return this.#options.indent;
+	}
+
+	set indent(indent = 0) {
+		if (!(indent >= 0 && Number.isInteger(indent))) {
+			throw new Error('The `indent` option must be an integer from 0 and up');
+		}
+
+		this.#options.indent = indent;
+	}
+
+	get interval() {
+		return this.#options.interval ?? this.#spinner.interval ?? 100;
+	}
+
+	get spinner() {
+		return this.#spinner;
+	}
+
+	set spinner(spinner) {
+		this.#frameIndex = -1;
+		this.#options.interval = undefined;
+
+		if (typeof spinner === 'object') {
+			if (!Array.isArray(spinner.frames) || spinner.frames.length === 0 || spinner.frames.some(frame => typeof frame !== 'string')) {
+				throw new Error('The given spinner must have a non-empty `frames` array of strings');
+			}
+
+			if (spinner.interval !== undefined && !(Number.isInteger(spinner.interval) && spinner.interval > 0)) {
+				throw new Error('`spinner.interval` must be a positive integer if provided');
+			}
+
+			this.#spinner = spinner;
+		} else if (!isUnicodeSupported()) {
+			this.#spinner = cliSpinners.line;
+		} else if (spinner === undefined) {
+			// Set default spinner
+			this.#spinner = cliSpinners.dots;
+		} else if (spinner !== 'default' && cliSpinners[spinner]) {
+			this.#spinner = cliSpinners[spinner];
+		} else {
+			throw new Error(`There is no built-in spinner named '${spinner}'. See https://github.com/sindresorhus/cli-spinners/blob/main/spinners.json for a full list.`);
+		}
+	}
+
+	get text() {
+		return this.#options.text;
+	}
+
+	set text(value = '') {
+		this.#options.text = value;
+	}
+
+	get prefixText() {
+		return this.#options.prefixText;
+	}
+
+	set prefixText(value = '') {
+		this.#options.prefixText = value;
+	}
+
+	get suffixText() {
+		return this.#options.suffixText;
+	}
+
+	set suffixText(value = '') {
+		this.#options.suffixText = value;
+	}
+
+	get isSpinning() {
+		return this.#id !== undefined;
+	}
+
+	#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.#options.prefixText, postfix = ' ') {
+		return this.#formatAffix(prefixText, postfix, false);
+	}
+
+	#getFullSuffixText(suffixText = this.#options.suffixText, prefix = ' ') {
+		return this.#formatAffix(suffixText, prefix, true);
+	}
+
+	#computeLineCountFrom(text, columns) {
+		let count = 0;
+		for (const line of stripVTControlCharacters(text).split('\n')) {
+			count += Math.max(1, Math.ceil(stringWidth(line) / columns));
+		}
+
+		return count;
+	}
+
+	get isEnabled() {
+		return this.#options.isEnabled && !this.#options.isSilent;
+	}
+
+	set isEnabled(value) {
+		if (typeof value !== 'boolean') {
+			throw new TypeError('The `isEnabled` option must be a boolean');
+		}
+
+		this.#options.isEnabled = value;
+	}
+
+	get isSilent() {
+		return this.#options.isSilent;
+	}
+
+	set isSilent(value) {
+		if (typeof value !== 'boolean') {
+			throw new TypeError('The `isSilent` option must be a boolean');
+		}
+
+		this.#options.isSilent = value;
+	}
+
+	frame() {
+		// Only advance frame if enough time has passed (throttle to interval)
+		const now = Date.now();
+		if (this.#frameIndex === -1 || now - this.#lastFrameTime >= this.interval) {
+			this.#frameIndex = (this.#frameIndex + 1) % this.#spinner.frames.length;
+			this.#lastFrameTime = now;
+		}
+
+		const {frames} = this.#spinner;
+		let frame = frames[this.#frameIndex];
+
+		if (this.color) {
+			frame = chalk[this.color](frame);
+		}
+
+		const fullPrefixText = this.#getFullPrefixText(this.#options.prefixText, ' ');
+		const fullText = typeof this.text === 'string' ? ' ' + this.text : '';
+		const fullSuffixText = this.#getFullSuffixText(this.#options.suffixText, ' ');
+
+		return fullPrefixText + frame + fullText + fullSuffixText;
+	}
+
+	clear() {
+		if (!this.isEnabled || !this.#stream.isTTY) {
+			return this;
+		}
+
+		// Protect cursor control methods (cursorTo, moveCursor, clearLine) which internally call stream.write
+		this.#internalWrite(() => {
+			this.#stream.cursorTo(0);
+
+			for (let index = 0; index < this.#linesToClear; index++) {
+				if (index > 0) {
+					this.#stream.moveCursor(0, -1);
+				}
+
+				this.#stream.clearLine(1);
+			}
+
+			if (this.#options.indent) {
+				this.#stream.cursorTo(this.#options.indent);
+			}
+		});
+
+		this.#linesToClear = 0;
+
+		return this;
+	}
+
+	// Helper to hook a single stream
+	#hookStream(stream) {
+		if (!stream || this.#hookedStreams.has(stream) || !stream.isTTY || typeof stream.write !== 'function') {
+			return;
+		}
+
+		// Detect concurrent spinners
+		if (activeHooksPerStream.has(stream)) {
+			console.warn('[ora] Multiple concurrent spinners detected. This may cause visual corruption. Use one spinner at a time.');
+		}
+
+		const originalWrite = stream.write;
+		this.#hookedStreams.set(stream, originalWrite);
+		activeHooksPerStream.set(stream, this);
+		stream.write = (chunk, encoding, callback) => this.#hookedWrite(stream, originalWrite, chunk, encoding, callback);
+	}
+
+	/**
+	Intercept stream writes while spinner is active to handle external writes cleanly without visual corruption.
+	Hooks process stdio streams and the active spinner stream so console.log(), console.error(), and direct writes stay tidy.
+	*/
+	#installHook() {
+		if (!this.isEnabled || this.#hookedStreams.size > 0) {
+			return;
+		}
+
+		const streamsToHook = new Set([this.#stream, process.stdout, process.stderr]);
+
+		for (const stream of streamsToHook) {
+			this.#hookStream(stream);
+		}
+	}
+
+	#uninstallHook() {
+		for (const [stream, originalWrite] of this.#hookedStreams) {
+			stream.write = originalWrite;
+			if (activeHooksPerStream.get(stream) === this) {
+				activeHooksPerStream.delete(stream);
+			}
+		}
+
+		this.#hookedStreams.clear();
+	}
+
+	// eslint-disable-next-line max-params -- Need stream and originalWrite for multi-stream support
+	#hookedWrite(stream, originalWrite, chunk, encoding, callback) {
+		// Handle both write(chunk, encoding, callback) and write(chunk, callback) signatures
+		if (typeof encoding === 'function') {
+			callback = encoding;
+			encoding = undefined;
+		}
+
+		// Pass through our own internal writes (spinner rendering, cursor control)
+		if (this.#isInternalWrite) {
+			return originalWrite.call(stream, chunk, encoding, callback);
+		}
+
+		// External write detected - clear spinner, write content, re-render if appropriate
+		this.clear();
+
+		const chunkString = this.#stringifyChunk(chunk, encoding);
+		const chunkTerminatesLine = this.#chunkTerminatesLine(chunkString);
+
+		const writeResult = originalWrite.call(stream, chunk, encoding, callback);
+
+		// Schedule or clear render deferral based on chunk content
+		if (chunkTerminatesLine) {
+			this.#clearRenderDeferral();
+		} else if (chunkString.length > 0) {
+			this.#scheduleRenderDeferral();
+		}
+
+		// Re-render spinner below the new output if still spinning and not deferred
+		if (this.isSpinning && !this.#deferRenderTimer) {
+			this.render();
+		}
+
+		return writeResult;
+	}
+
+	render() {
+		if (!this.isEnabled || this.#drainHandler || this.#deferRenderTimer) {
+			return this;
+		}
+
+		const useSynchronizedOutput = this.#stream.isTTY;
+		let shouldDisableSynchronizedOutput = false;
+
+		try {
+			if (useSynchronizedOutput) {
+				this.#internalWrite(() => this.#stream.write(SYNCHRONIZED_OUTPUT_ENABLE));
+				shouldDisableSynchronizedOutput = true;
+			}
+
+			this.clear();
+
+			let frameContent = this.frame();
+			const columns = this.#stream.columns ?? 80;
+			const 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 && 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');
+			}
+
+			const canContinue = this.#internalWrite(() => this.#stream.write(frameContent));
+
+			// Handle backpressure - pause rendering if stream buffer is full
+			if (canContinue === false && this.#stream.isTTY) {
+				this.#drainHandler = () => {
+					this.#drainHandler = undefined;
+					this.#tryRender();
+				};
+
+				this.#stream.once('drain', this.#drainHandler);
+			}
+
+			this.#linesToClear = this.#computeLineCountFrom(frameContent, columns);
+		} finally {
+			if (shouldDisableSynchronizedOutput) {
+				this.#internalWrite(() => this.#stream.write(SYNCHRONIZED_OUTPUT_DISABLE));
+			}
+		}
+
+		return this;
+	}
+
+	start(text) {
+		if (text) {
+			this.text = text;
+		}
+
+		if (this.isSilent) {
+			return this;
+		}
+
+		if (!this.isEnabled) {
+			const symbol = this.text ? '-' : '';
+			const line = ' '.repeat(this.#options.indent) + this.#buildOutputLine(symbol, this.text, this.#options.prefixText, this.#options.suffixText);
+
+			if (line.trim() !== '') {
+				this.#internalWrite(() => this.#stream.write(line + '\n'));
+			}
+
+			return this;
+		}
+
+		if (this.isSpinning) {
+			return this;
+		}
+
+		if (this.#options.hideCursor) {
+			cliCursor.hide(this.#stream);
+		}
+
+		if (this.#options.discardStdin && process.stdin.isTTY) {
+			stdinDiscarder.start();
+			this.#isDiscardingStdin = true;
+		}
+
+		this.#installHook();
+		this.render();
+		this.#id = setInterval(this.render.bind(this), this.interval);
+
+		return this;
+	}
+
+	stop() {
+		clearInterval(this.#id);
+		this.#id = undefined;
+		this.#frameIndex = -1;
+		this.#lastFrameTime = 0;
+
+		this.#clearRenderDeferral();
+		this.#uninstallHook();
+
+		// Clean up drain handler if it exists
+		if (this.#drainHandler) {
+			this.#stream.removeListener('drain', this.#drainHandler);
+			this.#drainHandler = undefined;
+		}
+
+		if (this.isEnabled) {
+			this.clear();
+			if (this.#options.hideCursor) {
+				cliCursor.show(this.#stream);
+			}
+		}
+
+		if (this.#isDiscardingStdin) {
+			this.#isDiscardingStdin = false;
+			stdinDiscarder.stop();
+		}
+
+		return this;
+	}
+
+	succeed(text) {
+		return this.stopAndPersist({symbol: logSymbols.success, text});
+	}
+
+	fail(text) {
+		return this.stopAndPersist({symbol: logSymbols.error, text});
+	}
+
+	warn(text) {
+		return this.stopAndPersist({symbol: logSymbols.warning, text});
+	}
+
+	info(text) {
+		return this.stopAndPersist({symbol: logSymbols.info, text});
+	}
+
+	stopAndPersist(options = {}) {
+		if (this.isSilent) {
+			return this;
+		}
+
+		const symbol = options.symbol ?? ' ';
+		const text = options.text ?? this.text;
+		const prefixText = options.prefixText ?? this.#options.prefixText;
+		const suffixText = options.suffixText ?? this.#options.suffixText;
+
+		const textToWrite = this.#buildOutputLine(symbol, text, prefixText, suffixText) + '\n';
+
+		this.stop();
+		this.#internalWrite(() => this.#stream.write(textToWrite));
+
+		return this;
+	}
+}
+
+export default function ora(options) {
+	return new Ora(options);
+}
+
+export async function oraPromise(action, options) {
+	const actionIsFunction = typeof action === 'function';
+	const actionIsPromise = typeof action.then === 'function';
+
+	if (!actionIsFunction && !actionIsPromise) {
+		throw new TypeError('Parameter `action` must be a Function or a Promise');
+	}
+
+	const {successText, failText} = typeof options === 'object'
+		? options
+		: {successText: undefined, failText: undefined};
+
+	const spinner = ora(options).start();
+
+	try {
+		const promise = actionIsFunction ? action(spinner) : action;
+		const result = await promise;
+
+		spinner.succeed(successText === undefined
+			? undefined
+			: (typeof successText === 'string' ? successText : successText(result)));
+
+		return result;
+	} catch (error) {
+		spinner.fail(failText === undefined
+			? undefined
+			: (typeof failText === 'string' ? failText : failText(error)));
+
+		throw error;
+	}
+}
+
+export {default as spinners} from 'cli-spinners';

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@depup/ora",
+  "version": "9.3.0-depup.0",
+  "description": "Elegant terminal spinner",
+  "license": "MIT",
+  "repository": "sindresorhus/ora",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./index.d.ts",
+    "default": "./index.js"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "test": "xo && NODE_ENV=test node --test test.js && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "keywords": [
+    "cli",
+    "spinner",
+    "spinners",
+    "terminal",
+    "term",
+    "console",
+    "ascii",
+    "unicode",
+    "loading",
+    "indicator",
+    "progress",
+    "busy",
+    "wait",
+    "idle"
+  ],
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "cli-cursor": "^5.0.0",
+    "cli-spinners": "^3.4.0",
+    "is-interactive": "^2.0.0",
+    "is-unicode-supported": "^2.1.0",
+    "log-symbols": "^7.0.1",
+    "stdin-discarder": "^0.3.1",
+    "string-width": "^8.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.5.0",
+    "ava": "^6.4.1",
+    "get-stream": "^9.0.1",
+    "transform-tty": "^1.0.11",
+    "tsd": "^0.33.0",
+    "xo": "^1.2.2"
+  }
+}

package/readme.md

@@ -0,0 +1,399 @@
+# ora
+
+> Elegant terminal spinner
+
+<p align="center">
+	<br>
+	<img src="screenshot.svg" width="500">
+	<br>
+</p>
+
+## Install
+
+```sh
+npm install ora
+```
+
+*Check out [`yocto-spinner`](https://github.com/sindresorhus/yocto-spinner) for a smaller alternative.*
+
+## Usage
+
+```js
+import ora from 'ora';
+
+const spinner = ora('Loading unicorns').start();
+
+setTimeout(() => {
+	spinner.color = 'yellow';
+	spinner.text = 'Loading rainbows';
+}, 1000);
+```
+
+## API
+
+### ora(text)
+### ora(options)
+
+If a string is provided, it is treated as a shortcut for [`options.text`](#text).
+
+#### options
+
+Type: `object`
+
+##### text
+
+Type: `string`
+
+The text to display next to the spinner.
+
+##### prefixText
+
+Type: `string | () => string`
+
+Text or a function that returns text to display before the spinner. No prefix text will be displayed if set to an empty string.
+
+##### suffixText
+
+Type: `string | () => string`
+
+Text or a function that returns text to display after the spinner text. No suffix text will be displayed if set to an empty string.
+
+##### spinner
+
+Type: `string | object`\
+Default: `'dots'` <img src="screenshot-spinner.gif" width="14">
+
+The name of one of the [provided spinners](#spinners). See `example.js` in this repo if you want to test out different spinners. On Windows (except for Windows Terminal), it will always use the `line` spinner as the Windows command-line doesn't have proper Unicode support.
+
+Or an object like:
+
+```js
+{
+	frames: ['-', '+', '-'],
+	interval: 80 // Optional
+}
+```
+
+##### color
+
+Type: `string | boolean`\
+Default: `'cyan'`\
+Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | boolean`
+
+The color of the spinner. Set to `false` to disable coloring.
+
+##### hideCursor
+
+Type: `boolean`\
+Default: `true`
+
+Set to `false` to stop Ora from hiding the cursor.
+
+##### indent
+
+Type: `number`\
+Default: `0`
+
+Indent the spinner with the given number of spaces.
+
+##### interval
+
+Type: `number`\
+Default: Provided by the spinner or `100`
+
+Interval between each frame.
+
+Spinners provide their own recommended interval, so you don't really need to specify this.
+
+##### stream
+
+Type: `stream.Writable`\
+Default: `process.stderr`
+
+Stream to write the output.
+
+You could for example set this to `process.stdout` instead.
+
+##### isEnabled
+
+Type: `boolean`
+
+Force enable/disable the spinner. If not specified, the spinner will be enabled if the `stream` is being run inside a TTY context (not spawned or piped) and/or not in a CI environment.
+
+Note that `{isEnabled: false}` doesn't mean it won't output anything. It just means it won't output the spinner, colors, and other ansi escape codes. It will still log text.
+
+##### isSilent
+
+Type: `boolean`\
+Default: `false`
+
+Disable the spinner and all log text. All output is suppressed and `isEnabled` will be considered `false`.
+
+##### discardStdin
+
+Type: `boolean`\
+Default: `true`
+
+Discard stdin input (except Ctrl+C) while running if it's TTY. This prevents the spinner from twitching on input, outputting broken lines on <kbd>Enter</kbd> key presses, and prevents buffering of input while the spinner is running.
+
+This has no effect on Windows as there is no good way to implement discarding stdin properly there.
+
+Note: `discardStdin` puts stdin into raw mode. In raw mode, `Ctrl+C` no longer generates `SIGINT` from the terminal. Ora re-emits `Ctrl+C` from stdin input, but if your code blocks the event loop with synchronous work, `Ctrl+C` handling is delayed until the blocking work ends. Use async APIs, a worker thread, or a child process to keep `Ctrl+C` responsive, or set `discardStdin` to `false`.
+
+### Instance
+
+#### .text <sup>get/set</sup>
+
+Change the text displayed after the spinner.
+
+#### .prefixText <sup>get/set</sup>
+
+Change the text before the spinner.
+
+No prefix text will be displayed if set to an empty string.
+
+#### .suffixText <sup>get/set</sup>
+
+Change the text after the spinner text.
+
+No suffix text will be displayed if set to an empty string.
+
+#### .color <sup>get/set</sup>
+
+Change the spinner color.
+
+#### .spinner <sup>get/set</sup>
+
+Change the spinner.
+
+#### .indent <sup>get/set</sup>
+
+Change the spinner indent.
+
+#### .isSpinning <sup>get</sup>
+
+A boolean indicating whether the instance is currently spinning.
+
+#### .interval <sup>get</sup>
+
+The interval between each frame.
+
+The interval is decided by the chosen spinner.
+
+#### .start(text?)
+
+Start the spinner. Returns the instance. Set the current text if `text` is provided.
+
+#### .stop()
+
+Stop and clear the spinner. Returns the instance.
+
+#### .succeed(text?)
+
+Stop the spinner, change it to a green `✔` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
+
+#### .fail(text?)
+
+Stop the spinner, change it to a red `✖` and persist the current text, or `text` if provided. Returns the instance. See the GIF below.
+
+#### .warn(text?)
+
+Stop the spinner, change it to a yellow `⚠` and persist the current text, or `text` if provided. Returns the instance.
+
+#### .info(text?)
+
+Stop the spinner, change it to a blue `ℹ` and persist the current text, or `text` if provided. Returns the instance.
+
+#### .stopAndPersist(options?)
+
+Stop the spinner and change the symbol or text. Returns the instance. See the GIF below.
+
+##### options
+
+Type: `object`
+
+###### symbol
+
+Type: `string`\
+Default: `' '`
+
+Symbol to replace the spinner with.
+
+###### text
+
+Type: `string`\
+Default: Current `'text'`
+
+Text to be persisted after the symbol.
+
+###### prefixText
+
+Type: `string | () => string`\
+Default: Current `prefixText`
+
+Text or a function that returns text to be persisted before the symbol. No prefix text will be displayed if set to an empty string.
+
+###### suffixText
+
+Type: `string | () => string`\
+Default: Current `suffixText`
+
+Text or a function that returns text to be persisted after the text after the symbol. No suffix text will be displayed if set to an empty string.
+
+<img src="screenshot-2.gif" width="480">
+
+#### .clear()
+
+Clear the spinner. Returns the instance.
+
+#### .render()
+
+Manually render a new frame. Returns the instance.
+
+#### .frame()
+
+Get a new frame.
+
+### oraPromise(action, text)
+### oraPromise(action, options)
+
+Starts a spinner for a promise or promise-returning function. The spinner is stopped with `.succeed()` if the promise fulfills or with `.fail()` if it rejects. Returns the promise.
+
+```js
+import {oraPromise} from 'ora';
+
+await oraPromise(somePromise);
+```
+
+#### action
+
+Type: `Promise | ((spinner: ora.Ora) => Promise)`
+
+#### options
+
+Type: `object`
+
+All of the [options](#options) plus the following:
+
+##### successText
+
+Type: `string | ((result: T) => string) | undefined`
+
+The new text of the spinner when the promise is resolved.
+
+Keeps the existing text if `undefined`.
+
+##### failText
+
+Type: `string | ((error: Error) => string) | undefined`
+
+The new text of the spinner when the promise is rejected.
+
+Keeps the existing text if `undefined`.
+
+### spinners
+
+Type: `Record<string, Spinner>`
+
+All [provided spinners](https://github.com/sindresorhus/cli-spinners/blob/main/spinners.json).
+
+## FAQ
+
+### How do I change the color of the text?
+
+Use [`chalk`](https://github.com/chalk/chalk) or [`yoctocolors`](https://github.com/sindresorhus/yoctocolors):
+
+```js
+import ora from 'ora';
+import chalk from 'chalk';
+
+const spinner = ora(`Loading ${chalk.red('unicorns')}`).start();
+```
+
+### Why does the spinner freeze?
+
+JavaScript is single-threaded, so any synchronous operations will block the spinner's animation. To avoid this, prefer using asynchronous operations.
+
+### Why do I get the line spinner on Windows Terminal or WSL?
+
+Windows Terminal does [not expose](https://github.com/microsoft/terminal/issues/1040) a reliable, stable way to detect itself or Unicode support from Node, and `WT_SESSION` is explicitly informative, not a detection API and can be inherited by other terminals. That makes environment-based detection best-effort. If you are in a Unicode-capable terminal, set `spinner` explicitly, for example `ora({spinner: 'dots'})`.
+
+### Can I log messages while the spinner is running?
+
+Yes! Ora automatically handles writes to the same stream. The spinner will temporarily clear itself, output your message, and re-render below:
+
+```js
+const spinner = ora('Processing...').start();
+
+console.log('Step 1 complete');
+console.log('Step 2 complete');
+
+spinner.succeed('Done!');
+```
+
+The output will be clean with each log appearing above the spinner. This works seamlessly without requiring any special logging methods. Both `console.log()` (stdout) and `console.error()`/`console.warn()` (stderr) are supported.
+
+> [!NOTE]
+> Don't run multiple spinners concurrently. Use one spinner at a time.
+
+### Can I display multiple spinners simultaneously?
+
+No. Ora is designed to display a single spinner at a time. For multiple concurrent progress indicators, consider alternatives like [listr2](https://github.com/listr2/listr2) or [spinnies](https://github.com/jcarpanelli/spinnies).
+
+### Can I use Ora with [log-update](https://github.com/sindresorhus/log-update)?
+
+Yes, use the `.frame()` method to get the current spinner frame and include it in your log-update output.
+
+### Does Ora work in Node.js Worker threads?
+
+No. Ora requires an interactive terminal environment and Worker threads are not considered interactive, so the spinner will not animate. Run the spinner in the main thread and control it via worker messages:
+
+```js
+// main.js
+import {Worker} from 'node:worker_threads';
+import ora from 'ora';
+
+const spinner = ora().start();
+const worker = new Worker('./worker.js');
+
+worker.on('message', message => {
+	switch (message.type) {
+		case 'ora:text':
+			spinner.text = message.text;
+			break;
+		case 'ora:succeed':
+			spinner.succeed(message.text);
+			break;
+		case 'ora:fail':
+			spinner.fail(message.text);
+			break;
+	}
+});
+```
+
+```js
+// worker.js
+import {parentPort} from 'node:worker_threads';
+
+parentPort.postMessage({type: 'ora:text', text: 'Working...'});
+
+// Do work...
+
+parentPort.postMessage({type: 'ora:succeed', text: 'Done!'});
+```
+
+## Related
+
+- [yocto-spinner](https://github.com/sindresorhus/yocto-spinner) - Tiny terminal spinner
+- [cli-spinners](https://github.com/sindresorhus/cli-spinners) - Spinners for use in the terminal
+
+**Ports**
+
+- [CLISpinner](https://github.com/kiliankoe/CLISpinner) - Terminal spinner library for Swift
+- [halo](https://github.com/ManrajGrover/halo) - Python port
+- [spinners](https://github.com/FGRibreau/spinners) - Terminal spinners for Rust
+- [marquee-ora](https://github.com/joeycozza/marquee-ora) - Scrolling marquee spinner for Ora
+- [briandowns/spinner](https://github.com/briandowns/spinner) - Terminal spinner/progress indicator for Go
+- [tj/go-spin](https://github.com/tj/go-spin) - Terminal spinner package for Go
+- [observablehq.com/@victordidenko/ora](https://observablehq.com/@victordidenko/ora) - Ora port to Observable notebooks
+- [kia](https://github.com/HarryPeach/kia) - Simple terminal spinners for Deno 🦕