From c63a93e866de3bdebd5d0001ce3225dfe9d12a29 Mon Sep 17 00:00:00 2001
From: Zef Hemel <zef@zef.me>
Date: Tue, 2 Jan 2024 13:47:43 +0100
Subject: [PATCH] Priority support for commands and overrides

---
 plugs/index/index.plug.yaml        |  2 ++
 plugs/template/template.plug.yaml  |  1 +
 web/components/command_palette.tsx | 13 ++++++++-----
 web/hooks/command.ts               |  3 +++
 web/types.ts                       |  1 +
 website/CHANGELOG.md               |  3 ++-
 website/Command Palette.md         |  7 +++++--
 website/Commands.md                |  3 +++
 8 files changed, 25 insertions(+), 8 deletions(-)
 create mode 100644 website/Commands.md

diff --git a/plugs/index/index.plug.yaml b/plugs/index/index.plug.yaml
index a18d910..056fc95 100644
--- a/plugs/index/index.plug.yaml
+++ b/plugs/index/index.plug.yaml
@@ -161,6 +161,7 @@ functions:
     command:
       name: "Mentions: Toggle"
       key: ctrl-alt-m
+      priority: 5
 
   renderMentions:
     path: "./linked_mentions.ts:renderMentions"
@@ -172,6 +173,7 @@ functions:
     command:
       name: "Table of Contents: Toggle"
       key: ctrl-alt-t
+      priority: 5
 
   renderTOC:
     path: toc.ts:renderTOC
diff --git a/plugs/template/template.plug.yaml b/plugs/template/template.plug.yaml
index aa71553..29ba000 100644
--- a/plugs/template/template.plug.yaml
+++ b/plugs/template/template.plug.yaml
@@ -102,6 +102,7 @@ functions:
     command:
       name: "Quick Note"
       key: "Alt-Shift-n"
+      priority: 3
 
   dailyNoteCommand:
     path: ./template.ts:dailyNoteCommand
diff --git a/web/components/command_palette.tsx b/web/components/command_palette.tsx
index ef3f811..e7d45e7 100644
--- a/web/components/command_palette.tsx
+++ b/web/components/command_palette.tsx
@@ -25,10 +25,11 @@ export function CommandPalette({
   const options: FilterOption[] = [];
   const isMac = isMacLike();
   for (const [name, def] of commands.entries()) {
-    let shortcut: { key?: string; mac?: string } = def.command;
+    let shortcut: { key?: string; mac?: string; priority?: number } =
+      def.command;
     // Let's see if there's a shortcut override
     if (settings.shortcuts) {
-      const commandKeyboardOverride = settings.shortcuts.find((
+      const commandOverride = settings.shortcuts.find((
         shortcut,
       ) => {
         const commandMatch = commandLinkRegex.exec(shortcut.command);
@@ -37,8 +38,9 @@ export function CommandPalette({
           // or if it's not a command link, let's match exactly
           shortcut.command === name;
       });
-      if (commandKeyboardOverride) {
-        shortcut = commandKeyboardOverride;
+      if (commandOverride) {
+        shortcut = commandOverride;
+        console.log(`Shortcut override for ${name}:`, shortcut);
       }
     }
     options.push({
@@ -46,8 +48,9 @@ export function CommandPalette({
       hint: isMac && shortcut.mac ? shortcut.mac : shortcut.key,
       orderId: recentCommands.has(name)
         ? -recentCommands.get(name)!.getTime()
-        : 0,
+        : shortcut.priority || Infinity,
     });
+    // console.log("Options", options);
   }
   return (
     <FilterList
diff --git a/web/hooks/command.ts b/web/hooks/command.ts
index 0014d10..69bd33a 100644
--- a/web/hooks/command.ts
+++ b/web/hooks/command.ts
@@ -7,6 +7,9 @@ export type CommandDef = {
 
   contexts?: string[];
 
+  // Default 0, higher is higher priority = higher in the list
+  priority?: number;
+
   // Bind to keyboard shortcut
   key?: string;
   mac?: string;
diff --git a/web/types.ts b/web/types.ts
index 989e8e5..7c5b1b0 100644
--- a/web/types.ts
+++ b/web/types.ts
@@ -22,6 +22,7 @@ export type PanelMode = number;
 export type Shortcut = {
   key?: string;
   mac?: string;
+  priority?: number;
   command: string;
 };
 
diff --git a/website/CHANGELOG.md b/website/CHANGELOG.md
index ffdc5f2..86efd02 100644
--- a/website/CHANGELOG.md
+++ b/website/CHANGELOG.md
@@ -4,7 +4,8 @@ release.
 ---
 
 ## Next
-* Keyboard shortcuts can now be configured in [[SETTINGS]]
+* Keyboard shortcuts as well as priority (order in which they appear in the [[Command Palette]]) can now be configured for [[Commands]] in [[SETTINGS]]. The `priority` enables you to put frequently used commands at the top.
+* The rendering of [[Live Templates]], [[Live Queries]], [[Table of Contents]] and [[Linked Mentions]] has been re-implemented. Rendering should now be near-instant and the “flappy” behavior should be largely gone, especially after an initial load (results are cached). There may still be some visual regressions. Please report them if you find them.
 
 ---
 
diff --git a/website/Command Palette.md b/website/Command Palette.md
index e2fcd1c..802d53f 100644
--- a/website/Command Palette.md	
+++ b/website/Command Palette.md	
@@ -1,5 +1,8 @@
-The Command Palette is used to explore SilverBullet’s numerous commands as well as execute them.
+The Command Palette is used to explore SilverBullet’s numerous [[Commands]] as well as execute them.
 
 The UI and its operation is largely the same as the [[Page Picker]]‘s, with a few differences:
 
-* If a keyboard shortcut is configured for the given command, it is listed along the command name to the right.
\ No newline at end of file
+* If a keyboard shortcut is configured for the given command, it is listed along the command name to the right.
+* The ordering is decided based on two factors:
+  * The last time the command was invoked via the [[Command Palette]] in this client session.
+  * The `priority` configured for the command (in the plug, or via [[SETTINGS]] under `shortcuts`). 
\ No newline at end of file
diff --git a/website/Commands.md b/website/Commands.md
new file mode 100644
index 0000000..f03700a
--- /dev/null
+++ b/website/Commands.md
@@ -0,0 +1,3 @@
+Commands define actions that SilverBullet can perform. They range from simple edit commands, such as {[Text: Bold]}, but may be more elaborate such as {[Page: Rename]}. At a technical level, all commands are implemented via [[Plugs]].
+
+All available commands appear in the [[Command Palette]] but may have key bindings as well (these key bindings appear in the [[Command Palette]] and are configurable in [[SETTINGS]]).
\ No newline at end of file