From f32932b5d1ac3b93592ce4a8af8ca28df1d3d389 Mon Sep 17 00:00:00 2001 From: IG-ABHINAV Date: Wed, 18 Nov 2026 16:11:25 +0000 Subject: [PATCH] fix(prompts): use settings.messages.cancel when cancel() has no message --- .changeset/cancel-uses-settings-message.md | 5 +++ packages/prompts/src/messages.ts | 7 +-- packages/prompts/test/messages.test.ts | 50 ++++++++++++++++++++++ 3 files changed, 59 insertions(+), 3 deletions(-) create mode 100644 .changeset/cancel-uses-settings-message.md create mode 100644 packages/prompts/test/messages.test.ts diff --git a/.changeset/cancel-uses-settings-message.md b/.changeset/cancel-uses-settings-message.md new file mode 100644 index 00000000..1735ea7a --- /dev/null +++ b/.changeset/cancel-uses-settings-message.md @@ -0,0 +1,5 @@ +--- +"@clack/prompts": patch +--- + +`cancel()` called without a message now shows `settings.messages.cancel`, so a message set with `updateSettings({ messages: { cancel } })` is displayed. diff --git a/packages/prompts/src/messages.ts b/packages/prompts/src/messages.ts index 26393176..db449288 100644 --- a/packages/prompts/src/messages.ts +++ b/packages/prompts/src/messages.ts @@ -7,7 +7,8 @@ import { type CommonOptions, S_BAR, S_BAR_END, S_BAR_START } from './common.js'; * The `cancel` function defines an interruption of an interaction * and therefore its end. * - * @param title Optional closing message to be displayed. + * @param title Optional closing message to be displayed. Defaults to + * `settings.messages.cancel`, which can be changed with `updateSettings`. * @param opts Additional configuration options. * * @see https://bomb.sh/docs/clack/packages/prompts/#cancel @@ -21,11 +22,11 @@ import { type CommonOptions, S_BAR, S_BAR_END, S_BAR_START } from './common.js'; * process.exit(1); * ``` */ -export const cancel = (message = '', opts?: CommonOptions) => { +export const cancel = (message?: string, opts?: CommonOptions) => { const output: Writable = opts?.output ?? process.stdout; const hasGuide = opts?.withGuide ?? settings.withGuide; const prefix = hasGuide ? `${styleText('gray', S_BAR_END)} ` : ''; - output.write(`${prefix}${styleText('red', message)}\n\n`); + output.write(`${prefix}${styleText('red', message ?? settings.messages.cancel)}\n\n`); }; /** diff --git a/packages/prompts/test/messages.test.ts b/packages/prompts/test/messages.test.ts new file mode 100644 index 00000000..b6645a2d --- /dev/null +++ b/packages/prompts/test/messages.test.ts @@ -0,0 +1,50 @@ +import { styleText } from 'node:util'; +import { settings, updateSettings } from '@clack/core'; +import { afterEach, beforeEach, describe, expect, test } from 'vitest'; +import { S_BAR_END } from '../src/common.js'; +import * as prompts from '../src/index.js'; +import { MockWritable } from './test-utils.js'; + +describe('cancel', () => { + let output: MockWritable; + const defaultCancel = settings.messages.cancel; + + beforeEach(() => { + output = new MockWritable(); + }); + + afterEach(() => { + updateSettings({ messages: { cancel: defaultCancel } }); + }); + + const line = (message: string) => + `${styleText('gray', S_BAR_END)} ${styleText('red', message)}\n\n`; + + test('renders the given message', () => { + prompts.cancel('Installation canceled', { output }); + + expect(output.buffer.join('')).toBe(line('Installation canceled')); + }); + + test('renders the default cancel message when called without a message', () => { + prompts.cancel(undefined, { output }); + + expect(output.buffer.join('')).toBe(line(defaultCancel)); + }); + + test('renders the cancel message set with updateSettings', () => { + updateSettings({ messages: { cancel: 'Operation cancelled' } }); + + prompts.cancel(undefined, { output }); + + expect(output.buffer.join('')).toBe(line('Operation cancelled')); + }); + + test('an explicit empty message still renders nothing', () => { + updateSettings({ messages: { cancel: 'Operation cancelled' } }); + + prompts.cancel('', { output }); + + expect(output.buffer.join('')).toBe(line('')); + }); +});