Refactor Find Symbol to match the new tests sidebar

Author: belcar-s

src/client_disposable.ts

@@ -10,8 +10,7 @@ import {
 import registerFormatDocument from "./commands/format_document.ts";
 import registerCache from "./commands/cache.ts";
 import registerRenameSymbol from "./commands/rename_symbol.ts";
-import registerPaletteFindSymbol from "./commands/palette_find_symbol.ts";
-import registerSymbolSidebarFindSymbol from "./commands/sidebar_find_symbol.ts";
+import registerFindSymbol from "./find_symbol/register.ts";
 import syntaxes from "./syntaxes.ts";
 
 const FORMAT_ON_SAVE_CONFIG_KEY = "co.gwil.deno.config.formatOnSave";
@@ -140,11 +139,7 @@ export async function makeClientDisposable(
     clientDisposable.add(registerFormatDocument(client));
     clientDisposable.add(registerCache(client));
     clientDisposable.add(registerRenameSymbol(client));
-
-    // palette Find Symbol command
-    clientDisposable.add(registerPaletteFindSymbol());
-    // sidebar Find Symbol command
-    clientDisposable.add(registerSymbolSidebarFindSymbol(client));
+    clientDisposable.add(registerFindSymbol(client));
 
     nova.workspace.onDidAddTextEditor((editor) => {
       const editorDisposable = new CompositeDisposable();

src/commands/palette_find_symbol.ts

@@ -0,0 +1,81 @@
+import {
+  LanguageClient,
+  NotificationRequest,
+  nova,
+  wrapCommand,
+} from "../nova_utils.ts";
+import SymbolDataProvider from "../find_symbol/SymbolDataProvider.ts";
+import { lsp } from "../../deps.ts";
+
+export function registerPaletteFindSymbol() {
+  return nova.commands.register(
+    "co.gwil.deno.commands.find",
+    wrapCommand(maybeFindSymbol),
+  );
+
+  async function maybeFindSymbol() {
+    try {
+      await nova.commands.invoke("co.gwil.deno.sidebars.symbols.commands.find");
+    } catch (err) {
+      // I don't think this ever happens.
+      console.error(err);
+    }
+
+    const sidebarReminderNotificationRequest = new NotificationRequest(
+      "co.gwil.deno.notifications.checkTheSidebar",
+    );
+    sidebarReminderNotificationRequest.title =
+      "Symbols are shown in the Deno Symbols sidebar.";
+    sidebarReminderNotificationRequest.body =
+      "To see your search's results, check the Deno Symbols sidebar.";
+    nova.notifications.add(sidebarReminderNotificationRequest);
+  }
+}
+
+export function registerSidebarFindSymbol(
+  client: LanguageClient,
+  symbolDataProvider: SymbolDataProvider,
+) {
+  return nova.commands.register(
+    "co.gwil.deno.sidebars.symbols.commands.find",
+    wrapCommand(findSymbol),
+  );
+
+  async function findSymbol() {
+    if (
+      // @ts-expect-error: The Nova types are outdated.
+      !(nova.workspace.context as Configuration).get("shouldDisplayFeatures")
+    ) {
+      const failureNotificationReq = new NotificationRequest(
+        "co.gwil.deno.notifications.findSymbolUnavailable",
+      );
+      failureNotificationReq.title = "Find Symbol is unavailable.";
+      failureNotificationReq.body =
+        "Open a TypeScript, JavaScript, JSX or TSX file.";
+      nova.notifications.add(failureNotificationReq);
+      return;
+    }
+
+    const query = await new Promise((resolve) =>
+      nova.workspace.showInputPalette(
+        "Type the name of a variable, class or function.",
+        {},
+        resolve,
+      )
+    ) as string | null | undefined;
+
+    // This happens if the user exits the palette, for example, by pressing Escape.
+    if (!query) return;
+
+    symbolDataProvider.displaySymbols(query, getSymbols);
+
+    async function getSymbols(query: string) {
+      const params = { query };
+      const response = await client.sendRequest(
+        "workspace/symbol",
+        params,
+      ) as lsp.SymbolInformation[] | null;
+      return response;
+    }
+  }
+}

src/commands/symbols.sidebar.ts

@@ -204,8 +204,8 @@ class Symbol implements Element {
     editor.scrollToPosition(range.start);
   }
 }
-class SymbolDataProvider implements TreeDataProvider<Element> {
-  private treeView: TreeView<Element>;
+export default class SymbolDataProvider implements TreeDataProvider<Element> {
+  treeView: TreeView<Element>;
 
   // The locations need to be stored separately to enable the sidebar to reload infrequently.
   private locations: Map<number, lsp.Location>;
@@ -383,52 +383,3 @@ class SymbolDataProvider implements TreeDataProvider<Element> {
     return element.toTreeItem();
   }
 }
-
-export default function registerFindSymbol(client: LanguageClient) {
-  return nova.commands.register(
-    "co.gwil.deno.sidebars.symbols.commands.find",
-    wrapCommand(findSymbol),
-  );
-
-  async function findSymbol() {
-    if (!symbolDataProvider) {
-      symbolDataProvider = new SymbolDataProvider();
-    }
-
-    if (
-      // @ts-expect-error: The Nova types are outdated.
-      !(nova.workspace.context as Configuration).get("shouldDisplayFeatures")
-    ) {
-      const failureNotificationReq = new NotificationRequest(
-        "co.gwil.deno.notifications.findSymbolUnavailable",
-      );
-      failureNotificationReq.title = "Find Symbol is unavailable.";
-      failureNotificationReq.body =
-        "Open a TypeScript, JavaScript, JSX or TSX file.";
-      nova.notifications.add(failureNotificationReq);
-      return;
-    }
-
-    const query = await new Promise((resolve) =>
-      nova.workspace.showInputPalette(
-        "Type the name of a variable, class or function.",
-        {},
-        resolve,
-      )
-    ) as string | null | undefined;
-
-    // This happens if the user exits the palette, for example, by pressing Escape.
-    if (!query) return;
-
-    symbolDataProvider.displaySymbols(query, getSymbols);
-
-    async function getSymbols(query: string) {
-      const params = { query };
-      const response = await client.sendRequest(
-        "workspace/symbol",
-        params,
-      ) as lsp.SymbolInformation[] | null;
-      return response;
-    }
-  }
-}

src/commands/sidebar_find_symbol.ts renamed to src/find_symbol/SymbolDataProvider.ts

@@ -0,0 +1,18 @@
+import { CompositeDisposable, LanguageClient } from "../nova_utils.ts";
+import {
+  registerPaletteFindSymbol,
+  registerSidebarFindSymbol,
+} from "../commands/symbols.sidebar.ts";
+import SymbolDataProvider from "./SymbolDataProvider.ts";
+
+export default function registerSymbolsSidebar(client: LanguageClient) {
+  const symbolsDisposable = new CompositeDisposable();
+
+  const dataProvider = new SymbolDataProvider();
+  symbolsDisposable.add(dataProvider.treeView);
+
+  symbolsDisposable.add(registerSidebarFindSymbol(client, dataProvider));
+  symbolsDisposable.add(registerPaletteFindSymbol());
+
+  return symbolsDisposable;
+}