Search suggestions #85
Merged
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
… showing suggestions for
…rk with the tailwind extension
…plitQuery to support quote capturing. Various cleanups
brendan-kellam
commented
Nov 22, 2024
packages/web/src/app/components/searchBar/searchSuggestionsBox.tsx
Outdated
Show resolved
Hide resolved
…stion. Add UTs for completeSuggestion
msukkari
approved these changes
Nov 22, 2024
Merged
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.
The following PR introduces search suggestions:
Screen.Recording.2024-11-21.at.4.22.05.PM.mov
The motivation for building search suggestions is two-fold: (1) to make the zoekt query language more approachable by presenting all available options to the user, and (2) make it easier for power-users to craft complex queries.
The meat-n-potatoes of this change are concentrated in
searchBar.tsxandsearchSuggestionBox.tsx. The suggestions box works by maintaining a state-machine of "modes". By default, the box is in therefinemode, where suggestions for different prefixes (e.g.,repo:,lang:, etc.) are suggested to the user. When one of these prefixes is matched, the state-machine transitions to the corresponding mode (e.g.,repository,language, etc.) and surfaces suggestions for that mode (if any).The query is split up into parts by spaces " " (e.g.,
'test repo:hello'->['test', 'repo:hello']). SeesplitQuery. The part that has the cursor over it is considered the active part. We evaluate which mode the state machine is in based on the active part. When a suggestion is clicked, we only modify the active part of the query.Three modes are currently missing suggestion data:
file(file names),revision(branch / tag names), andsymbol(symbol names). In future PRs, we will need to introduce endpoints into the backend to allow the frontend to fetch this data and surface it as suggestions..