feat(List/Matrix View): ✨ Option to sort by note name, but show it's …

…alias. Default is to sort by alias if one is found (fix #255)

src/BreadcrumbsSettingTab.ts

@@ -342,6 +342,21 @@ export class BCSettingTab extends PluginSettingTab {
         })
       );
 
+    new Setting(MLViewDetails)
+      .setName("Sort by note name, but show alias")
+      .setDesc(
+        "When this is turned off, notes will first be sorted by their alias, and then by their name if no alias is found. Turn this on to sort by note name always, but still show the alias in the results."
+      )
+      .addToggle((toggle) =>
+        toggle
+          .setValue(settings.sortByNameShowAlias)
+          .onChange(async (value) => {
+            settings.sortByNameShowAlias = value;
+            await plugin.saveSettings();
+            await plugin.getActiveTYPEView(MATRIX_VIEW).draw();
+          })
+      );
+
     new Setting(MLViewDetails)
       .setName("Make Current Note an Implied Sibling")
       .setDesc(

src/MatrixView.ts

@@ -115,6 +115,7 @@ export default class MatrixView extends ItemView {
       enableAlphaSort,
       treatCurrNodeAsImpliedSibling,
       squareDirectionsOrder,
+      sortByNameShowAlias,
     } = settings;
     if (!mainG) return [];
 
@@ -208,7 +209,8 @@ export default class MatrixView extends ItemView {
       if (enableAlphaSort) {
         squares.forEach((sq) =>
           sq.sort((a, b) =>
-            (a.alt ?? a.to) < (b.alt ?? b.to)
+            (sortByNameShowAlias ? a.to : a.alt ?? a.to) <
+            (sortByNameShowAlias ? b.to : b.alt ?? b.to)
               ? alphaSortAsc
                 ? -1
                 : 1

src/constants.ts

@@ -230,6 +230,7 @@ export const DEFAULT_SETTINGS: BCSettings = {
   showTrail: true,
   showGrid: true,
   showPrevNext: true,
+  sortByNameShowAlias: false,
   squareDirectionsOrder: [0, 1, 2, 3, 4],
   limitTrailCheckboxes: [],
   limitJumpToFirstFields: [],

src/interfaces.ts

@@ -58,6 +58,7 @@ export interface BCSettings {
   showNameOrType: boolean;
   showRelationType: boolean;
   showWriteAllBCsCmd: boolean;
+  sortByNameShowAlias: boolean;
   regexNoteField: string;
   rlLeaf: boolean;
   showBCs: boolean;