feat(@clack/core,@clack/prompts): Adding a new warn state to the validate method

examples/basic/index.ts

@@ -16,16 +16,16 @@ async function main() {
 					message: 'Where should we create your project?',
 					placeholder: './sparkling-solid',
 					validate: (value) => {
-						if (!value) return 'Please enter a path.';
-						if (value[0] !== '.') return 'Please enter a relative path.';
+						if (!value) return { status: 'error', message: 'Please enter a path.' };
+						if (value[0] !== '.') return { status: 'warn', message: 'warn: Relative path may not work' };
 					},
 				}),
 			password: () =>
 				p.password({
 					message: 'Provide a password',
 					validate: (value) => {
-						if (!value) return 'Please enter a password.';
-						if (value.length < 5) return 'Password should have at least 5 characters.';
+						if (!value) return { status: 'error', message: 'Please enter a password.' };
+						if (value.length < 5) return { status: 'warn', message: 'warn: Password security is too low' };
 					},
 				}),
 			type: ({ results }) =>

packages/core/src/index.ts

@@ -3,7 +3,7 @@ export { default as GroupMultiSelectPrompt } from './prompts/group-multiselect';
 export { default as MultiSelectPrompt } from './prompts/multi-select';
 export { default as PasswordPrompt } from './prompts/password';
 export { default as Prompt, isCancel } from './prompts/prompt';
-export type { State } from './prompts/prompt';
+export type { State, ValidateType } from './prompts/prompt';
 export { default as SelectPrompt } from './prompts/select';
 export { default as SelectKeyPrompt } from './prompts/select-key';
 export { default as TextPrompt } from './prompts/text';

packages/core/src/prompts/prompt.ts

@@ -38,17 +38,18 @@ const aliases = new Map([
 ]);
 const keys = new Set(['up', 'down', 'left', 'right', 'space', 'enter']);
 
+export type ValidateType = ((value: any) => ({ status: 'error' | 'warn', message: string } | void));
 export interface PromptOptions<Self extends Prompt> {
 	render(this: Omit<Self, 'prompt'>): string | void;
 	placeholder?: string;
 	initialValue?: any;
-	validate?: ((value: any) => string | void) | undefined;
+	validate?: ValidateType;
 	input?: Readable;
 	output?: Writable;
 	debug?: boolean;
 }
 
-export type State = 'initial' | 'active' | 'cancel' | 'submit' | 'error';
+export type State = 'initial' | 'active' | 'cancel' | 'submit' | 'error' | 'warn';
 
 export default class Prompt {
 	protected input: Readable;
@@ -62,6 +63,7 @@ export default class Prompt {
 	public state: State = 'initial';
 	public value: any;
 	public error: string = '';
+	public warn: string = ''
 
 	constructor(
 		{ render, input = stdin, output = stdout, ...opts }: PromptOptions<Prompt>,
@@ -154,9 +156,10 @@ export default class Prompt {
 	}
 
 	private onKeypress(char: string, key?: Key) {
-		if (this.state === 'error') {
+		if ((this.state === 'error' || this.state === 'warn') && key?.name !== 'return') {
 			this.state = 'active';
 		}
+
 		if (key?.name && !this._track && aliases.has(key.name)) {
 			this.emit('cursor', aliases.get(key.name));
 		}
@@ -176,18 +179,28 @@ export default class Prompt {
 			this.emit('key', char.toLowerCase());
 		}
 
+
 		if (key?.name === 'return') {
-			if (this.opts.validate) {
-				const problem = this.opts.validate(this.value);
-				if (problem) {
-					this.error = problem;
-					this.state = 'error';
-					this.rl.write(this.value);
+			if (this.state === 'warn') {
+				this.state = 'submit'
+			} else {
+				if (this.opts.validate) {
+					const problem = this.opts.validate(this.value);
+					if (problem?.status === 'error') {
+						this.error = problem.message;
+						this.state = 'error';
+						this.rl.write(this.value);
+					} else if (problem?.status === 'warn') {
+						this.warn = problem.message;
+						this.state = 'warn';
+						this.rl.write(this.value);
+					} else {
+						this.state = 'submit';
+					}
+				} else {
+					this.state = 'submit';
 				}
 			}
-			if (this.state !== 'error') {
-				this.state = 'submit';
-			}
 		}
 		if (char === '\x03') {
 			this.state = 'cancel';

packages/prompts/README.md

@@ -56,8 +56,13 @@ const meaning = await text({
   placeholder: 'Not sure',
   initialValue: '42',
   validate(value) {
-    if (value.length === 0) return `Value is required!`;
-  },
+    if (value.length === 0) {
+		return {
+			status:'error',
+			message:'Value is required!'
+	    };
+	}
+  }
 });
 ```