refactor: use core settings directly in spinner implementation for consistent message handling

Author: dreyfus92

.changeset/five-chairs-poke.md

@@ -1,24 +1,30 @@
 ---
 "@clack/prompts": minor
+"@clack/core": minor
 ---
 
 Add support for customizable spinner cancel and error messages. Users can now customize these messages either per spinner instance or globally via the `updateSettings` function to support multilingual CLIs.
 
+This update also improves the architecture by exposing the core settings to the prompts package, enabling more consistent default message handling across the codebase.
+
 ```ts
 // Per-instance customization
 const spinner = prompts.spinner({
   cancelMessage: 'Operación cancelada',  // "Operation cancelled" in Spanish
   errorMessage: 'Se produjo un error'    // "An error occurred" in Spanish
 });
 
-// Global customization via settings
+// Global customization via updateSettings
 prompts.updateSettings({
   messages: {
     cancel: 'Operación cancelada',       // "Operation cancelled" in Spanish
     error: 'Se produjo un error'         // "An error occurred" in Spanish
   }
 });
 
+// Settings can now be accessed directly
+console.log(prompts.settings.messages.cancel); // "Operación cancelada"
+
 // Direct options take priority over global settings
 const spinner = prompts.spinner({
   cancelMessage: 'Cancelled',  // This will be used instead of the global setting

packages/core/src/index.ts

@@ -10,4 +10,4 @@ export { default as SelectPrompt } from './prompts/select.js';
 export { default as SelectKeyPrompt } from './prompts/select-key.js';
 export { default as TextPrompt } from './prompts/text.js';
 export { block, isCancel } from './utils/index.js';
-export { updateSettings } from './utils/settings.js';
+export { updateSettings, settings } from './utils/settings.js';

packages/core/src/utils/settings.ts

@@ -5,6 +5,10 @@ export type Action = (typeof actions)[number];
 interface InternalClackSettings {
 	actions: Set<Action>;
 	aliases: Map<string, Action>;
+	messages: {
+		cancel: string;
+		error: string;
+	};
 }
 
 export const settings: InternalClackSettings = {
@@ -19,6 +23,10 @@ export const settings: InternalClackSettings = {
 		// opinionated defaults!
 		['escape', 'cancel'],
 	]),
+	messages: {
+		cancel: 'Canceled',
+		error: 'Something went wrong',
+	},
 };
 
 export interface ClackSettings {
@@ -29,7 +37,23 @@ export interface ClackSettings {
 	 * @param aliases - An object that maps aliases to actions
 	 * @default { k: 'up', j: 'down', h: 'left', l: 'right', '\x03': 'cancel', 'escape': 'cancel' }
 	 */
-	aliases: Record<string, Action>;
+	aliases?: Record<string, Action>;
+
+	/**
+	 * Custom messages for prompts
+	 */
+	messages?: {
+		/**
+		 * Custom message to display when a spinner is cancelled
+		 * @default "Canceled"
+		 */
+		cancel?: string;
+		/**
+		 * Custom message to display when a spinner encounters an error
+		 * @default "Something went wrong"
+		 */
+		error?: string;
+	};
 }
 
 export function updateSettings(updates: ClackSettings) {
@@ -40,14 +64,25 @@ export function updateSettings(updates: ClackSettings) {
 
 		switch (key) {
 			case 'aliases': {
-				for (const alias in value) {
-					if (!Object.hasOwn(value, alias)) continue;
+				const aliases = value as Record<string, Action>;
+				for (const alias in aliases) {
+					if (!Object.hasOwn(aliases, alias)) continue;
 					if (!settings.aliases.has(alias)) {
-						settings.aliases.set(alias, value[alias]);
+						settings.aliases.set(alias, aliases[alias]);
 					}
 				}
 				break;
 			}
+			case 'messages': {
+				const messages = value as ClackSettings['messages'];
+				if (messages?.cancel) {
+					settings.messages.cancel = messages.cancel;
+				}
+				if (messages?.error) {
+					settings.messages.error = messages.error;
+				}
+				break;
+			}
 		}
 	}
 }

packages/prompts/src/index.test.ts

@@ -239,11 +239,10 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
 			});
 
 			test('uses global custom cancel message from settings', () => {
-				prompts.updateSettings({
-					messages: {
-						cancel: 'Global cancel message',
-					},
-				});
+				// Store original message
+				const originalCancelMessage = prompts.settings.messages.cancel;
+				// Set custom message
+				prompts.settings.messages.cancel = 'Global cancel message';
 
 				const result = prompts.spinner({ output });
 				result.start('Test operation');
@@ -252,20 +251,15 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
 
 				expect(output.buffer).toMatchSnapshot();
 
-				// Reset to default
-				prompts.updateSettings({
-					messages: {
-						cancel: 'Canceled',
-					},
-				});
+				// Reset to original
+				prompts.settings.messages.cancel = originalCancelMessage;
 			});
 
 			test('uses global custom error message from settings', () => {
-				prompts.updateSettings({
-					messages: {
-						error: 'Global error message',
-					},
-				});
+				// Store original message
+				const originalErrorMessage = prompts.settings.messages.error;
+				// Set custom message
+				prompts.settings.messages.error = 'Global error message';
 
 				const result = prompts.spinner({ output });
 				result.start('Test operation');
@@ -274,21 +268,18 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
 
 				expect(output.buffer).toMatchSnapshot();
 
-				// Reset to default
-				prompts.updateSettings({
-					messages: {
-						error: 'Something went wrong',
-					},
-				});
+				// Reset to original
+				prompts.settings.messages.error = originalErrorMessage;
 			});
 
 			test('prioritizes direct options over global settings', () => {
-				prompts.updateSettings({
-					messages: {
-						cancel: 'Global cancel message',
-						error: 'Global error message',
-					},
-				});
+				// Store original messages
+				const originalCancelMessage = prompts.settings.messages.cancel;
+				const originalErrorMessage = prompts.settings.messages.error;
+				
+				// Set custom global messages
+				prompts.settings.messages.cancel = 'Global cancel message';
+				prompts.settings.messages.error = 'Global error message';
 
 				const result = prompts.spinner({
 					output,
@@ -313,13 +304,9 @@ describe.each(['true', 'false'])('prompts (isCI = %s)', (isCI) => {
 				processEmitter.emit('exit', 2);
 				expect(output.buffer).toMatchSnapshot();
 
-				// Reset to defaults
-				prompts.updateSettings({
-					messages: {
-						cancel: 'Canceled',
-						error: 'Something went wrong',
-					},
-				});
+				// Reset to original values
+				prompts.settings.messages.cancel = originalCancelMessage;
+				prompts.settings.messages.error = originalErrorMessage;
 			});
 		});
 	});

packages/prompts/src/index.ts

@@ -3,7 +3,6 @@ import { WriteStream } from 'node:tty';
 import { stripVTControlCharacters as strip } from 'node:util';
 import {
 	ConfirmPrompt,
-	type ClackSettings as CoreClackSettings,
 	GroupMultiSelectPrompt,
 	MultiSelectPrompt,
 	PasswordPrompt,
@@ -12,14 +11,15 @@ import {
 	type State,
 	TextPrompt,
 	block,
-	updateSettings as coreUpdateSettings,
 	isCancel,
+	updateSettings,
+	settings
 } from '@clack/core';
 import isUnicodeSupported from 'is-unicode-supported';
 import color from 'picocolors';
 import { cursor, erase } from 'sisteransi';
 
-export { isCancel } from '@clack/core';
+export { isCancel, updateSettings, settings } from '@clack/core';
 
 const unicode = isUnicodeSupported();
 const s = (c: string, fallback: string) => (unicode ? c : fallback);
@@ -779,55 +779,6 @@ export interface SpinnerResult {
 	readonly isCancelled: boolean;
 }
 
-// Extend the core settings interface
-export interface ClackSettings extends CoreClackSettings {
-	/**
-	 * Custom messages for prompts
-	 */
-	messages?: {
-		/**
-		 * Custom message to display when a spinner is cancelled
-		 * @default "Canceled"
-		 */
-		cancel?: string;
-		/**
-		 * Custom message to display when a spinner encounters an error
-		 * @default "Something went wrong"
-		 */
-		error?: string;
-	};
-}
-
-/**
- * Global settings for default messages
- */
-const promptsSettings = {
-	messages: {
-		cancel: 'Canceled',
-		error: 'Something went wrong',
-	},
-};
-
-/**
- * Update global settings for prompts including core settings
- */
-export function updateSettings(settings: Partial<ClackSettings>) {
-	// Handle aliases property for core if provided
-	if (settings.aliases) {
-		// Only pass the aliases property to core
-		coreUpdateSettings({ aliases: settings.aliases });
-	}
-	// Update prompt-specific settings
-	if (settings.messages) {
-		if (settings.messages.cancel) {
-			promptsSettings.messages.cancel = settings.messages.cancel;
-		}
-		if (settings.messages.error) {
-			promptsSettings.messages.error = settings.messages.error;
-		}
-	}
-}
-
 export const spinner = ({
 	indicator = 'dots',
 	onCancel,
@@ -848,10 +799,9 @@ export const spinner = ({
 	let _origin: number = performance.now();
 
 	const handleExit = (code: number) => {
-		const msg =
-			code > 1
-				? (errorMessage ?? promptsSettings.messages.error)
-				: (cancelMessage ?? promptsSettings.messages.cancel);
+		const msg = code > 1 
+			? (errorMessage ?? settings.messages.error) 
+			: (cancelMessage ?? settings.messages.cancel);
 		isCancelled = code === 1;
 		if (isSpinnerActive) {
 			stop(msg, code);