Skip to content

Support booleans and numbers in select values #49

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 1 commit into from
Feb 16, 2023
Merged

Support booleans and numbers in select values #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/bright-eagles-happen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": minor
---

Improve types for select/multiselect prompts. Numbers and booleans are now supported as the `value` option.
15 changes: 8 additions & 7 deletions packages/prompts/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,32 +105,33 @@ export const confirm = (opts: ConfirmOptions) => {
}).prompt() as Promise<boolean | symbol>;
};

interface Option<Value extends Readonly<string>> {
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 Readonly<string>> {
export interface SelectOptions<Options extends Option<Value>[], Value extends Primitive> {
message: string;
options: Options;
initialValue?: Options[number]["value"];
}

export interface MultiSelectOptions<Options extends Option<Value>[], Value extends Readonly<string>> {
export interface MultiSelectOptions<Options extends Option<Value>[], Value extends Primitive> {
message: string;
options: Options;
initialValue?: Options[number]['value'][];
cursorAt?: Options[number]["value"]
}

export const select = <Options extends Option<Value>[], Value extends Readonly<string>>(
export const select = <Options extends Option<Value>[], Value extends Primitive>(
opts: SelectOptions<Options, Value>
) => {
const opt = (
option: Options[number],
state: "inactive" | "active" | "selected" | "cancelled"
) => {
const label = option.label ?? option.value;
const label = option.label ?? String(option.value);
if (state === "active") {
return `${color.green("●")} ${label} ${
option.hint ? color.dim(`(${option.hint})`) : ""
Expand Down Expand Up @@ -174,9 +175,9 @@ export const select = <Options extends Option<Value>[], Value extends Readonly<s
}).prompt() as Promise<Options[number]['value'] | symbol>;
};

export const multiselect = <Options extends Option<Value>[], Value extends Readonly<string>>(opts: MultiSelectOptions<Options, Value>) => {
export const multiselect = <Options extends Option<Value>[], Value extends Primitive>(opts: MultiSelectOptions<Options, Value>) => {
const opt = (option: Options[number], state: 'inactive' | 'active' | 'selected' | 'active-selected' | 'submitted' | 'cancelled') => {
const label = option.label ?? option.value;
const label = option.label ?? String(option.value);
if (state === 'active') {
return `${color.cyan('◻')} ${label} ${option.hint ? color.dim(`(${option.hint})`) : ''}`
} else if (state === 'selected') {
Expand Down