Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .changeset/proud-donuts-listen.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@clack/core": patch
"@clack/prompts": patch
---

Prevent `selectKey` from selecting disabled options.
11 changes: 8 additions & 3 deletions packages/core/src/prompts/select-key.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import Prompt, { type PromptOptions } from './prompt.js';

export interface SelectKeyOptions<T extends { value: string }>
export interface SelectKeyOptions<T extends { value: string; disabled?: boolean }>
extends PromptOptions<T['value'], SelectKeyPrompt<T>> {
options: T[];
caseSensitive?: boolean;
}
export default class SelectKeyPrompt<T extends { value: string }> extends Prompt<T['value']> {
export default class SelectKeyPrompt<
T extends { value: string; disabled?: boolean },
> extends Prompt<T['value']> {
options: T[];
cursor = 0;

Expand All @@ -28,7 +30,10 @@ export default class SelectKeyPrompt<T extends { value: string }> extends Prompt
return;
}

const value = this.options.find(({ value: [initial] }) => {
const value = this.options.find(({ value: [initial], disabled }) => {
if (disabled) {
return false;
}
return caseSensitive ? initial === casedKey : initial?.toLowerCase() === casedKey;
});
if (value) {
Expand Down
33 changes: 33 additions & 0 deletions packages/prompts/test/select-key.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,39 @@ describe.each(['true', 'false'])('text (isCI = %s)', (isCI) => {
expect(value).toBe('b');
});

test('does not select disabled options', async () => {
const result = prompts.selectKey({
message: 'foo',
options: [
{ label: 'Disabled', value: 'd', disabled: true },
{ label: 'Enabled', value: 'e' },
],
input,
output,
});

input.emit('keypress', 'd', { name: 'd' });
input.emit('keypress', 'e', { name: 'e' });

expect(await result).toBe('e');
});

test('skips disabled options sharing the same initial', async () => {
const result = prompts.selectKey({
message: 'foo',
options: [
{ label: 'delete', value: 'delete', disabled: true },
{ label: 'deploy', value: 'deploy' },
],
input,
output,
});

input.emit('keypress', 'd', { name: 'd' });

expect(await result).toBe('deploy');
});

test('can cancel by pressing escape', async () => {
const result = prompts.selectKey({
message: 'foo',
Expand Down
Loading