Interface ClackSettings

packages/core/src/utils/settings.ts:69–116

};

export interface ClackSettings {
	/**
	 * Set custom global aliases for the default actions.
	 * This will not overwrite existing aliases, it will only add new ones!
	 *
	 * @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>;

	/**
	 * 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;
	};

	withGuide?: boolean;

	/**
	 * Date prompt localization
	 */
	date?: {
		/** Month names for validation messages (January, February, ...) */
		monthNames?: string[];
		messages?: {
			/** Shown when date is missing */
			required?: string;
			/** Shown when month > 12 */
			invalidMonth?: string;
			/** (days, monthName) => message for invalid day */
			invalidDay?: (days: number, month: string) => string;
			/** (min) => message when date is before minDate */
			afterMin?: (min: Date) => string;
			/** (max) => message when date is after maxDate */
			beforeMax?: (max: Date) => string;
		};
	};
}

export function updateSettings(updates: ClackSettings) {
	// Handle each property in the updates