Skip to content

fix(#44) complex values #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
natemoo-re merged 2 commits into from
Feb 26, 2023
Merged

fix(#44) complex values #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
938d204
select prompts: simplify option value types
ulken Feb 25, 2023
ca08fb6
select prompts: support complex value types
ulken Feb 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/olive-birds-brush.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

Support complex value types for `select`, `multiselect` and `groupMultiselect`.
53 changes: 25 additions & 28 deletions packages/prompts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,24 +169,21 @@ export const confirm = (opts: ConfirmOptions) => {
};

type Primitive = Readonly<string | boolean | number>;
interface Option<Value extends Primitive> {
value: Value;
label?: string;
hint?: string;
}
export interface SelectOptions<Options extends Option<Value>[], Value extends Primitive> {

type Option<Value> = Value extends Primitive
? { value: Value; label?: string; hint?: string }

@ulken ulken Feb 26, 2023 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suppose we could extract aliases for these, if it would make it easier to decipher violations?

type PrimitiveOption<Value extends Primitive> = { value: Value; label?: string; hint?: string>

type ComplexOption<Value> = { value: Value; label: string; hint?: string>

@ulken ulken Feb 26, 2023

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natemoo-re thoughts?

: { value: Value; label: string; hint?: string };

export interface SelectOptions<Options extends Option<Value>[], Value> {
message: string;
options: Options;
initialValue?: Options[number]['value'];
initialValue?: Value;
}

export const select = <Options extends Option<Value>[], Value extends Primitive>(
export const select = <Options extends Option<Value>[], Value>(
opts: SelectOptions<Options, Value>
) => {
const opt = (
option: Options[number],
state: 'inactive' | 'active' | 'selected' | 'cancelled'
) => {
const opt = (option: Option<Value>, state: 'inactive' | 'active' | 'selected' | 'cancelled') => {
const label = option.label ?? String(option.value);
if (state === 'active') {
return `${color.green(S_RADIO_ACTIVE)} ${label} ${
Expand Down Expand Up @@ -221,14 +218,14 @@ export const select = <Options extends Option<Value>[], Value extends Primitive>
}
}
},
}).prompt() as Promise<Options[number]['value'] | symbol>;
}).prompt() as Promise<Value | symbol>;
};

export const selectKey = <Options extends Option<Value>[], Value extends string>(
opts: SelectOptions<Options, Value>
) => {
const opt = (
option: Options[number],
option: Option<Value>,
state: 'inactive' | 'active' | 'selected' | 'cancelled' = 'inactive'
) => {
const label = option.label ?? String(option.value);
Expand Down Expand Up @@ -269,21 +266,21 @@ export const selectKey = <Options extends Option<Value>[], Value extends string>
}
}
},
}).prompt() as Promise<Options[number]['value'] | symbol>;
}).prompt() as Promise<Value | symbol>;
};

export interface MultiSelectOptions<Options extends Option<Value>[], Value extends Primitive> {
export interface MultiSelectOptions<Options extends Option<Value>[], Value> {
message: string;
options: Options;
initialValues?: Options[number]['value'][];
initialValues?: Value[];
required?: boolean;
cursorAt?: Options[number]['value'];
cursorAt?: Value;
}
export const multiselect = <Options extends Option<Value>[], Value extends Primitive>(
export const multiselect = <Options extends Option<Value>[], Value>(
opts: MultiSelectOptions<Options, Value>
) => {
const opt = (
option: Options[number],
option: Option<Value>,
state: 'inactive' | 'active' | 'selected' | 'active-selected' | 'submitted' | 'cancelled'
) => {
const label = option.label ?? String(option.value);
Expand Down Expand Up @@ -387,21 +384,21 @@ export const multiselect = <Options extends Option<Value>[], Value extends Primi
}
}
},
}).prompt() as Promise<Options[number]['value'][] | symbol>;
}).prompt() as Promise<Value[] | symbol>;
};

export interface GroupMultiSelectOptions<Options extends Option<Value>[], Value extends Primitive> {
export interface GroupMultiSelectOptions<Options extends Option<Value>[], Value> {
message: string;
options: Record<string, Options>;
initialValues?: Options[number]['value'][];
initialValues?: Value[];
required?: boolean;
cursorAt?: Options[number]['value'];
cursorAt?: Value;
}
export const groupMultiselect = <Options extends Option<Value>[], Value extends Primitive>(
export const groupMultiselect = <Options extends Option<Value>[], Value>(
opts: GroupMultiSelectOptions<Options, Value>
) => {
const opt = (
option: Options[number],
option: Option<Value>,
state:
| 'inactive'
| 'active'
Expand All @@ -411,7 +408,7 @@ export const groupMultiselect = <Options extends Option<Value>[], Value extends
| 'group-active-selected'
| 'submitted'
| 'cancelled',
options: Options[number][] = [] as any
options: Option<Value>[] = []
) => {
const label = option.label ?? String(option.value);
const isItem = typeof (option as any).group === 'string';
Expand Down Expand Up @@ -531,7 +528,7 @@ export const groupMultiselect = <Options extends Option<Value>[], Value extends
}
}
},
}).prompt() as Promise<Options[number]['value'][] | symbol>;
}).prompt() as Promise<Value[] | symbol>;
};

const strip = (str: string) => str.replace(ansiRegex(), '');
Expand Down