Skip to content

feat: add invert selection for multiselect prompt #358

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.

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
merged 3 commits into from
Aug 12, 2025
Merged
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
5 changes: 5 additions & 0 deletions .changeset/upset-showers-grow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/core": patch
---

add invert selection for multiselect prompt
8 changes: 8 additions & 0 deletions packages/core/src/prompts/multi-select.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ export default class MultiSelectPrompt<T extends { value: any }> extends Prompt<
this.value = allSelected ? [] : this.options.map((v) => v.value);
}

private toggleInvert() {
const notSelected = this.options.filter((v) => !this.value.includes(v.value));
this.value = notSelected.map((v) => v.value);
}

private toggleValue() {
if (this.value === undefined) {
this.value = [];
Expand All @@ -43,6 +48,9 @@ export default class MultiSelectPrompt<T extends { value: any }> extends Prompt<
if (char === 'a') {
this.toggleAll();
}
if (char === 'i') {
this.toggleInvert();
}
});

this.on('cursor', (key) => {
Expand Down
134 changes: 134 additions & 0 deletions packages/core/test/prompts/multi-select.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
import { cursor } from 'sisteransi';
import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
import { default as MultiSelectPrompt } from '../../src/prompts/multi-select.js';
import { MockReadable } from '../mock-readable.js';
import { MockWritable } from '../mock-writable.js';

describe('MultiSelectPrompt', () => {
let input: MockReadable;
let output: MockWritable;

beforeEach(() => {
input = new MockReadable();
output = new MockWritable();
});

afterEach(() => {
vi.restoreAllMocks();
});

test('renders render() result', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
});
instance.prompt();
expect(output.buffer).to.deep.equal([cursor.hide, 'foo']);
});

describe('cursor', () => {
test('cursor is index of selected item', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
});

instance.prompt();

expect(instance.cursor).to.equal(0);
input.emit('keypress', 'down', { name: 'down' });
expect(instance.cursor).to.equal(1);
});

test('cursor loops around', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }, { value: 'baz' }],
});

instance.prompt();

expect(instance.cursor).to.equal(0);
input.emit('keypress', 'up', { name: 'up' });
expect(instance.cursor).to.equal(2);
input.emit('keypress', 'down', { name: 'down' });
expect(instance.cursor).to.equal(0);
});

test('left behaves as up', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }, { value: 'baz' }],
});

instance.prompt();

input.emit('keypress', 'left', { name: 'left' });
expect(instance.cursor).to.equal(2);
});

test('right behaves as down', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
});

instance.prompt();

input.emit('keypress', 'left', { name: 'left' });
expect(instance.cursor).to.equal(1);
});

test('initial values is selected', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
initialValues: ['bar'],
});
instance.prompt();
expect(instance.value).toEqual(['bar']);
});

test('select all when press "a" key', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
});
instance.prompt();

input.emit('keypress', 'down', { name: 'down' });
input.emit('keypress', 'space', { name: 'space' });
input.emit('keypress', 'a', { name: 'a' });
expect(instance.value).toEqual(['foo', 'bar']);
});

test('select invert when press "i" key', () => {
const instance = new MultiSelectPrompt({
input,
output,
render: () => 'foo',
options: [{ value: 'foo' }, { value: 'bar' }],
});
instance.prompt();

input.emit('keypress', 'down', { name: 'down' });
input.emit('keypress', 'space', { name: 'space' });
input.emit('keypress', 'i', { name: 'i' });
expect(instance.value).toEqual(['foo']);
});
});
});