Populate the sidebar

Author: belcar-s

src/commands/tests_sidebar.ts

@@ -0,0 +1,54 @@
+import { nova, Process, wrapCommand } from "../nova_utils.ts";
+import TestsDataProvider, { PathFile } from "../tests/TestsDataProvider.ts";
+
+export function registerLearnMore() {
+  return nova.commands.register(
+    "co.gwil.deno.sidebars.tests.commands.learn",
+    wrapCommand(learnMore),
+  );
+
+  function learnMore() {
+    const options = {
+      args: ["https://deno.land/manual/testing#running-tests"],
+    };
+    const process = new Process("/usr/bin/open", options);
+    process.start();
+  }
+}
+
+export function registerRefresh(testsDataProvider: TestsDataProvider) {
+  return nova.commands.register(
+    "co.gwil.deno.sidebars.tests.commands.refresh",
+    wrapCommand(refresh),
+  );
+
+  function refresh() {
+    testsDataProvider.refresh();
+  }
+}
+
+export function registerRunAll(testsDataProvider: TestsDataProvider) {
+  return nova.commands.register(
+    "co.gwil.deno.sidebars.tests.commands.runAll",
+    wrapCommand(runAll),
+  );
+
+  function runAll() {
+    testsDataProvider.runTests();
+  }
+}
+
+export function registerRun(testsDataProvider: TestsDataProvider) {
+  return nova.commands.register(
+    "co.gwil.deno.sidebars.tests.commands.run",
+    wrapCommand(run),
+  );
+
+  function run() {
+    testsDataProvider.runTests(
+      testsDataProvider.treeView.selection.filter((item) =>
+        item instanceof PathFile
+      ) as PathFile[],
+    );
+  }
+}

src/nova_deno.ts

@@ -15,6 +15,7 @@ import {
   CanNotEnsureError,
   makeClientDisposable,
 } from "./client_disposable.ts";
+import { registerTestsSidebar } from "./tests/register.ts";
 
 const compositeDisposable = new CompositeDisposable();
 const taskDisposable = new CompositeDisposable();
@@ -53,6 +54,8 @@ export async function activate() {
 
   compositeDisposable.add(registerEditorWatcher());
 
+  compositeDisposable.add(registerTestsSidebar());
+
   const configFileWatchingDisposables = watchConfigFiles(
     nova.workspace.path,
     configFilenames,

src/tests/TestsDataProvider.ts

@@ -0,0 +1,136 @@
+import {
+  nova,
+  Process,
+  TreeDataProvider,
+  TreeItem,
+  TreeItemCollapsibleState,
+  TreeView,
+} from "../nova_utils.ts";
+
+// This is duplicate code.
+interface Element {
+  toTreeItem: () => TreeItem;
+  children: Element[];
+}
+// This is also duplicate code.
+class Header implements Element {
+  content: string;
+  children: [];
+  constructor(content: string) {
+    this.content = content;
+    this.children = [];
+  }
+
+  toTreeItem() {
+    const item = new TreeItem(this.content);
+    return item;
+  }
+}
+export class PathFile implements Element {
+  path: string;
+  children: [];
+  shouldDisambiguate: boolean;
+
+  constructor(path: string, children: [], shouldDisambiguate: boolean) {
+    this.path = path;
+    this.children = children;
+    this.shouldDisambiguate = shouldDisambiguate;
+  }
+
+  get filename(): string {
+    return nova.path.basename(this.path);
+  }
+
+  get extension(): string {
+    return nova.path.extname(this.path);
+  }
+
+  toTreeItem() {
+    const relativePath: string = nova.workspace.relativizePath(this.path);
+    const item = new TreeItem(
+      this.shouldDisambiguate ? relativePath : this.filename,
+    );
+
+    item.image = "__filetype" + this.extension;
+    item.collapsibleState = TreeItemCollapsibleState.Expanded;
+    item.contextValue = "file";
+    return item;
+  }
+}
+
+export default class TestsDataProvider implements TreeDataProvider<Element> {
+  // See https://deno.land/manual/testing#running-tests.
+  static FILE_REGEXP = /^.*[_.]?test\.(ts|tsx|mts|js|mjs|jsx|cjs|cts)$/;
+  treeView: TreeView<Element>;
+  files: Element[];
+
+  constructor() {
+    this.treeView = new TreeView("co.gwil.deno.sidebars.tests.sections.1", {
+      dataProvider: this,
+    });
+    this.files = [];
+  }
+
+  static findTests(directoryPath: string): string[] {
+    function isAccessibleDirectory(path: string) {
+      try {
+        nova.fs.listdir(path);
+      } catch {
+        return false;
+      }
+      return true;
+    }
+
+    const tests: string[] = [];
+    for (const name of nova.fs.listdir(directoryPath)) {
+      const path = nova.path.join(directoryPath, name);
+      if (isAccessibleDirectory(path)) {
+        let internalTests = null;
+        try {
+          internalTests = TestsDataProvider.findTests(path);
+        } catch {
+          continue;
+        }
+        tests.push(...internalTests);
+      } else if (name.match(TestsDataProvider.FILE_REGEXP)) {
+        tests.push(path);
+      }
+    }
+    return tests;
+  }
+
+  runTests(files?: PathFile[]) {
+    files ??= [];
+    const paths = files.map((file) => file.path);
+
+    const options = {
+      args: ["deno", ...paths],
+    };
+    const denoProcess = new Process("/usr/bin/env", options);
+    denoProcess.onStdout(console.log);
+    denoProcess.onStderr(console.log);
+
+    denoProcess.start();
+  }
+
+  getChildren(element: Element | null): Element[] {
+    if (element == null) {
+      if (nova.workspace.path) {
+        return TestsDataProvider.findTests(nova.workspace.path).map((path) =>
+          new PathFile(path, [], false)
+        );
+      } else {
+        return [new Header("Open a Deno project to see test files.")];
+      }
+    }
+    return element.children;
+  }
+
+  getTreeItem(element: Element): TreeItem {
+    return element.toTreeItem();
+  }
+
+  refresh() {
+    return this.treeView.reload();
+  }
+}

src/tests/register.ts

@@ -0,0 +1,21 @@
+import { CompositeDisposable } from "../nova_utils.ts";
+import {
+  registerLearnMore,
+  registerRefresh,
+} from "../commands/tests_sidebar.ts";
+import TestsDataProvider from "./TestsDataProvider.ts";
+
+let testsDataProvider: TestsDataProvider | null = null;
+
+export function registerTestsSidebar() {
+  const testsDisposable = new CompositeDisposable();
+
+  const dataProvider = new TestsDataProvider();
+  testsDataProvider = dataProvider;
+  testsDisposable.add(dataProvider.treeView);
+
+  testsDisposable.add(registerLearnMore());
+  testsDisposable.add(registerRefresh(testsDataProvider));
+
+  return testsDisposable;
+}