Skip to content

Fix Settings search dropping settings that contain the query substring #310898

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
yogeshwaran-c wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −1
Open

Fix Settings search dropping settings that contain the query substring #310898

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion src/vs/workbench/contrib/preferences/browser/preferencesSearch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,17 @@ export class LocalSearchProvider implements ISearchProvider {

// Check the top key match type.
const topKeyMatchType = Math.max(...filterMatches.map(m => (m.matchType & SettingKeyMatchTypes)));
// If the query is a contiguous substring of any setting's ID, the query is
// specific enough that we keep all key-level matches rather than dropping
// lower-tier ones. This ensures siblings whose IDs differ by small details
// (e.g. plural vs. singular) still surface when the user types a precise
// substring. See https://github.com/microsoft/vscode/issues/247715.
const hasSubstringIdMatch = filterMatches.some(m => m.matchType & SettingMatchType.ContiguousQueryInSettingId);
const allowedKeyMatchTypes = hasSubstringIdMatch ? SettingKeyMatchTypes : topKeyMatchType;
// Always allow description matches as part of https://github.com/microsoft/vscode/issues/239936.
const alwaysAllowedMatchTypes = SettingMatchType.DescriptionOrValueMatch | SettingMatchType.LanguageTagSettingMatch;
const filteredMatches = filterMatches
.filter(m => (m.matchType & topKeyMatchType) || (m.matchType & alwaysAllowedMatchTypes) || m.matchType === SettingMatchType.ExactMatch)
.filter(m => (m.matchType & allowedKeyMatchTypes) || (m.matchType & alwaysAllowedMatchTypes) || m.matchType === SettingMatchType.ExactMatch)
.map(m => ({ ...m, providerName: STRING_MATCH_SEARCH_PROVIDER_NAME }));
return Promise.resolve({
filterMatches: filteredMatches,
Expand Down