Skip to content

core rework/simplification #308

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
merged 4 commits into from
Apr 28, 2025
Merged

core rework/simplification #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
84e856f
wip: rework autocomplete and core
43081j Apr 27, 2025
abe94dc
fix: account for `undefined` values in passwords
43081j Apr 28, 2025
c1a91d5
Merge branch 'feat/autocomplete' into autocomplete-rework
43081j Apr 28, 2025
588d0de
fix: only allow single initial values when non-multiple
43081j Apr 28, 2025
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
249 changes: 159 additions & 90 deletions packages/core/src/prompts/autocomplete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,124 +1,193 @@
import type { Key } from 'node:readline';
import color from 'picocolors';
import Prompt, { type PromptOptions } from './prompt.js';

export interface AutocompleteOptions<T extends { value: any }>
interface OptionLike {
value: unknown;
label?: string;
}

type FilterFunction<T extends OptionLike> = (search: string, opt: T) => boolean;

function getCursorForValue<T extends OptionLike>(
selected: T['value'] | undefined,
items: T[]
): number {
if (selected === undefined) {
return 0;
}

const currLength = items.length;

// If filtering changed the available options, update cursor
if (currLength === 0) {
return 0;
}

// Try to maintain the same selected item
const index = items.findIndex((item) => item.value === selected);
return index !== -1 ? index : 0;
}

function defaultFilter<T extends OptionLike>(input: string, option: T): boolean {
const label = option.label ?? String(option.value);
return label.toLowerCase().includes(input.toLowerCase());
}

function normalisedValue<T>(multiple: boolean, values: T[] | undefined): T | T[] | undefined {
if (!values) {
return undefined;
}
if (multiple) {
return values;
}
return values[0];
}

export interface AutocompleteOptions<T extends OptionLike>
extends PromptOptions<AutocompletePrompt<T>> {
options: T[];
initialValue?: T['value'];
maxItems?: number;
filterFn?: (input: string, option: T) => boolean;
filter?: FilterFunction<T>;
multiple?: boolean;
}

export default class AutocompletePrompt<T extends { value: any; label?: string }> extends Prompt {
export default class AutocompletePrompt<T extends OptionLike> extends Prompt {
options: T[];
filteredOptions: T[];
cursor = 0;
maxItems: number;
filterFn: (input: string, option: T) => boolean;
isNavigationMode = false; // Track if we're in navigation mode
ignoreNextSpace = false; // Track if we should ignore the next space

private filterOptions() {
const input = this.value?.toLowerCase() ?? '';
// Remember the currently selected value before filtering
const previousSelectedValue = this.filteredOptions[this.cursor]?.value;

// Filter options based on the current input
this.filteredOptions = input
? this.options.filter((option) => this.filterFn(input, option))
: this.options;

// Reset cursor to 0 by default when filtering changes
this.cursor = 0;

// Try to maintain the previously selected item if it still exists in filtered results
if (previousSelectedValue !== undefined && this.filteredOptions.length > 0) {
const newIndex = this.filteredOptions.findIndex((opt) => opt.value === previousSelectedValue);
if (newIndex !== -1) {
// Found the same item in new filtered results, keep it selected
this.cursor = newIndex;
}
}
multiple: boolean;
isNavigating = false;
selectedValues: Array<T['value']> = [];

#focusedValue: T['value'] | undefined;
#cursor = 0;
#lastValue: T['value'] | undefined;
#filterFn: FilterFunction<T>;

get cursor(): number {
return this.#cursor;
}

// Store both the search input and the selected value
public get selectedValue(): T['value'] | undefined {
return this.filteredOptions[this.cursor]?.value;
get valueWithCursor() {
if (!this.value) {
return color.inverse(color.hidden('_'));
}
if (this._cursor >= this.value.length) {
return `${this.value}█`;
}
const s1 = this.value.slice(0, this._cursor);
const [s2, ...s3] = this.value.slice(this._cursor);
return `${s1}${color.inverse(s2)}${s3.join('')}`;
}

constructor(opts: AutocompleteOptions<T>) {
super(opts, true);
super(opts);

this.options = opts.options;
this.filteredOptions = [...this.options];
this.maxItems = opts.maxItems ?? 10;
this.filterFn = opts.filterFn ?? this.defaultFilterFn;

// Set initial value if provided
if (opts.initialValue !== undefined) {
const initialIndex = this.options.findIndex(({ value }) => value === opts.initialValue);
if (initialIndex !== -1) {
this.cursor = initialIndex;
this.multiple = opts.multiple === true;
this._usePlaceholderAsValue = false;
this.#filterFn = opts.filter ?? defaultFilter;
let initialValues: unknown[] | undefined;
if (opts.initialValue && Array.isArray(opts.initialValue)) {
if (this.multiple) {
initialValues = opts.initialValue;
} else {
initialValues = opts.initialValue.slice(0, 1);
}
}

// Handle keyboard key presses
this.on('key', (key) => {
// Enter navigation mode with arrow keys
if (key === 'up' || key === 'down') {
this.isNavigationMode = true;
if (initialValues) {
this.selectedValues = initialValues;
for (const selectedValue of initialValues) {
const selectedIndex = this.options.findIndex((opt) => opt.value === selectedValue);
if (selectedIndex !== -1) {
this.toggleSelected(selectedValue);
this.#cursor = selectedIndex;
this.#focusedValue = this.options[this.#cursor]?.value;
}
}
}

// Space key in navigation mode should be ignored for input
if (key === ' ' && this.isNavigationMode) {
this.ignoreNextSpace = true;
return false; // Prevent propagation
this.on('finalize', () => {
if (!this.value) {
this.value = normalisedValue(this.multiple, initialValues);
}

// Exit navigation mode with non-navigation keys
if (key !== 'up' && key !== 'down' && key !== 'return') {
this.isNavigationMode = false;
if (this.state === 'submit') {
this.value = normalisedValue(this.multiple, this.selectedValues);
}
});

// Handle cursor movement
this.on('cursor', (key) => {
switch (key) {
case 'up':
this.isNavigationMode = true;
this.cursor = this.cursor === 0 ? this.filteredOptions.length - 1 : this.cursor - 1;
break;
case 'down':
this.isNavigationMode = true;
this.cursor = this.cursor === this.filteredOptions.length - 1 ? 0 : this.cursor + 1;
break;
}
});
this.on('key', (char, key) => this.#onKey(char, key));
this.on('value', (value) => this.#onValueChanged(value));
}

// Update filtered options when input changes
this.on('value', (value) => {
// Check if we need to ignore a space
if (this.ignoreNextSpace && value?.endsWith(' ')) {
// Remove the space and reset the flag
this.value = value.replace(/\s+$/, '');
this.ignoreNextSpace = false;
return;
}
protected override _isActionKey(char: string | undefined, key: Key): boolean {
return (
char === '\t' ||
(this.multiple &&
this.isNavigating &&
key.name === 'space' &&
char !== undefined &&
char !== '')
);
}

// In navigation mode, strip out any spaces
if (this.isNavigationMode && value?.includes(' ')) {
this.value = value.replace(/\s+/g, '');
return;
#onKey(_char: string | undefined, key: Key): void {
const isUpKey = key.name === 'up';
const isDownKey = key.name === 'down';

// Start navigation mode with up/down arrows
if (isUpKey || isDownKey) {
this.#cursor = Math.max(
0,
Math.min(this.#cursor + (isUpKey ? -1 : 1), this.filteredOptions.length - 1)
);
this.#focusedValue = this.filteredOptions[this.#cursor]?.value;
if (!this.multiple) {
this.selectedValues = [this.#focusedValue];
}
this.isNavigating = true;
} else {
if (
this.multiple &&
this.#focusedValue !== undefined &&
(key.name === 'tab' || (this.isNavigating && key.name === 'space'))
) {
this.toggleSelected(this.#focusedValue);
} else {
this.isNavigating = false;
}
}
}

// Normal filtering when not in navigation mode
this.value = value;
this.filterOptions();
});
toggleSelected(value: T['value']) {
if (this.filteredOptions.length === 0) {
return;
}

if (this.multiple) {
if (this.selectedValues.includes(value)) {
this.selectedValues = this.selectedValues.filter((v) => v !== value);
} else {
this.selectedValues = [...this.selectedValues, value];
}
} else {
this.selectedValues = [value];
}
}

// Default filtering function
private defaultFilterFn(input: string, option: T): boolean {
const label = option.label ?? String(option.value);
return label.toLowerCase().includes(input.toLowerCase());
#onValueChanged(value: string | undefined): void {
if (value !== this.#lastValue) {
this.#lastValue = value;

if (value) {
this.filteredOptions = this.options.filter((opt) => this.#filterFn(value, opt));
} else {
this.filteredOptions = [...this.options];
}
this.#cursor = getCursorForValue(this.#focusedValue, this.filteredOptions);
this.#focusedValue = this.filteredOptions[this.#cursor]?.value;
}
}
}
28 changes: 13 additions & 15 deletions packages/core/src/prompts/password.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,27 @@ interface PasswordOptions extends PromptOptions<PasswordPrompt> {
mask?: string;
}
export default class PasswordPrompt extends Prompt {
valueWithCursor = '';
private _mask = '•';
get cursor() {
return this._cursor;
}
get masked() {
return this.value.replaceAll(/./g, this._mask);
return this.value?.replaceAll(/./g, this._mask) ?? '';
}
get valueWithCursor() {
if (this.state === 'submit' || this.state === 'cancel') {
return this.masked;
}
const value = this.value ?? '';
if (this.cursor >= value.length) {
return `${this.masked}${color.inverse(color.hidden('_'))}`;
}
const s1 = this.masked.slice(0, this.cursor);
const s2 = this.masked.slice(this.cursor);
return `${s1}${color.inverse(s2[0])}${s2.slice(1)}`;
}
constructor({ mask, ...opts }: PasswordOptions) {
super(opts);
this._mask = mask ?? '•';

this.on('finalize', () => {
this.valueWithCursor = this.masked;
});
this.on('value', () => {
if (this.cursor >= this.value.length) {
this.valueWithCursor = `${this.masked}${color.inverse(color.hidden('_'))}`;
} else {
const s1 = this.masked.slice(0, this.cursor);
const s2 = this.masked.slice(this.cursor);
this.valueWithCursor = `${s1}${color.inverse(s2[0])}${s2.slice(1)}`;
}
});
}
}
Loading