@docubook/cli 0.2.7 → 0.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docubook/cli",
-  "version": "0.2.7",
+  "version": "0.2.9",
   "description": "DocuBook CLI tool that helps you initialize, update, and deploy documentation directly from your terminal.",
   "type": "module",
   "files": [

package/src/cli/program.js

@@ -1,113 +1,12 @@
-/* global fetch */
 import { program } from "commander";
 import { collectUserInput } from "./promptHandler.js";
 import { createProject } from "../installer/projectInstaller.js";
+import { handleUpdate } from "./updateHandler.js";
 import log from "../utils/logger.js";
 import { renderWelcome, renderDone, renderError } from "../tui/renderer.js";
 import { CLIState } from "../tui/state.js";
 import { detectPackageManager, getPackageManagerInfo, getPackageManagerVersion } from "../utils/packageManagerDetect.js";
 import { getAvailableTemplates, getTemplate, getDefaultTemplate } from "../utils/templateDetect.js";
-import { execSync } from "child_process";
-import ora from "ora";
-import fs from "fs";
-import os from "os";
-import path from "path";
-import { lt } from "semver";
-
-// Helpers to show changelog once per installed version. Stores shown versions under
-// $HOME/.docubook_cli_seen_changelogs.json as a map: { "@docubook/cli": ["1.2.3"] }
-const _CHANGELOG_STORE = path.join(os.homedir(), ".docubook_cli_seen_changelogs.json");
-function _readChangelogStore() {
-  try {
-    const raw = fs.readFileSync(_CHANGELOG_STORE, "utf8");
-    return JSON.parse(raw || "{}");
-  } catch {
-    return {};
-  }
-}
-function _writeChangelogStore(obj) {
-  try {
-    fs.writeFileSync(_CHANGELOG_STORE, JSON.stringify(obj, null, 2), { mode: 0o600 });
-  } catch {
-    // non-fatal
-  }
-}
-
-async function _fetchChangelogFromGitHub(version) {
-  // Fetch CHANGELOG.md from the CLI release tag format: cli-v0.2.5
-  const repo = "DocuBook/docubook";
-  const bare = version.replace(/^v/, "");
-  const tag = `cli-v${bare}`;
-
-  const candidates = [
-    `https://raw.githubusercontent.com/${repo}/${tag}/CHANGELOG.md`,
-    `https://raw.githubusercontent.com/${repo}/${tag}/CHANGELOG.MD`,
-    // Fallback to main branch
-    `https://raw.githubusercontent.com/${repo}/main/CHANGELOG.md`,
-  ];
-
-  for (const url of candidates) {
-    try {
-      const res = await fetch(url);
-      if (res && res.ok) return await res.text();
-    } catch {
-      // ignore and try next
-    }
-  }
-  return null;
-}
-
-function _extractVersionSection(changelogText, version) {
-  if (!changelogText) return null;
-  const lines = changelogText.split(/\r?\n/);
-  // Look for headings that include the version (e.g. "## v1.2.3" or "## 1.2.3")
-  const headerRe = new RegExp(`^#{1,3}\\s*(?:v)?${version.replace(/\./g, "\\.")}(?:\\b|\\D)`, "i");
-  let start = -1;
-  for (let i = 0; i < lines.length; i++) {
-    if (headerRe.test(lines[i])) {
-      start = i;
-      break;
-    }
-  }
-  if (start === -1) return changelogText.slice(0, 2000); // fallback: return beginning of changelog
-
-  let end = lines.length;
-  for (let j = start + 1; j < lines.length; j++) {
-    // Match the next version heading (level 2, ## but not ###)
-    if (/^##\s*(?!#)/.test(lines[j])) {
-      end = j;
-      break;
-    }
-  }
-  return lines.slice(start, end).join("\n");
-}
-
-async function showChangelogOnce(pkgName, version) {
-  try {
-    const store = _readChangelogStore();
-    const seen = Array.isArray(store[pkgName]) ? store[pkgName] : [];
-    if (seen.includes(version)) return;
-
-    const changelog = await _fetchChangelogFromGitHub(version);
-    if (!changelog) return;
-
-    const section = _extractVersionSection(changelog, version);
-    if (!section) return;
-
-    // Print a concise changelog section
-    console.log("\n===========================================================\n");
-    console.log(section.trim());
-    console.log("\nFor full changelog, visit:");
-    console.log(`  https://github.com/DocuBook/docubook/blob/main/CHANGELOG.md\n`);
-
-    // Mark as shown
-    store[pkgName] = Array.from(new Set([...seen, version]));
-    _writeChangelogStore(store);
-  } catch {
-    // silent on any error - changelog is a nicety
-  }
-}
-
 
 /**
  * Initializes the CLI program
@@ -123,59 +22,7 @@ export function initializeProgram(version) {
     .command("update")
     .description("Check for updates and install the latest DocuBook CLI globally")
     .action(async () => {
-      const pkgName = "@docubook/cli";
-      // declare spinner in outer scope so catch block can safely reference it
-      let spinner;
-      try {
-        // Fetch package metadata from npm registry
-        const encoded = encodeURIComponent(pkgName);
-        spinner = ora('Checking for updates...').start();
-        const res = await fetch(`https://registry.npmjs.org/${encoded}`);
-        if (!res.ok) {
-          spinner.fail(`Failed to fetch registry metadata (status ${res.status})`);
-          throw new Error(`Failed to fetch registry metadata (status ${res.status})`);
-        }
-        const data = await res.json();
-        const latest = data && data["dist-tags"] && data["dist-tags"].latest;
-        if (!latest) {
-          spinner.fail("Could not determine latest version from npm registry");
-          throw new Error("Could not determine latest version from npm registry");
-        }
-
-        // Stop spinner and print a plain "Checking for updates..." line (no check mark)
-        if (spinner && typeof spinner.stop === 'function') spinner.stop();
-        console.log('Checking for updates...');
-
-        if (!lt(version, latest)) {
-          console.log(`No update needed, current version is ${version}, latest release is ${latest}`);
-          return;
-        }
-
-        console.log(`Updating ${pkgName} from ${version} to ${latest}...`);
-
-        // Use npm to install globally. This will stream stdout/stderr to the user.
-        const cmd = `npm install -g ${pkgName}@${latest}`;
-        try {
-          execSync(cmd, { stdio: "inherit" });
-          console.log(`Successfully updated to ${latest}`);
-          // Try to show changelog for the newly installed version once
-          try {
-            await showChangelogOnce(pkgName, latest);
-          } catch {
-            // non-fatal
-          }
-        } catch (installErr) {
-          // If install fails, provide a helpful message
-          console.error(`Update failed: ${installErr.message || installErr}`);
-          console.error(`Try running the following command manually:\n  ${cmd}\nIf you see permissions errors, consider running with elevated privileges or using a Node version manager.`);
-          process.exitCode = 1;
-        }
-      } catch (err) {
-        // ensure spinner is stopped on error
-        if (spinner && typeof spinner.stop === 'function') spinner.stop();
-        console.error(err.message || err);
-        process.exitCode = 1;
-      }
+      await handleUpdate(version);
     });
 
   // Expose a `version` subcommand: `docubook version`

package/src/cli/updateHandler.js

@@ -0,0 +1,332 @@
+/* global fetch */
+import { execSync } from "child_process";
+import ora from "ora";
+import fs from "fs";
+import os from "os";
+import path from "path";
+import { lt } from "semver";
+
+// Changelog store to avoid showing same version multiple times
+const _CHANGELOG_STORE = path.join(os.homedir(), ".docubook_cli_seen_changelogs.json");
+
+function _readChangelogStore() {
+  try {
+    const raw = fs.readFileSync(_CHANGELOG_STORE, "utf8");
+    return JSON.parse(raw || "{}");
+  } catch {
+    return {};
+  }
+}
+
+function _writeChangelogStore(obj) {
+  try {
+    fs.writeFileSync(_CHANGELOG_STORE, JSON.stringify(obj, null, 2), { mode: 0o600 });
+  } catch {
+    // non-fatal
+  }
+}
+
+/**
+ * Detect which package manager was used to install this CLI globally
+ * Returns: 'npm', 'bun', 'yarn', or 'pnpm'
+ */
+function detectInstalledPackageManager() {
+  try {
+    // Check npm_config_user_agent environment variable
+    const userAgent = process.env.npm_config_user_agent || "";
+    if (userAgent.includes("pnpm")) return "pnpm";
+    if (userAgent.includes("bun")) return "bun";
+    if (userAgent.includes("yarn")) return "yarn";
+    if (userAgent.includes("npm")) return "npm";
+
+    // Fallback: check what's available in PATH
+    try {
+      execSync("pnpm --version", { stdio: "ignore" });
+      return "pnpm";
+    } catch {
+      // try next
+    }
+
+    try {
+      execSync("bun --version", { stdio: "ignore" });
+      return "bun";
+    } catch {
+      // try next
+    }
+
+    try {
+      execSync("yarn --version", { stdio: "ignore" });
+      return "yarn";
+    } catch {
+      // try next
+    }
+
+    // Default to npm
+    return "npm";
+  } catch {
+    return "npm";
+  }
+}
+
+/**
+ * Fetch release info from GitHub API
+ * Returns: { tag_name, name, body, created_at, html_url } or null
+ */
+async function fetchLatestReleaseFromGitHub() {
+  try {
+    const owner = "DocuBook";
+    const repo = "docubook";
+    const url = `https://api.github.com/repos/${owner}/${repo}/releases/latest`;
+
+    const res = await fetch(url, {
+      headers: { "Accept": "application/vnd.github.v3+json" }
+    });
+
+    if (!res.ok) {
+      return null;
+    }
+
+    const data = await res.json();
+
+    // Ensure it's a cli release
+    if (!data.tag_name || !data.tag_name.startsWith("cli-v")) {
+      return null;
+    }
+
+    return {
+      tag_name: data.tag_name,
+      name: data.name,
+      body: data.body || "",
+      created_at: data.created_at,
+      html_url: data.html_url,
+    };
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Generate changelog from git commits between two versions
+ * Parses conventional commits and categorizes them
+ */
+async function generateChangelogFromCommits(fromTag, toTag) {
+  try {
+    // Get commits between two tags
+    const cmd = `git log ${fromTag}..${toTag} --pretty=format:"%H|%s|%b" -- packages/cli/ 2>/dev/null || echo ""`;
+    const output = execSync(cmd, { encoding: "utf-8", stdio: ["pipe", "pipe", "ignore"] });
+
+    if (!output || output.trim() === "") {
+      return null;
+    }
+
+    const commits = output.trim().split("\n").filter(Boolean).map((line) => {
+      const [hash, subject] = line.split("|");
+      return { hash: hash.slice(0, 7), subject };
+    });
+
+    if (commits.length === 0) {
+      return null;
+    }
+
+    // Categorize commits by conventional commit type
+    const categories = {
+      added: [],
+      fixed: [],
+      improved: [],
+      deprecated: [],
+      removed: [],
+    };
+
+    commits.forEach(({ hash, subject }) => {
+      const repoUrl = "https://github.com/DocuBook/docubook/commit";
+      const link = `[${hash}](${repoUrl}/${hash})`;
+
+      if (subject.startsWith("feat") || subject.startsWith("feat:")) {
+        categories.added.push(`- ${subject.replace(/^feat(\(.*?\))?:\s*/, "")} ${link}`);
+      } else if (subject.startsWith("fix") || subject.startsWith("fix:")) {
+        categories.fixed.push(`- ${subject.replace(/^fix(\(.*?\))?:\s*/, "")} ${link}`);
+      } else if (subject.startsWith("perf") || subject.startsWith("refactor")) {
+        categories.improved.push(`- ${subject.replace(/^(perf|refactor)(\(.*?\))?:\s*/, "")} ${link}`);
+      } else if (subject.startsWith("deprecate")) {
+        categories.deprecated.push(`- ${subject.replace(/^deprecate(\(.*?\))?:\s*/, "")} ${link}`);
+      } else if (subject.startsWith("remove") || subject.startsWith("remove:")) {
+        categories.removed.push(`- ${subject.replace(/^remove(\(.*?\))?:\s*/, "")} ${link}`);
+      }
+    });
+
+    // Build markdown
+    let markdown = "";
+    if (categories.added.length > 0) {
+      markdown += `### Added\n${categories.added.join("\n")}\n\n`;
+    }
+    if (categories.fixed.length > 0) {
+      markdown += `### Fixed\n${categories.fixed.join("\n")}\n\n`;
+    }
+    if (categories.improved.length > 0) {
+      markdown += `### Improved\n${categories.improved.join("\n")}\n\n`;
+    }
+    if (categories.deprecated.length > 0) {
+      markdown += `### Deprecated\n${categories.deprecated.join("\n")}\n\n`;
+    }
+    if (categories.removed.length > 0) {
+      markdown += `### Removed\n${categories.removed.join("\n")}\n\n`;
+    }
+
+    return markdown.trim() || null;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Fetch and display changelog from GitHub release
+ * Uses git commits for structured changelog if available
+ */
+async function showChangelogOnce(pkgName, version, releaseInfo) {
+  try {
+    const store = _readChangelogStore();
+    const seen = Array.isArray(store[pkgName]) ? store[pkgName] : [];
+    if (seen.includes(version)) return;
+
+    let changelog = "";
+
+    // Try to generate from git commits first
+    try {
+      // Get the previous release tag
+      const currentTag = `cli-v${version}`;
+      const prevTagCmd = `git describe --tags --abbrev=0 ${currentTag}^ 2>/dev/null || echo ""`;
+      const prevTag = execSync(prevTagCmd, { encoding: "utf-8", stdio: ["pipe", "pipe", "ignore"] }).trim();
+
+      if (prevTag && prevTag.startsWith("cli-v")) {
+        const generatedChangelog = await generateChangelogFromCommits(prevTag, currentTag);
+        if (generatedChangelog) {
+          changelog = generatedChangelog;
+        }
+      }
+    } catch {
+      // fallback to release body
+    }
+
+    // Fallback to release body if no commits found
+    if (!changelog && releaseInfo && releaseInfo.body) {
+      changelog = releaseInfo.body.slice(0, 2000);
+    }
+
+    if (!changelog) return;
+
+    // Print changelog
+    console.log("\n===========================================================\n");
+    console.log(`## ${releaseInfo?.tag_name || `cli-v${version}`}`);
+    console.log("");
+    console.log(changelog);
+    console.log("\nFull changelog, visit:");
+    console.log(`  ${releaseInfo?.html_url || `https://github.com/DocuBook/docubook/releases/tag/cli-v${version}`}\n`);
+
+    // Mark as shown
+    store[pkgName] = Array.from(new Set([...seen, version]));
+    _writeChangelogStore(store);
+  } catch {
+    // silent on any error - changelog is a nicety
+  }
+}
+
+/**
+ * Install package using detected package manager
+ * Supports npm, bun, yarn, and pnpm
+ */
+function installGlobal(packageName, version, packageManager) {
+  let cmd;
+
+  switch (packageManager) {
+    case "pnpm":
+      cmd = `pnpm add -g ${packageName}@${version}`;
+      break;
+    case "bun":
+      cmd = `bun add -g ${packageName}@${version}`;
+      break;
+    case "yarn":
+      cmd = `yarn global add ${packageName}@${version}`;
+      break;
+    case "npm":
+    default:
+      cmd = `npm install -g ${packageName}@${version}`;
+      break;
+  }
+
+  execSync(cmd, { stdio: "inherit" });
+}
+
+/**
+ * Main update handler: check for updates and install if available
+ */
+export async function handleUpdate(currentVersion) {
+  const pkgName = "@docubook/cli";
+  let spinner;
+
+  try {
+    // Detect package manager
+    const packageManager = detectInstalledPackageManager();
+
+    // Fetch package metadata from npm registry
+    const encoded = encodeURIComponent(pkgName);
+    spinner = ora("Checking for updates...").start();
+
+    const res = await fetch(`https://registry.npmjs.org/${encoded}`);
+    if (!res.ok) {
+      spinner.fail(`Failed to fetch registry metadata (status ${res.status})`);
+      throw new Error(`Failed to fetch registry metadata (status ${res.status})`);
+    }
+
+    const data = await res.json();
+    const latest = data && data["dist-tags"] && data["dist-tags"].latest;
+    if (!latest) {
+      spinner.fail("Could not determine latest version from npm registry");
+      throw new Error("Could not determine latest version from npm registry");
+    }
+
+    // Stop spinner and print a plain line
+    if (spinner && typeof spinner.stop === "function") spinner.stop();
+    console.log("Checking for updates...");
+
+    if (!lt(currentVersion, latest)) {
+      console.log(
+        `No update needed, current version is ${currentVersion}, latest release is ${latest}`
+      );
+      return;
+    }
+
+    console.log(
+      `Updating ${pkgName} from ${currentVersion} to ${latest} using ${packageManager}...`
+    );
+
+    // Fetch release info from GitHub
+    const releaseInfo = await fetchLatestReleaseFromGitHub(pkgName);
+
+    // Install using detected package manager
+    try {
+      installGlobal(pkgName, latest, packageManager);
+      console.log(`Successfully updated to ${latest}`);
+
+      // Try to show changelog for the newly installed version once
+      try {
+        await showChangelogOnce(pkgName, latest, releaseInfo);
+      } catch {
+        // non-fatal
+      }
+    } catch (installErr) {
+      // If install fails, provide a helpful message
+      const cmd = `${packageManager === "bun" ? "bun install -g" : packageManager === "yarn" ? "yarn global add" : "npm install -g"} ${pkgName}@${latest}`;
+      console.error(`Update failed: ${installErr.message || installErr}`);
+      console.error(
+        `Try running the following command manually:\n  ${cmd}\n` +
+        `If you see permissions errors, consider running with elevated privileges or using a Node version manager.`
+      );
+      process.exitCode = 1;
+    }
+  } catch (err) {
+    // ensure spinner is stopped on error
+    if (spinner && typeof spinner.stop === "function") spinner.stop();
+    console.error(err.message || err);
+    process.exitCode = 1;
+  }
+}