fix: correctly specify return type of CANCEL_SYMBOL

.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`

packages/core/src/prompts/prompt.ts

@@ -144,7 +144,7 @@ export default class Prompt<TValue> {
 	}
 
 	public prompt() {
-		return new Promise<TValue | symbol | undefined>((resolve) => {
+		return new Promise<TValue | typeof CANCEL_SYMBOL | undefined>((resolve) => {
 			if (this._abortSignal) {
 				if (this._abortSignal.aborted) {
 					this.state = 'cancel';

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 = <Value>(opts: AutocompleteOptions<Value>) => {
 	});
 
 	// Return the result or cancel symbol
-	return prompt.prompt() as Promise<Value | symbol>;
+	return prompt.prompt() as Promise<Value | typeof CANCEL_SYMBOL>;
 };
 
 /**
@@ -452,5 +452,5 @@ export const autocompleteMultiselect = <Value>(opts: AutocompleteMultiSelectOpti
 	});
 
 	// Return the result or cancel symbol
-	return prompt.prompt() as Promise<Value[] | symbol>;
+	return prompt.prompt() as Promise<Value[] | typeof CANCEL_SYMBOL>;
 };

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<boolean | symbol>;
+	}).prompt() as Promise<boolean | typeof CANCEL_SYMBOL>;
 };

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<Date | symbol>;
+	}).prompt() as Promise<Date | typeof CANCEL_SYMBOL>;
 };
 
 function renderDate(prompt: Omit<InstanceType<typeof DatePrompt>, 'prompt'>, state: State): string {

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 = <Value>(opts: GroupMultiSelectOptions<Value>) =>
 				}
 			}
 		},
-	}).prompt() as Promise<Value[] | symbol>;
+	}).prompt() as Promise<Value[] | typeof CANCEL_SYMBOL>;
 };

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<string | symbol>;
+	}).prompt() as Promise<string | typeof CANCEL_SYMBOL>;
 };

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 = <Value>(opts: MultiSelectOptions<Value>) => {
 				}
 			}
 		},
-	}).prompt() as Promise<Value[] | symbol>;
+	}).prompt() as Promise<Value[] | typeof CANCEL_SYMBOL>;
 };

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<string | symbol>;
+	}).prompt() as Promise<string | typeof CANCEL_SYMBOL>;
 };

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 = <Value extends string>(opts: SelectKeyOptions<Value>) =
 				}
 			}
 		},
-	}).prompt() as Promise<Value | symbol>;
+	}).prompt() as Promise<Value | typeof CANCEL_SYMBOL>;
 };

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 = <Value>(opts: SelectOptions<Value>) => {
 				}
 			}
 		},
-	}).prompt() as Promise<Value | symbol>;
+	}).prompt() as Promise<Value | typeof CANCEL_SYMBOL>;
 };

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<string | symbol>;
+	}).prompt() as Promise<string | typeof CANCEL_SYMBOL>;
 };