feat: add customizable spinner cancel and error messages

.changeset/five-chairs-poke.md

@@ -0,0 +1,32 @@
+---
+"@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 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,27 +37,50 @@ 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) {
-	for (const _key in updates) {
-		const key = _key as keyof ClackSettings;
-		if (!Object.hasOwn(updates, key)) continue;
-		const value = updates[key];
-
-		switch (key) {
-			case 'aliases': {
-				for (const alias in value) {
-					if (!Object.hasOwn(value, alias)) continue;
-					if (!settings.aliases.has(alias)) {
-						settings.aliases.set(alias, value[alias]);
-					}
-				}
-				break;
+	// Handle each property in the updates
+	if (updates.aliases !== undefined) {
+		const aliases = updates.aliases;
+		for (const alias in aliases) {
+			if (!Object.hasOwn(aliases, alias)) continue;
+
+			const action = aliases[alias];
+			if (!settings.actions.has(action)) continue;
+
+			if (!settings.aliases.has(alias)) {
+				settings.aliases.set(alias, action);
 			}
 		}
 	}
+
+	if (updates.messages !== undefined) {
+		const messages = updates.messages;
+		if (messages.cancel !== undefined) {
+			settings.messages.cancel = messages.cancel;
+		}
+		if (messages.error !== undefined) {
+			settings.messages.error = messages.error;
+		}
+	}
 }
 
 /**

packages/prompts/src/__snapshots__/index.test.ts.snap

@@ -1435,6 +1435,83 @@ exports[`prompts (isCI = false) > spinner > message > sets message for next fram
 ]
 `;
 
+exports[`prompts (isCI = false) > spinner > process exit handling > prioritizes direct options over global settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Spinner cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > prioritizes direct options over global settings 2`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Spinner error message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > uses custom cancel message when provided directly 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Custom cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > uses custom error message when provided directly 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Custom error message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > uses default cancel message 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Canceled
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > uses global custom cancel message from settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Global cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = false) > spinner > process exit handling > uses global custom error message from settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Global error message
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = false) > spinner > start > renders frames at interval 1`] = `
 [
   "[?25l",
@@ -3175,6 +3252,83 @@ exports[`prompts (isCI = true) > spinner > message > sets message for next frame
 ]
 `;
 
+exports[`prompts (isCI = true) > spinner > process exit handling > prioritizes direct options over global settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Spinner cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > prioritizes direct options over global settings 2`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Spinner error message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > uses custom cancel message when provided directly 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Custom cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > uses custom error message when provided directly 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Custom error message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > uses default cancel message 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Canceled
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > uses global custom cancel message from settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "■  Global cancel message
+",
+  "[?25h",
+]
+`;
+
+exports[`prompts (isCI = true) > spinner > process exit handling > uses global custom error message from settings 1`] = `
+[
+  "[?25l",
+  "│
+",
+  "▲  Global error message
+",
+  "[?25h",
+]
+`;
+
 exports[`prompts (isCI = true) > spinner > start > renders frames at interval 1`] = `
 [
   "[?25l",