@docubook/cli 0.2.3 → 0.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docubook/cli",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "DocuBook CLI tool that helps you initialize, update, and deploy documentation directly from your terminal.",
   "type": "module",
   "files": [
@@ -12,11 +12,6 @@
     "docubook": "src/index.js"
   },
   "main": "./src/index.js",
-  "scripts": {
-    "dev": "node src/index.js",
-    "lint": "eslint src/",
-    "lint:fix": "eslint src/ --fix"
-  },
   "keywords": [
     "docubook",
     "documentation",
@@ -47,5 +42,10 @@
   },
   "engines": {
     "node": ">=18.0.0"
+  },
+  "scripts": {
+    "dev": "node src/index.js",
+    "lint": "eslint src/",
+    "lint:fix": "eslint src/ --fix"
   }
-}
+}

package/src/cli/program.js

@@ -1,3 +1,4 @@
+/* global fetch */
 import { program } from "commander";
 import { collectUserInput } from "./promptHandler.js";
 import { createProject } from "../installer/projectInstaller.js";
@@ -6,6 +7,109 @@ 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";
+
+// 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(tag) {
+  // Try to fetch CHANGELOG.md from the repo tag. Support several tag-name variants
+  // (e.g. v1.2.3, 1.2.3, cli-v1.2.3, cli-1.2.3) and common filename variants.
+  const repo = "DocuBook/docubook";
+
+  const bare = tag.replace(/^v/, "");
+  const variants = [tag, bare, `cli-${tag}`, `cli-${bare}`].filter(Boolean);
+
+  const candidates = [];
+  for (const v of variants) {
+    candidates.push(`https://raw.githubusercontent.com/${repo}/${v}/CHANGELOG.md`);
+    candidates.push(`https://raw.githubusercontent.com/${repo}/${v}/CHANGELOG.MD`);
+  }
+  // final fallback to main branch
+  candidates.push(`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++) {
+    if (/^#{1,3}\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 tag = version.startsWith("v") ? version : `v${version}`;
+    const changelog = await _fetchChangelogFromGitHub(tag);
+    if (!changelog) return;
+
+    const section = _extractVersionSection(changelog, version);
+    if (!section) return;
+
+    // Print a concise changelog section
+    console.log("\n=== DocuBook CLI changelog (new) ===\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
@@ -14,7 +118,80 @@ import { getAvailableTemplates, getTemplate, getDefaultTemplate } from "../utils
 export function initializeProgram(version) {
   program
     .version(version)
-    .description("CLI to create a new DocuBook project")
+    .description("CLI to create a new DocuBook project");
+
+  // Add `update` command: check npm registry and install latest globally if needed
+  program
+    .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 (latest === version) {
+          console.log(`No update needed, current version is ${version}, fetched 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;
+      }
+    });
+
+  // Expose a `version` subcommand: `docubook version`
+  program
+    .command('version')
+    .description('Print the DocuBook CLI version')
+    .action(() => {
+      console.log(`DocuBook CLI ${version}`);
+      console.log("Run 'docubook update' to check for updates.");
+      process.exit(0);
+    });
+
+  // Default behavior (create project)
+  program
     .argument("[directory]", "The name of the project directory")
     .action(async (directory) => {
       const state = new CLIState();

package/src/index.js

@@ -14,6 +14,14 @@ const packageJsonPath = path.join(__dirname, '..', 'package.json');
 const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
 const VERSION = packageJson.version;
 
+// Handle --version / -v early to print custom output
+const args = process.argv.slice(2);
+if (args.includes('--version') || args.includes('-v')) {
+  console.log(`DocuBook CLI ${VERSION}`);
+  console.log("Run 'docubook update' to check for updates.");
+  process.exit(0);
+}
+
 // Initialize and parse CLI arguments
 const program = initializeProgram(VERSION);
 program.parse(process.argv);

package/src/tui/ascii.js

@@ -62,7 +62,7 @@ export function createWelcomeBanner(version) {
   const logoMid = `${colors.cyan}${colors.bright}▌>_▐${colors.reset}`
   const logoBot = `${colors.cyan}▙▄▄▟${colors.reset}`
 
-  const title = `${colors.cyan}${colors.bright}DocuBook${colors.reset} v${version}`
+  const title = `${colors.cyan}${colors.bright}DocuBook CLI${colors.reset} v${version}`
   const subtitle = `${colors.gray}Initialize, build, and deploy docs from terminal.${colors.reset}`
 
   const tip = `${colors.gray}Visit our documentation.${colors.reset}`
@@ -103,16 +103,8 @@ export function createBoxedMessage(title, content, color = colors.green) {
   const reset = "\x1b[0m";
   const termWidth = process.stdout.columns || 80;
 
-  // 1. Tentukan total lebar box (termasuk border)
   const boxWidth = Math.min(80, termWidth - 4);
-
-  // 2. width adalah panjang garis horizontal (─) di atas dan bawah
-  // Total lebar box adalah width + 2 (untuk karakter pojok ┌ dan ┐)
   const width = boxWidth - 2;
-
-  // 3. inner adalah ruang bersih di dalam box untuk teks (tanpa padding spasi)
-  // Kita beri padding 2 spasi di kiri dan 2 spasi di kanan (total 4)
-  // Jadi: 1(│) + 2(spasi) + inner + 2(spasi) + 1(│) = width + 2
   const inner = (width + 2) - 6;
 
   const centerTitle = () => {
@@ -126,16 +118,11 @@ export function createBoxedMessage(title, content, color = colors.green) {
 
   const pad = (text = "") => {
     const len = stringWidth(text);
-    // Tambahkan spasi hingga tepat mengisi 'inner'
     return text + " ".repeat(Math.max(0, inner - len));
   };
 
   const lines = [];
-
-  // Header
   lines.push(`${color}┌${centerTitle()}┐${reset}`);
-
-  // Padding atas (opsional)
   lines.push(`${color}│${reset}  ${pad("")}  ${color}│${reset}`);
 
   const items = typeof content === "string"
@@ -145,15 +132,10 @@ export function createBoxedMessage(title, content, color = colors.green) {
   for (const line of items) {
     const wrapped = wrapText(line, inner);
     wrapped.forEach((w) => {
-      // Pastikan struktur: │ + spasi(2) + konten + spasi(2) + │
       lines.push(`${color}│${reset}  ${pad(w)}  ${color}│${reset}`);
     });
   }
-
-  // Padding bawah (opsional)
   lines.push(`${color}│${reset}  ${pad("")}  ${color}│${reset}`);
-
-  // Footer
   lines.push(`${color}└${"─".repeat(width)}┘${reset}`);
 
   return "\n" + lines.join("\n") + "\n";

package/src/utils/packageManager.js

@@ -1,32 +1,6 @@
-import { execSync } from "child_process";
 import fs from "fs";
 import path from "path";
 
-/**
- * Gets the version of the specified package manager
- * @param {string} pm - Package manager name
- * @returns {string|null} Version string or null if not installed
- */
-export function getPackageManagerVersion(pm) {
-  try {
-    return execSync(`${pm} --version`).toString().trim();
-  } catch {
-    return null;
-  }
-}
-
-/**
- * Detects the default package manager from user environment
- * @returns {string} Default package manager name
- */
-export function detectDefaultPackageManager() {
-  const userAgent = process.env.npm_config_user_agent || "";
-  if (userAgent.includes("pnpm")) return "pnpm";
-  if (userAgent.includes("yarn")) return "yarn";
-  if (userAgent.includes("bun")) return "bun";
-  return "npm";
-}
-
 /**
  * Updates postcss config file extension for Bun compatibility
  * @param {string} projectPath - Path to the project directory

package/templates.json

@@ -16,6 +16,23 @@
       ],
       "url": "https://github.com/DocuBook/docubook/tree/main/packages/template/nextjs-vercel"
     },
+    {
+      "id": "nextjs-docker",
+      "name": "nextjs-docker",
+      "description": "Modern documentation with Next.js standalone and Docker deployment",
+      "features": [
+        "Next.js 16",
+        "React 19",
+        "TypeScript",
+        "Tailwind CSS",
+        "MDX Support",
+        "Dark Mode",
+        "Search (Algolia)",
+        "Responsive Design",
+        "Docker Deployment"
+      ],
+      "url": "https://github.com/DocuBook/docubook/tree/main/packages/template/nextjs-docker"
+    },
     {
       "id": "react-router",
       "name": "react-router",