-
Notifications
You must be signed in to change notification settings - Fork 189
fix(core): skip double-filtering when options is a function #489
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
Closed
brick-pixel
wants to merge
3
commits into
bombshell-dev:main
from
brick-pixel:fix/autocomplete-double-filter
+72
−1
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| '@clack/core': minor | ||
| --- | ||
|
|
||
| feat(core): skip default filter when options is a function | ||
|
|
||
| When `options` is provided as a function, the default filter is no longer applied on top of the function's results. If both `options` (function) and a custom `filter` are provided, the filter is still applied. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -197,4 +197,59 @@ describe('AutocompletePrompt', () => { | |
| expect(instance.selectedValues).to.deep.equal([]); | ||
| expect(result).to.deep.equal([]); | ||
| }); | ||
|
|
||
| test('options function skips default filter when no custom filter provided', () => { | ||
| const optionsFn = function (this: any) { | ||
| const input = this.userInput || ''; | ||
| if (!input) return testOptions; | ||
| return testOptions.filter((opt) => opt.value.startsWith(input)); | ||
| }; | ||
|
|
||
| const instance = new AutocompletePrompt({ | ||
| input, | ||
| output, | ||
| render: () => 'foo', | ||
| options: optionsFn, | ||
| }); | ||
|
|
||
| instance.prompt(); | ||
|
|
||
| // Type 'b' - options function returns only 'banana' | ||
| input.emit('keypress', 'b', { name: 'b' }); | ||
|
|
||
| // Should use the options function result as-is, no additional filtering | ||
| expect(instance.filteredOptions).toEqual([ | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. wouldn't this pass if the default filter was being applied too? you should probably make your options function do some unusual filtering. e.g. filter to a constant result |
||
| { value: 'banana', label: 'Banana' }, | ||
| ]); | ||
| }); | ||
|
|
||
| test('options function applies custom filter when both are provided', () => { | ||
| const optionsFn = function (this: any) { | ||
| return testOptions; | ||
| }; | ||
|
|
||
| const customFilter = (search: string, opt: { value: string; label?: string }) => { | ||
| return opt.value.includes(search); | ||
| }; | ||
|
|
||
| const instance = new AutocompletePrompt({ | ||
| input, | ||
| output, | ||
| render: () => 'foo', | ||
| options: optionsFn, | ||
| filter: customFilter, | ||
| }); | ||
|
|
||
| instance.prompt(); | ||
|
|
||
| // Type 'an' - custom filter should run on top of options function result | ||
| input.emit('keypress', 'a', { name: 'a' }); | ||
| input.emit('keypress', 'n', { name: 'n' }); | ||
|
|
||
| // Custom filter: 'an' matches banana and orange | ||
| expect(instance.filteredOptions).toEqual([ | ||
| { value: 'banana', label: 'Banana' }, | ||
| { value: 'orange', label: 'Orange' }, | ||
| ]); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you don't need
anyin this repo as we always have a type. this one is anAutocompletePrompt