feat: add separate setting for overriding standard mode rendering #176

Change overriding standard mode behavior setting into two separate settings. Introduce a new setting to control the rendering behavior, and repurpose the old, existing setting to control only the open (tab navigation) behavior.

README.md

@@ -219,7 +219,8 @@ In the demo below, `Quick Switcher++: Open Symbols for the active editor` global
 | Hide path for root items | **Enabled**: path information will be hidden for items at the root of the vault. | enabled |
 | Mode trigger escape character | A character that can be used as a prefix to force a mode trigger character to be treated just as normal text. | `!` |
 | Default to open in new pane | **Enabled**: navigating to un-opened files will open a new editor pane whenever possible (as if cmd/ctrl were held). When the file is already open, the existing pane will be activated. This overrides all other pane settings. | enabled |
-| Override Standard mode behavior | **Enabled**: Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to inject custom behavior. Custom behavior includes features like enhance rendering of suggestion items to display additional information, special path display handling, and tab navigation features.<br />**Disabled**: No changes are made to the default Obsidian builtin functionality (Standard Mode). | enabled |
+| Override Standard mode file open behavior | **Enabled**: Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to inject custom file open (tab navigation) behavior.<br />**Disabled**: No changes are made to the default Obsidian builtin functionality (Standard Mode). | enabled |
+| Override Standard mode rendering | **Enabled**: Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to render suggestions as multi-line. Including display of additional indicator information, and special path display handling.<br />**Disabled**: No changes are made to the default Obsidian builtin functionality (Standard Mode). | enabled |
 | Show indicator icons | **Enabled**: Display icons to indicate that an item is recent, bookmarks, etc... | enabled |
 | Result priority adjustments | **Enabled**: Artificially increase the match score of the specified item types by a fixed percentage so they appear higher in the results list (does not apply to Standard Mode). See the default list of [priority types](src/settings/switcherPlusSettings.ts#72) that can be prioritized. Note that the adjustments are independent of each other, e.g. if adjustments are specified for both `Bookmarked items` and `Open items` a result for a file that is open and bookmarked will receive both adjustments.<br />**Disabled** result match scores are not adjusted. | disabled |
 | Use filename as alias | **Enabled**: The file basename will be set as the link alias.<br />**Disabled**: An alias will not be set | enabled |

src/settings/__tests__/generalSettingsTabSection.test.ts

@@ -71,13 +71,25 @@ describe('generalSettingsTabSection', () => {
 
       expect(addToggleSettingSpy).toHaveBeenCalledWith(
         mockContainerEl,
-        'Override Standard mode behavior',
+        'Override Standard mode file open behavior',
         expect.any(String),
         config.overrideStandardModeBehaviors,
         'overrideStandardModeBehaviors',
       );
     });
 
+    it('should show the overrideStandardModeRendering setting', () => {
+      sut.display(mockContainerEl);
+
+      expect(addToggleSettingSpy).toHaveBeenCalledWith(
+        mockContainerEl,
+        'Override Standard mode rendering',
+        expect.any(String),
+        config.overrideStandardModeRendering,
+        'overrideStandardModeRendering',
+      );
+    });
+
     it('should show the hidePathIfRoot setting', () => {
       sut.display(mockContainerEl);
 

src/settings/__tests__/switcherPlusSettings.test.ts

@@ -69,6 +69,7 @@ function getDefaultSettingsData(): SettingsData {
     enabledRelatedItems: Object.values(RelationType),
     showOptionalIndicatorIcons: true,
     overrideStandardModeBehaviors: true,
+    overrideStandardModeRendering: true,
     enabledRibbonCommands: [
       Mode[Mode.HeadingsList] as keyof typeof Mode,
       Mode[Mode.SymbolList] as keyof typeof Mode,
@@ -219,6 +220,7 @@ function getTransientSettingsData(): SettingsData {
     enabledRelatedItems: chance.pickset(Object.values(RelationType), 2),
     showOptionalIndicatorIcons: chance.bool(),
     overrideStandardModeBehaviors: chance.bool(),
+    overrideStandardModeRendering: chance.bool(),
     enabledRibbonCommands,
     fileExtAllowList: [],
     matchPriorityAdjustments: {

src/settings/generalSettingsTabSection.ts

@@ -40,12 +40,20 @@ export class GeneralSettingsTabSection extends SettingsTabSection {
 
     this.addToggleSetting(
       containerEl,
-      'Override Standard mode behavior',
-      'When enabled, Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to inject custom behavior.',
+      'Override Standard mode file open behavior',
+      'When enabled, Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to inject custom file open behavior.',
       config.overrideStandardModeBehaviors,
       'overrideStandardModeBehaviors',
     );
 
+    this.addToggleSetting(
+      containerEl,
+      'Override Standard mode rendering',
+      'When enabled, Switcher++ will change the default Obsidian builtin Switcher functionality (Standard mode) to render suggestions as multi-line.',
+      config.overrideStandardModeRendering,
+      'overrideStandardModeRendering',
+    );
+
     this.addToggleSetting(
       containerEl,
       'Show indicator icons',

src/settings/switcherPlusSettings.ts

@@ -70,6 +70,7 @@ export class SwitcherPlusSettings {
       enabledRelatedItems: Object.values(RelationType),
       showOptionalIndicatorIcons: true,
       overrideStandardModeBehaviors: true,
+      overrideStandardModeRendering: true,
       enabledRibbonCommands: [
         Mode[Mode.HeadingsList] as keyof typeof Mode,
         Mode[Mode.SymbolList] as keyof typeof Mode,
@@ -520,6 +521,14 @@ export class SwitcherPlusSettings {
     this.data.overrideStandardModeBehaviors = value;
   }
 
+  get overrideStandardModeRendering(): boolean {
+    return this.data.overrideStandardModeRendering;
+  }
+
+  set overrideStandardModeRendering(value: boolean) {
+    this.data.overrideStandardModeRendering = value;
+  }
+
   get enabledRibbonCommands(): Array<keyof typeof Mode> {
     return this.data.enabledRibbonCommands;
   }

src/switcherPlus/__tests__/modeHandler.test.ts

@@ -881,6 +881,23 @@ describe('modeHandler', () => {
       },
     );
 
+    test('with overrideStandardModeRendering enabled, renderSuggestion() should use the StandardExHandler', () => {
+      mockSettings.overrideStandardModeRendering = true;
+      const sugg = makeFileSuggestion();
+
+      const renderSuggestionSpy = jest
+        .spyOn(StandardExHandler.prototype, 'renderSuggestion')
+        .mockImplementation();
+
+      sut.renderSuggestion(sugg, null);
+
+      expect(renderSuggestionSpy).toHaveBeenCalledWith(sugg, null);
+
+      renderSuggestionSpy.mockRestore();
+
+      mockSettings.overrideStandardModeRendering = false;
+    });
+
     test('with overrideStandardModeBehaviors enabled, onChooseSuggestion should use the StandardExHandler', () => {
       mockSettings.overrideStandardModeBehaviors = true;
       const sugg = makeFileSuggestion();
@@ -1328,20 +1345,23 @@ describe('modeHandler', () => {
       sut = new ModeHandler(mockApp, mockSettings, mock<SwitcherPlusKeymap>());
     });
 
-    test('with overrideStandardModeBehaviors enabled, it should add properties to a Standard mode file suggestion', () => {
-      mockSettings.overrideStandardModeBehaviors = true;
-      const sugg = makeFileSuggestion();
-      const addPropsSpy = jest
-        .spyOn(StandardExHandler.prototype, 'addPropertiesToStandardSuggestions')
-        .mockImplementation();
+    test.each([makeFileSuggestion(), makeAliasSuggestion()])(
+      'with overrideStandardModeRendering enabled, it should add properties to a supported Standard mode suggestion',
+      (sugg) => {
+        mockSettings.overrideStandardModeBehaviors = false;
+        mockSettings.overrideStandardModeRendering = true;
+        const addPropsSpy = jest
+          .spyOn(StandardExHandler.prototype, 'addPropertiesToStandardSuggestions')
+          .mockImplementation();
 
-      sut.addPropertiesToStandardSuggestions([sugg], mockSettings);
+        sut.addPropertiesToStandardSuggestions([sugg], mockSettings);
 
-      expect(addPropsSpy).toHaveBeenCalled();
+        expect(addPropsSpy).toHaveBeenCalled();
 
-      addPropsSpy.mockRestore();
-      mockSettings.overrideStandardModeBehaviors = false;
-    });
+        addPropsSpy.mockRestore();
+        mockSettings.overrideStandardModeRendering = false;
+      },
+    );
 
     test('with overrideStandardModeBehaviors enabled, it should add properties to a Standard mode bookmark suggestion', () => {
       mockSettings.overrideStandardModeBehaviors = true;

src/switcherPlus/modeHandler.ts

@@ -298,7 +298,7 @@ export class ModeHandler {
   renderSuggestion(sugg: AnySuggestion, parentEl: HTMLElement): boolean {
     const {
       inputInfo,
-      settings: { overrideStandardModeBehaviors },
+      settings: { overrideStandardModeRendering },
     } = this;
     const { mode } = inputInfo;
     const isHeadingMode = mode === Mode.HeadingsList;
@@ -315,7 +315,7 @@ export class ModeHandler {
         handled = true;
       }
     } else if (!systemBehaviorPreferred.has(sugg.type)) {
-      if (overrideStandardModeBehaviors || isHeadingMode || isExSuggestion(sugg)) {
+      if (overrideStandardModeRendering || isHeadingMode || isExSuggestion(sugg)) {
         // when overriding standard mode, or, in Headings mode, StandardExHandler should
         // handle rendering for FileSuggestion and Alias suggestion
         const handler = this.getHandler(sugg);
@@ -708,7 +708,10 @@ export class ModeHandler {
     suggestions: AnySuggestion[],
     config: SwitcherPlusSettings,
   ): void {
-    if (!suggestions || !config.overrideStandardModeBehaviors) {
+    if (
+      !suggestions ||
+      !(config.overrideStandardModeBehaviors || config.overrideStandardModeRendering)
+    ) {
       return;
     }
 

src/types/sharedTypes.ts

@@ -439,6 +439,7 @@ export interface SettingsData {
   enabledRelatedItems: RelationType[];
   showOptionalIndicatorIcons: boolean;
   overrideStandardModeBehaviors: boolean;
+  overrideStandardModeRendering: boolean;
   enabledRibbonCommands: Array<keyof typeof Mode>;
   fileExtAllowList: Array<string>;
   matchPriorityAdjustments: {