multiselect: initialValue -> initialValues (#73)

Author: natemoo-re

.changeset/tall-hairs-knock.md

@@ -0,0 +1,6 @@
+---
+"@clack/core": minor
+"@clack/prompts": minor
+---
+
+**Breaking Change** `multiselect` has renamed `initialValue` to `initialValues`

examples/basic/index.ts

@@ -42,7 +42,7 @@ async function main() {
 			tools: () =>
 				p.multiselect({
 					message: 'Select additional tools.',
-					initialValue: ['prettier', 'eslint'],
+					initialValues: ['prettier', 'eslint'],
 					options: [
 						{ value: 'prettier', label: 'Prettier', hint: 'recommended' },
 						{ value: 'eslint', label: 'ESLint', hint: 'recommended' },

packages/core/src/prompts/multi-select.ts

@@ -2,7 +2,7 @@ import Prompt, { PromptOptions } from './prompt';
 
 interface MultiSelectOptions<T extends { value: any }> extends PromptOptions<MultiSelectPrompt<T>> {
 	options: T[];
-	initialValue?: T['value'][];
+	initialValues?: T['value'][];
 	required?: boolean;
 	cursorAt?: T['value'];
 }
@@ -25,7 +25,7 @@ export default class MultiSelectPrompt<T extends { value: any }> extends Prompt
 		super(opts, false);
 
 		this.options = opts.options;
-		this.value = [...(opts.initialValue ?? [])];
+		this.value = [...(opts.initialValues ?? [])];
 		this.cursor = Math.max(
 			this.options.findIndex(({ value }) => value === opts.cursorAt),
 			0

packages/prompts/src/index.ts

@@ -219,7 +219,7 @@ export const select = <Options extends Option<Value>[], Value extends Primitive>
 export interface MultiSelectOptions<Options extends Option<Value>[], Value extends Primitive> {
 	message: string;
 	options: Options;
-	initialValue?: Options[number]['value'][];
+	initialValues?: Options[number]['value'][];
 	required?: boolean;
 	cursorAt?: Options[number]['value'];
 }
@@ -251,7 +251,7 @@ export const multiselect = <Options extends Option<Value>[], Value extends Primi
 
 	return new MultiSelectPrompt({
 		options: opts.options,
-		initialValue: opts.initialValue,
+		initialValues: opts.initialValues,
 		required: opts.required ?? true,
 		cursorAt: opts.cursorAt,
 		validate(selected: Value[]) {