local-ticket-board 0.0.1

package/README.md

@@ -0,0 +1,18 @@
+# local-ticket-board
+
+Scaffold the **Git Kanban - Local Ticket Board** into any repo via `npx`.
+
+## Usage
+
+```bash
+npx local-ticket-board@latest kanban
+cd kanban
+npm run dev
+```
+
+## Options
+
+- `--template <git-url>`: Use a different git repo as the template.
+- `--no-install`: Skip `npm install`.
+
+

package/bin/create-ticket-board.js

@@ -0,0 +1,142 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import fs from "node:fs";
+import path from "node:path";
+
+const DEFAULT_TEMPLATE = "https://github.com/Justbeingjustin/ticket-board.git";
+
+function printHelp() {
+  console.log(`
+local-ticket-board
+
+Usage:
+  npx local-ticket-board@latest [directory] [--template <git-url>] [--no-install]
+
+Examples:
+  npx local-ticket-board@latest kanban
+  npx local-ticket-board@latest apps/kanban --no-install
+  npx local-ticket-board@latest kanban --template https://github.com/you/your-template.git
+`.trim());
+}
+
+function fail(message) {
+  console.error(`\nError: ${message}\n`);
+  process.exit(1);
+}
+
+function parseArgs(argv) {
+  const args = argv.slice(2);
+  let dir;
+  let template = DEFAULT_TEMPLATE;
+  let install = true;
+
+  for (let i = 0; i < args.length; i++) {
+    const a = args[i];
+    if (!a) continue;
+
+    if (a === "-h" || a === "--help") {
+      return { help: true };
+    }
+    if (a === "--no-install") {
+      install = false;
+      continue;
+    }
+    if (a === "--template") {
+      const v = args[i + 1];
+      if (!v) fail("--template requires a value");
+      template = v;
+      i++;
+      continue;
+    }
+    if (a.startsWith("-")) {
+      fail(`Unknown option: ${a}`);
+    }
+    if (!dir) {
+      dir = a;
+      continue;
+    }
+    fail(`Unexpected extra argument: ${a}`);
+  }
+
+  return { help: false, dir: dir ?? "kanban", template, install };
+}
+
+function run(cmd, cmdArgs, opts = {}) {
+  const res = spawnSync(cmd, cmdArgs, {
+    stdio: "inherit",
+    shell: process.platform === "win32",
+    ...opts,
+  });
+  if (res.status !== 0) {
+    fail(`Command failed: ${cmd} ${cmdArgs.join(" ")}`);
+  }
+}
+
+function rmIfExists(p) {
+  if (fs.existsSync(p)) {
+    fs.rmSync(p, { recursive: true, force: true });
+  }
+}
+
+function ensureTargetDirEmpty(targetDir) {
+  if (!fs.existsSync(targetDir)) return;
+  const entries = fs.readdirSync(targetDir);
+  if (entries.length > 0) {
+    fail(`Target directory is not empty: ${targetDir}`);
+  }
+}
+
+function setPackageNameIfPossible(targetDir, name) {
+  try {
+    const pkgPath = path.join(targetDir, "package.json");
+    if (!fs.existsSync(pkgPath)) return;
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
+    pkg.name = name;
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+  } catch {
+    // best-effort
+  }
+}
+
+const parsed = parseArgs(process.argv);
+if (parsed.help) {
+  printHelp();
+  process.exit(0);
+}
+
+const targetDir = path.resolve(process.cwd(), parsed.dir);
+const targetBaseName = path.basename(targetDir);
+
+ensureTargetDirEmpty(targetDir);
+
+// Ensure parent folder exists (e.g. apps/kanban)
+fs.mkdirSync(path.dirname(targetDir), { recursive: true });
+
+console.log(`\nCreating Ticket Board in: ${targetDir}`);
+console.log(`Template: ${parsed.template}\n`);
+
+// Clone template repo
+run("git", ["clone", "--depth", "1", parsed.template, targetDir]);
+
+// Remove git history so it becomes "your" project
+rmIfExists(path.join(targetDir, ".git"));
+
+// Remove GitHub-only files if present
+rmIfExists(path.join(targetDir, ".github"));
+
+// If the template repo name differs, adjust package name
+setPackageNameIfPossible(targetDir, targetBaseName);
+
+if (parsed.install) {
+  console.log("\nInstalling dependencies...\n");
+  run("npm", ["install"], { cwd: targetDir });
+}
+
+console.log("\nDone.\n");
+console.log("Next steps:");
+console.log(`  cd ${parsed.dir}`);
+if (!parsed.install) console.log("  npm install");
+console.log("  npm run dev");
+console.log("");
+
+

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "local-ticket-board",
+  "version": "0.0.1",
+  "description": "Scaffold the Git Kanban local ticket board into any repo.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Justbeingjustin/ticket-board.git"
+  },
+  "homepage": "https://github.com/Justbeingjustin/ticket-board",
+  "bugs": {
+    "url": "https://github.com/Justbeingjustin/ticket-board/issues"
+  },
+  "type": "module",
+  "bin": {
+    "local-ticket-board": "bin/create-ticket-board.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin/"
+  ],
+  "keywords": [
+    "create",
+    "scaffold",
+    "nextjs",
+    "kanban"
+  ]
+}
+
+