Skip to content
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

Jump to bottom

fix: revert settings search results ordering #198703

Merged
merged 2 commits into from
Nov 20, 2023
Merged

fix: revert settings search results ordering #198703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a0eac6
fix: revert Settings search order
rzhao271 Nov 20, 2023
6f2e771
fix: correct outdated description
rzhao271 Nov 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 6 additions & 11 deletions src/vs/workbench/contrib/preferences/browser/settingsTreeModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -866,7 +866,7 @@ export class SearchResultModel extends SettingsTreeModel {
viewState: ISettingsEditorViewState,
settingsOrderByTocIndex: Map<string, number> | null,
isWorkspaceTrusted: boolean,
@IWorkbenchConfigurationService private readonly configurationService: IWorkbenchConfigurationService,
@IWorkbenchConfigurationService configurationService: IWorkbenchConfigurationService,
@IWorkbenchEnvironmentService private readonly environmentService: IWorkbenchEnvironmentService,
@ILanguageService languageService: ILanguageService,
@IUserDataProfileService userDataProfileService: IUserDataProfileService,
Expand All @@ -884,18 +884,13 @@ export class SearchResultModel extends SettingsTreeModel {
}
}

const tocHiddenDuringSearch = this.configurationService.getValue('workbench.settings.settingsSearchTocBehavior') === 'hide';
if (!tocHiddenDuringSearch) {
// Sort the settings according to internal order if indexed.
if (this.settingsOrderByTocIndex) {
filterMatches.sort((a, b) => compareTwoNullableNumbers(a.setting.internalOrder, b.setting.internalOrder));
}
return filterMatches;
// The search only has filters, so we can sort by the order in the TOC.
if (!this._viewState.query) {
return filterMatches.sort((a, b) => compareTwoNullableNumbers(a.setting.internalOrder, b.setting.internalOrder));
}

// The table of contents is hidden during the search.
// The settings could appear in a more haphazard order.
// Sort the settings according to their score.
// Sort the settings according to their relevancy.
// https://github.com/microsoft/vscode/issues/197773
filterMatches.sort((a, b) => {
if (a.matchType !== b.matchType) {
// Sort by match type if the match types are not the same.
Expand Down
4 changes: 2 additions & 2 deletions src/vs/workbench/contrib/preferences/common/preferencesContribution.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,8 @@ registry.registerConfiguration({
'type': 'string',
'enum': ['hide', 'filter'],
'enumDescriptions': [
nls.localize('settingsSearchTocBehavior.hide', "Hide the Table of Contents while searching. The search results will not be grouped by category, and instead will be sorted by similarity to the query, with exact keyword matches coming first."),
nls.localize('settingsSearchTocBehavior.filter', "Filter the Table of Contents to just categories that have matching settings. Clicking a category will filter the results to that category. The search results will be grouped by category."),
nls.localize('settingsSearchTocBehavior.hide', "Hide the Table of Contents while searching."),
nls.localize('settingsSearchTocBehavior.filter', "Filter the Table of Contents to just categories that have matching settings. Clicking on a category will filter the results to that category."),
],
'description': nls.localize('settingsSearchTocBehavior', "Controls the behavior of the Settings editor Table of Contents while searching. If this setting is being changed in the Settings editor, the setting will take effect after the search query is modified."),
'default': 'filter',
Expand Down