@obsfx/trekker-dashboard 1.7.0 → 1.9.0

package/README.md

@@ -8,7 +8,7 @@ A kanban board dashboard for [Trekker](https://github.com/obsfx/trekker) issue t
 bun install -g @obsfx/trekker-dashboard
 ```
 
-Or with npm:
+Or with npm (still requires Bun runtime to run):
 
 ```bash
 npm install -g @obsfx/trekker-dashboard
@@ -32,8 +32,26 @@ trekker-dashboard --help     # Show help
 
 ## Requirements
 
+- **Bun runtime** (required) - The dashboard uses Bun's native SQLite driver
 - A project initialized with Trekker (`trekker init`)
-- Bun runtime (for best performance) or Node.js 18+
+
+### Installing Bun
+
+```bash
+# macOS/Linux
+curl -fsSL https://bun.sh/install | bash
+
+# Homebrew
+brew install oven-sh/bun/bun
+
+# Windows (scoop)
+scoop install bun
+
+# npm (any platform)
+npm install -g bun
+```
+
+See [bun.sh/docs/installation](https://bun.sh/docs/installation) for more options.
 
 ## Features
 

package/bin/trekker-dashboard.js

@@ -1,57 +1,98 @@
-#!/usr/bin/env bun
+#!/usr/bin/env node
 import { Command } from "commander";
 import { resolve, dirname } from "path";
 import { existsSync, readFileSync } from "fs";
 import { fileURLToPath } from "url";
+import { execSync, spawn } from "child_process";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-const pkg = JSON.parse(readFileSync(resolve(__dirname, "..", "package.json"), "utf-8"));
-
-const program = new Command();
-
-program
-  .name("trekker-dashboard")
-  .description("Kanban board dashboard for Trekker issue tracker")
-  .version(pkg.version)
-  .option("-p, --port <port>", "Port to run on", "3000")
-  .action(async (options) => {
-    const cwd = process.cwd();
-    const trekkerDir = resolve(cwd, ".trekker");
-    const dbPath = resolve(trekkerDir, "trekker.db");
-
-    // Check if .trekker directory exists
-    if (!existsSync(trekkerDir)) {
-      console.error("Error: No .trekker directory found in current directory.");
-      console.error("Run 'trekker init' first to initialize the issue tracker.");
-      process.exit(1);
-    }
-
-    // Check if database exists
-    if (!existsSync(dbPath)) {
-      console.error("Error: No trekker.db found in .trekker directory.");
-      console.error("Run 'trekker init' first to initialize the issue tracker.");
-      process.exit(1);
-    }
-
-    // Set environment variables
-    process.env.TREKKER_DB_PATH = dbPath;
-    process.env.PORT = options.port;
-
-    console.log(`Starting Trekker Dashboard on http://localhost:${options.port}`);
-    console.log(`Using database: ${dbPath}`);
-    console.log("Press Ctrl+C to stop\n");
-
-    // Import and start the server
-    const serverPath = resolve(__dirname, "..", "dist", "server", "index.js");
-    if (!existsSync(serverPath)) {
-      console.error("Error: Server bundle not found at", serverPath);
-      console.error("The package may not have been built correctly.");
-      process.exit(1);
-    }
-
-    await import(serverPath);
+// Check if bun is installed
+function checkBunInstalled() {
+  try {
+    execSync("bun --version", { stdio: "ignore" });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// Show installation instructions and exit
+function showBunInstallGuide() {
+  console.error("Error: Bun runtime is required but not installed.\n");
+  console.error("Trekker Dashboard requires Bun for its SQLite driver.\n");
+  console.error("Install Bun:");
+  console.error("  curl -fsSL https://bun.sh/install | bash\n");
+  console.error("Or via package managers:");
+  console.error("  brew install oven-sh/bun/bun      # macOS/Linux");
+  console.error("  scoop install bun                 # Windows");
+  console.error("  npm install -g bun                # npm\n");
+  console.error("Learn more: https://bun.sh/docs/installation");
+  process.exit(1);
+}
+
+// If not running under bun, check and re-execute with bun
+if (typeof Bun === "undefined") {
+  if (!checkBunInstalled()) {
+    showBunInstallGuide();
+  }
+  // Re-execute this script with bun
+  const child = spawn("bun", [__filename, ...process.argv.slice(2)], {
+    stdio: "inherit",
+  });
+  child.on("close", (code) => process.exit(code ?? 0));
+  child.on("error", () => {
+    showBunInstallGuide();
   });
+} else {
+  // Running under bun, proceed with the CLI
+  const pkg = JSON.parse(readFileSync(resolve(__dirname, "..", "package.json"), "utf-8"));
+
+  const program = new Command();
+
+  program
+    .name("trekker-dashboard")
+    .description("Kanban board dashboard for Trekker issue tracker")
+    .version(pkg.version)
+    .option("-p, --port <port>", "Port to run on", "3000")
+    .action(async (options) => {
+      const cwd = process.cwd();
+      const trekkerDir = resolve(cwd, ".trekker");
+      const dbPath = resolve(trekkerDir, "trekker.db");
+
+      // Check if .trekker directory exists
+      if (!existsSync(trekkerDir)) {
+        console.error("Error: No .trekker directory found in current directory.");
+        console.error("Run 'trekker init' first to initialize the issue tracker.");
+        process.exit(1);
+      }
+
+      // Check if database exists
+      if (!existsSync(dbPath)) {
+        console.error("Error: No trekker.db found in .trekker directory.");
+        console.error("Run 'trekker init' first to initialize the issue tracker.");
+        process.exit(1);
+      }
+
+      // Set environment variables
+      process.env.TREKKER_DB_PATH = dbPath;
+      process.env.PORT = options.port;
+
+      console.log(`Starting Trekker Dashboard on http://localhost:${options.port}`);
+      console.log(`Using database: ${dbPath}`);
+      console.log("Press Ctrl+C to stop\n");
+
+      // Import and start the server
+      const serverPath = resolve(__dirname, "..", "dist", "server", "index.js");
+      if (!existsSync(serverPath)) {
+        console.error("Error: Server bundle not found at", serverPath);
+        console.error("The package may not have been built correctly.");
+        process.exit(1);
+      }
+
+      await import(serverPath);
+    });
 
-program.parse();
+  program.parse();
+}