@depup/ora 9.3.0-depup.0 → 9.4.1-depup.0

package/README.md

@@ -0,0 +1,32 @@
+# @depup/ora
+
+> Dependency-bumped version of [ora](https://www.npmjs.com/package/ora)
+
+Generated by [DepUp](https://github.com/depup/npm) -- all production
+dependencies bumped to latest versions.
+
+## Installation
+
+```bash
+npm install @depup/ora
+```
+
+| Field | Value |
+|-------|-------|
+| Original | [ora](https://www.npmjs.com/package/ora) @ 9.4.1 |
+| Processed | 2026-07-21 |
+| Smoke test | passed |
+| Deps updated | 2 |
+
+## Dependency Changes
+
+| Dependency | From | To |
+|------------|------|-----|
+| cli-spinners | ^3.2.0 | ^3.4.0 |
+| string-width | ^8.1.0 | ^8.2.2 |
+
+---
+
+Source: https://github.com/depup/npm | Original: https://www.npmjs.com/package/ora
+
+License inherited from the original package.

package/changes.json

@@ -0,0 +1,14 @@
+{
+  "bumped": {
+    "cli-spinners": {
+      "from": "^3.2.0",
+      "to": "^3.4.0"
+    },
+    "string-width": {
+      "from": "^8.1.0",
+      "to": "^8.2.2"
+    }
+  },
+  "timestamp": "2026-07-21T17:26:55.866Z",
+  "totalUpdated": 2
+}

package/index.d.ts

@@ -56,9 +56,11 @@ export type Options = {
 	/**
 	The color of the spinner.
 
+	Set to `false` to disable the color.
+
 	@default 'cyan'
 	*/
-	readonly color?: Color | boolean;
+	readonly color?: Color | false | undefined;
 
 	/**
 	Set to `false` to stop Ora from hiding the cursor.
@@ -161,7 +163,39 @@ export type PromiseOptions<T> = {
 
 	Keeps the existing text if `undefined`.
 	*/
-	failText?: string | ((error: Error) => string) | undefined;
+	failText?: string | ((error: unknown) => string) | undefined;
+
+	/**
+	The symbol to use when the promise is resolved, instead of the default success symbol.
+
+	Useful if you want to customize or disable the symbol.
+
+	Uses the default success symbol if `undefined`.
+
+	@example
+	```
+	import {oraPromise} from 'ora';
+
+	await oraPromise(somePromise, {successSymbol: '🦄'});
+	```
+	*/
+	successSymbol?: string | undefined;
+
+	/**
+	The symbol to use when the promise is rejected, instead of the default failure symbol.
+
+	Useful if you want to customize or disable the symbol.
+
+	Uses the default failure symbol if `undefined`.
+
+	@example
+	```
+	import {oraPromise} from 'ora';
+
+	await oraPromise(somePromise, {failSymbol: '💥'});
+	```
+	*/
+	failSymbol?: string | undefined;
 } & Options;
 
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
@@ -176,19 +210,21 @@ export interface Ora {
 
 	No prefix text will be displayed if set to an empty string.
 	*/
-	prefixText: string;
+	prefixText: string | PrefixTextGenerator;
 
 	/**
 	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;
+	suffixText: string | SuffixTextGenerator;
 
 	/**
 	Change the spinner color.
+
+	Set to `false` to disable the color.
 	*/
-	color: Color | boolean;
+	color: Color | false | undefined;
 
 	/**
 	Change the spinner indent.
@@ -210,6 +246,16 @@ export interface Ora {
 	*/
 	get isSpinning(): boolean;
 
+	/**
+	A boolean indicating whether the spinner and log text are enabled.
+	*/
+	isEnabled: boolean;
+
+	/**
+	A boolean indicating whether all output is suppressed.
+	*/
+	isSilent: boolean;
+
 	/**
 	The interval between each frame.
 
@@ -288,7 +334,7 @@ export interface Ora {
 	/**
 	Get a new frame.
 
-	@returns The spinner instance text.
+	@returns The rendered frame text.
 	*/
 	frame(): string;
 }

package/index.js

@@ -17,6 +17,8 @@ const SYNCHRONIZED_OUTPUT_DISABLE = '\u001B[?2026l';
 // Global state for concurrent spinner detection
 const activeHooksPerStream = new Map(); // Stream → ora instance
 
+const validColors = new Set(['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan', 'white', 'gray']);
+
 class Ora {
 	#linesToClear = 0;
 	#frameIndex = -1;
@@ -30,7 +32,7 @@ class Ora {
 	#drainHandler;
 	#deferRenderTimer;
 	#isDiscardingStdin = false;
-	color;
+	#color;
 
 	// Helper to execute writes while preventing hook recursion
 	#internalWrite(fn) {
@@ -141,6 +143,10 @@ class Ora {
 			this.#options.isSilent = false;
 		}
 
+		if (this.#options.interval !== undefined && !(Number.isInteger(this.#options.interval) && this.#options.interval > 0)) {
+			throw new Error('The `interval` option must be a positive integer');
+		}
+
 		// Set *after* `this.#stream`.
 		// Store original interval before spinner setter clears it
 		const userInterval = this.#options.interval;
@@ -286,6 +292,18 @@ class Ora {
 		return count;
 	}
 
+	get color() {
+		return this.#color;
+	}
+
+	set color(value) {
+		if (value !== undefined && value !== false && !validColors.has(value)) {
+			throw new Error('The `color` option must be a valid color or `false` to disable');
+		}
+
+		this.#color = value;
+	}
+
 	get isEnabled() {
 		return this.#options.isEnabled && !this.#options.isSilent;
 	}
@@ -321,8 +339,8 @@ class Ora {
 		const {frames} = this.#spinner;
 		let frame = frames[this.#frameIndex];
 
-		if (this.color) {
-			frame = chalk[this.color](frame);
+		if (this.#color) {
+			frame = chalk[this.#color](frame);
 		}
 
 		const fullPrefixText = this.#getFullPrefixText(this.#options.prefixText, ' ');
@@ -490,7 +508,7 @@ class Ora {
 	}
 
 	start(text) {
-		if (text) {
+		if (text !== undefined) {
 			this.text = text;
 		}
 
@@ -600,15 +618,20 @@ export default function ora(options) {
 
 export async function oraPromise(action, options) {
 	const actionIsFunction = typeof action === 'function';
-	const actionIsPromise = typeof action.then === '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'
+	const {
+		successText,
+		failText,
+		successSymbol,
+		failSymbol,
+	} = (typeof options === 'object' && options !== null)
 		? options
-		: {successText: undefined, failText: undefined};
+		: {};
 
 	const spinner = ora(options).start();
 
@@ -616,15 +639,27 @@ export async function oraPromise(action, options) {
 		const promise = actionIsFunction ? action(spinner) : action;
 		const result = await promise;
 
-		spinner.succeed(successText === undefined
+		const text = successText === undefined
 			? undefined
-			: (typeof successText === 'string' ? successText : successText(result)));
+			: (typeof successText === 'string' ? successText : successText(result));
+
+		if (successSymbol === undefined) {
+			spinner.succeed(text);
+		} else {
+			spinner.stopAndPersist({symbol: successSymbol, text});
+		}
 
 		return result;
 	} catch (error) {
-		spinner.fail(failText === undefined
+		const text = failText === undefined
 			? undefined
-			: (typeof failText === 'string' ? failText : failText(error)));
+			: (typeof failText === 'string' ? failText : failText(error));
+
+		if (failSymbol === undefined) {
+			spinner.fail(text);
+		} else {
+			spinner.stopAndPersist({symbol: failSymbol, text});
+		}
 
 		throw error;
 	}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@depup/ora",
-  "version": "9.3.0-depup.0",
-  "description": "Elegant terminal spinner",
+  "version": "9.4.1-depup.0",
+  "description": "Elegant terminal spinner (with updated dependencies)",
   "license": "MIT",
   "repository": "sindresorhus/ora",
   "funding": "https://github.com/sponsors/sindresorhus",
@@ -24,9 +24,17 @@
   },
   "files": [
     "index.js",
-    "index.d.ts"
+    "index.d.ts",
+    "changes.json",
+    "README.md"
   ],
   "keywords": [
+    "ora",
+    "depup",
+    "updated-dependencies",
+    "security",
+    "latest",
+    "patched",
     "cli",
     "spinner",
     "spinners",
@@ -49,15 +57,31 @@
     "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"
+    "stdin-discarder": "^0.3.2",
+    "string-width": "^8.2.2"
   },
   "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"
+  },
+  "depup": {
+    "changes": {
+      "cli-spinners": {
+        "from": "^3.2.0",
+        "to": "^3.4.0"
+      },
+      "string-width": {
+        "from": "^8.1.0",
+        "to": "^8.2.2"
+      }
+    },
+    "depsUpdated": 2,
+    "originalPackage": "ora",
+    "originalVersion": "9.4.1",
+    "processedAt": "2026-07-21T17:27:07.551Z",
+    "smokeTest": "passed"
   }
 }

package/readme.md

@@ -76,9 +76,9 @@ Or an object like:
 
 ##### color
 
-Type: `string | boolean`\
+Type: `string | false`\
 Default: `'cyan'`\
-Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | boolean`
+Values: `'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'gray' | false`
 
 The color of the spinner. Set to `false` to disable coloring.
 
@@ -174,6 +174,14 @@ Change the spinner indent.
 
 A boolean indicating whether the instance is currently spinning.
 
+#### .isEnabled <sup>get/set</sup>
+
+A boolean indicating whether the spinner and log text are enabled.
+
+#### .isSilent <sup>get/set</sup>
+
+A boolean indicating whether all output is suppressed.
+
 #### .interval <sup>get</sup>
 
 The interval between each frame.
@@ -267,7 +275,7 @@ await oraPromise(somePromise);
 
 #### action
 
-Type: `Promise | ((spinner: ora.Ora) => Promise)`
+Type: `Promise | ((spinner: Ora) => Promise)`
 
 #### options
 
@@ -285,12 +293,32 @@ Keeps the existing text if `undefined`.
 
 ##### failText
 
-Type: `string | ((error: Error) => string) | undefined`
+Type: `string | ((error: unknown) => string) | undefined`
 
 The new text of the spinner when the promise is rejected.
 
 Keeps the existing text if `undefined`.
 
+##### successSymbol
+
+Type: `string | undefined`
+
+The symbol to use when the promise is resolved, instead of the default success symbol.
+
+Useful if you want to customize or disable the symbol.
+
+Uses the default success symbol if `undefined`.
+
+##### failSymbol
+
+Type: `string | undefined`
+
+The symbol to use when the promise is rejected, instead of the default failure symbol.
+
+Useful if you want to customize or disable the symbol.
+
+Uses the default failure symbol if `undefined`.
+
 ### spinners
 
 Type: `Record<string, Spinner>`