Skip to content

Remove query parser characters from search term #2148

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

Open
travisbeckham wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove query parser characters from search term #2148

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d964760
Remove query parser characters from search term
travisbeckham Jul 24, 2026
2f91921
Merge branch 'main' into travis/search
travisbeckham Jul 30, 2026
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
13 changes: 12 additions & 1 deletion linkerd.io/assets/js/search.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,19 @@ window.addEventListener(
request.addEventListener("error", renderError, false);
request.send(null);
};
// Lunr's query parser treats characters like : + - * ~ ^ as query syntax,
// so remove them to keep user input literal and avoid throwing an error
// when a search term contains them.
// https://lunrjs.com/guides/searching.html#fields
const escapeLunrQuery = (text) => text.replace(/[:+\-*~^]/g, " ");
const renderSearchResults = () => {
const results = index.search(query);
let results;
try {
results = index.search(escapeLunrQuery(query));
} catch (e) {
renderError();
return;
}
// Remove loader
target.innerHTML = "";
// Render header
Expand Down
Loading