[Proposal] replace elasticlunr with fuse.js #3
+2,068
−1,028
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
We relied on the elasticlunr library for client-side documentation search. However there's been some occurences of elasticlunr returning empty results in some cases where there are results, and search libraries are plenty so I wanted to see how its alternatives compared. For now I've just tested with the more recent fuse-js, which doesn't have the "empty result issue" elasticlunr has. We could still improve on search but that's a good first step.
|
I've also changed "boost" values for |
Florent-Bouisset
approved these changes
Jan 7, 2025
Florent-Bouisset
approved these changes
Jan 8, 2025
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.
We relied on the
elasticlunrlibrary for client-side documentation search.However there's been some occurences of elasticlunr returning empty results in some cases where there are results, and search libraries are plenty so I wanted to see how its alternatives compared.
For now I've just tested with the more recent fuse.js, which doesn't have the "empty result issue" elasticlunr has.
As for
elasticlunr,fuse.jsis "vendored" inside thebuild/directory instead of relying on Node.js's package managment and npm. This is because our client-side script isn't transformed for now, for simplicity reasons.We could still improve on search but that's a good first step. To me having that and something like #1 could add some quick wins to README's search.