diff --git a/.changeset/lucky-plums-tell.md b/.changeset/lucky-plums-tell.md new file mode 100644 index 00000000..c1168890 --- /dev/null +++ b/.changeset/lucky-plums-tell.md @@ -0,0 +1,6 @@ +--- +"@clack/core": patch +"@clack/prompts": patch +--- + +Return type for prompts now correctly specifies `CANCEL_SYMBOL` instead of `symbol` diff --git a/packages/core/src/prompts/prompt.ts b/packages/core/src/prompts/prompt.ts index 1c906f98..d1c61961 100644 --- a/packages/core/src/prompts/prompt.ts +++ b/packages/core/src/prompts/prompt.ts @@ -144,7 +144,7 @@ export default class Prompt { } public prompt() { - return new Promise((resolve) => { + return new Promise((resolve) => { if (this._abortSignal) { if (this._abortSignal.aborted) { this.state = 'cancel'; diff --git a/packages/prompts/src/autocomplete.ts b/packages/prompts/src/autocomplete.ts index af6d76a2..f3dd1465 100644 --- a/packages/prompts/src/autocomplete.ts +++ b/packages/prompts/src/autocomplete.ts @@ -1,5 +1,5 @@ import { styleText } from 'node:util'; -import type { Validate } from '@clack/core'; +import type { CANCEL_SYMBOL, Validate } from '@clack/core'; import { AutocompletePrompt, settings } from '@clack/core'; import { type CommonOptions, @@ -268,7 +268,7 @@ export const autocomplete = (opts: AutocompleteOptions) => { }); // Return the result or cancel symbol - return prompt.prompt() as Promise; + return prompt.prompt() as Promise; }; /** @@ -452,5 +452,5 @@ export const autocompleteMultiselect = (opts: AutocompleteMultiSelectOpti }); // Return the result or cancel symbol - return prompt.prompt() as Promise; + return prompt.prompt() as Promise; }; diff --git a/packages/prompts/src/confirm.ts b/packages/prompts/src/confirm.ts index 2e537f1c..06f822fd 100644 --- a/packages/prompts/src/confirm.ts +++ b/packages/prompts/src/confirm.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { ConfirmPrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { type CommonOptions, @@ -107,5 +108,5 @@ export const confirm = (opts: ConfirmOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/date.ts b/packages/prompts/src/date.ts index d4b96998..6214a519 100644 --- a/packages/prompts/src/date.ts +++ b/packages/prompts/src/date.ts @@ -1,5 +1,5 @@ import { styleText } from 'node:util'; -import type { DateFormat, State, Validate } from '@clack/core'; +import type { CANCEL_SYMBOL, DateFormat, State, Validate } from '@clack/core'; import { DatePrompt, runValidation, settings } from '@clack/core'; import { type CommonOptions, S_BAR, S_BAR_END, symbol } from './common.js'; @@ -133,7 +133,7 @@ export const date = (opts: DateOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; function renderDate(prompt: Omit, 'prompt'>, state: State): string { diff --git a/packages/prompts/src/group-multi-select.ts b/packages/prompts/src/group-multi-select.ts index 476689ef..2cfd26aa 100644 --- a/packages/prompts/src/group-multi-select.ts +++ b/packages/prompts/src/group-multi-select.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { GroupMultiSelectPrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { type CommonOptions, @@ -315,5 +316,5 @@ export const groupMultiselect = (opts: GroupMultiSelectOptions) => } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/multi-line.ts b/packages/prompts/src/multi-line.ts index b8e4d4ba..26d0e778 100644 --- a/packages/prompts/src/multi-line.ts +++ b/packages/prompts/src/multi-line.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { MultiLinePrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { S_BAR, S_BAR_END, symbol } from './common.js'; import type { TextOptions } from './text.js'; @@ -98,5 +99,5 @@ export const multiline = (opts: MultiLineOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/multi-select.ts b/packages/prompts/src/multi-select.ts index e5db7069..b52239cc 100644 --- a/packages/prompts/src/multi-select.ts +++ b/packages/prompts/src/multi-select.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { MultiSelectPrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { type CommonOptions, @@ -204,5 +205,5 @@ export const multiselect = (opts: MultiSelectOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/password.ts b/packages/prompts/src/password.ts index 76395286..df9a18f9 100644 --- a/packages/prompts/src/password.ts +++ b/packages/prompts/src/password.ts @@ -1,5 +1,5 @@ import { styleText } from 'node:util'; -import type { Validate } from '@clack/core'; +import type { CANCEL_SYMBOL, Validate } from '@clack/core'; import { PasswordPrompt, settings } from '@clack/core'; import { type CommonOptions, S_BAR, S_BAR_END, S_PASSWORD_MASK, symbol } from './common.js'; @@ -88,5 +88,5 @@ export const password = (opts: PasswordOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/select-key.ts b/packages/prompts/src/select-key.ts index 6cb0c589..300aece2 100644 --- a/packages/prompts/src/select-key.ts +++ b/packages/prompts/src/select-key.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { SelectKeyPrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { type CommonOptions, S_BAR, S_BAR_END, symbol } from './common.js'; import type { Option } from './select.js'; @@ -83,5 +84,5 @@ export const selectKey = (opts: SelectKeyOptions) = } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/select.ts b/packages/prompts/src/select.ts index 13f57d2f..fc87a58a 100644 --- a/packages/prompts/src/select.ts +++ b/packages/prompts/src/select.ts @@ -1,4 +1,5 @@ import { styleText } from 'node:util'; +import type { CANCEL_SYMBOL } from '@clack/core'; import { SelectPrompt, settings, wrapTextWithPrefix } from '@clack/core'; import { type CommonOptions, @@ -182,5 +183,5 @@ export const select = (opts: SelectOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; }; diff --git a/packages/prompts/src/text.ts b/packages/prompts/src/text.ts index 5e958eb3..270d9592 100644 --- a/packages/prompts/src/text.ts +++ b/packages/prompts/src/text.ts @@ -1,5 +1,5 @@ import { styleText } from 'node:util'; -import type { Validate } from '@clack/core'; +import type { CANCEL_SYMBOL, Validate } from '@clack/core'; import { settings, TextPrompt } from '@clack/core'; import { type CommonOptions, S_BAR, S_BAR_END, symbol } from './common.js'; @@ -107,5 +107,5 @@ export const text = (opts: TextOptions) => { } } }, - }).prompt() as Promise; + }).prompt() as Promise; };