Enable closing of fuzzyfinder from the caller by passing context #165
Conversation
This file contains 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
ktr0731
reviewed
Nov 18, 2022
fuzzyfinder.go
Outdated
| @@ -94,6 +98,12 @@ func (f *finder) initFinder(items []string, matched []matching.Matched, opt opt) | |||
| if err := f.term.Init(); err != nil { | |||
| return errors.Wrap(err, "failed to initialize screen") | |||
| } | |||
|
|
|||
| eventsChan := make(chan tcell.Event) | |||
| quitChan := make(chan struct{}) | |||
There was a problem hiding this comment.
This channel is not used anywhere so we can use a nil channel.
fuzzyfinder.go
Outdated
| @@ -25,6 +25,7 @@ import ( | |||
| var ( | |||
| // ErrAbort is returned from Find* functions if there are no selections. | |||
| ErrAbort = errors.New("abort") | |||
| ErrCancel = errors.New("cancel") | |||
There was a problem hiding this comment.
I think that we don't need a self-defined cancellation error. Context is a standard mechanism, so how about returning ctx.Err() simply?
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #165 +/- ##
==========================================
- Coverage 87.68% 87.42% -0.26%
==========================================
Files 5 5
Lines 828 851 +23
==========================================
+ Hits 726 744 +18
- Misses 89 94 +5
Partials 13 13 |
ktr0731
reviewed
Nov 20, 2022
Co-authored-by: ktr <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a new option called
WithContext. This enables callers offuzzyfinder.Findto cancel the passed context and forcefully makeFindreturn if completing it is no longer desirable.An example use case is when
Findis called with theWithHotReloadoption, but the caller does not have any items to put in the slice (e.g due to a failed network call).Please let me know what you think!