@docubook/cli 0.2.1 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docubook/cli",
-  "version": "0.2.1",
+  "version": "0.2.4",
   "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,8 @@ 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";
 
 /**
  * Initializes the CLI program
@@ -14,7 +17,64 @@ 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}`);
+        } 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;
+      }
+    });
+
+  // Default behavior (create project)
+  program
     .argument("[directory]", "The name of the project directory")
     .action(async (directory) => {
       const state = new CLIState();
@@ -63,7 +123,7 @@ export function initializeProgram(version) {
 
         // Show success message
         const pmInfo = getPackageManagerInfo(detectedPM);
-        renderDone(userInput.directoryName, detectedPM, pmInfo.devCmd);
+        renderDone(userInput.directoryName, detectedPM, pmInfo.devCmd, userInput.autoInstall !== false);
       } catch (err) {
         renderError(err.message || "An unexpected error occurred.");
         log.error(err.message || "An unexpected error occurred.");

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/installer/projectInstaller.js

@@ -1,5 +1,6 @@
 import path from "path";
 import fs from "fs";
+import { URL } from "url";
 import ora from "ora";
 import chalk from "chalk";
 import { execSync } from "child_process";
@@ -36,9 +37,9 @@ export async function createProject(options) {
     // 1. Create project directory and get/download template
     state?.setCurrentStep("Creating directories...");
     renderScaffolding(state || {});
-    
+
     const templatePath = await getOrDownloadTemplate(template, state);
-    
+
     if (!templatePath || !fs.existsSync(templatePath)) {
       throw new Error(`Template "${template}" could not be found or downloaded.`);
     }
@@ -93,46 +94,31 @@ async function getOrDownloadTemplate(templateId, state) {
   // Download from GitHub
   state?.setCurrentStep("Downloading template...");
   renderScaffolding(state || {});
-  
+
   const templateInfo = getTemplate(templateId);
-  if (!templateInfo || !templateInfo.url) {
-    throw new Error(`Template "${templateId}" information not available.`);
+  if (!templateInfo) {
+    throw new Error(`Template "${templateId}" not found.`);
   }
 
   return await downloadTemplateFromGitHub(templateId, templateInfo.url);
 }
 
 /**
- * Gets local template path if it exists
+ * Gets local template path if it exists (for development)
  * @param {string} templateId - Template ID
  * @returns {string|null} Path to local template or null
  */
 function getLocalTemplatePath(templateId) {
-  import("file:///").catch(() => {});
-  
-  const distPath = path.join(
-    new URL(".", import.meta.url).pathname,
-    "..",
-    "..",
-    "dist",
-    templateId
-  );
-  
+  const currentDir = new URL(".", import.meta.url).pathname;
+
+  // Check dist/ folder first (if built)
+  const distPath = path.join(currentDir, "..", "..", "dist", templateId);
   if (fs.existsSync(distPath)) {
     return distPath;
   }
 
-  const devPath = path.join(
-    new URL(".", import.meta.url).pathname,
-    "..",
-    "..",
-    "..",
-    "..",
-    "packages",
-    "template",
-    templateId
-  );
-
+  // Check packages/template/ folder (dev environment)
+  const devPath = path.join(currentDir, "..", "..", "..", "..", "packages", "template", templateId);
   if (fs.existsSync(devPath)) {
     return devPath;
   }
@@ -143,28 +129,50 @@ function getLocalTemplatePath(templateId) {
 /**
  * Downloads template from GitHub repository
  * @param {string} templateId - Template ID
- * @param {string} gitHubUrl - GitHub URL to template
+ * @param {string} templateUrl - Template URL from templates.json
  * @returns {Promise<string>} Path to downloaded template
  */
-async function downloadTemplateFromGitHub(templateId, gitHubUrl) {
+async function downloadTemplateFromGitHub(templateId, templateUrl) {
   const tempDir = fs.mkdtempSync(path.join("/tmp", "docubook-"));
-  
+
   try {
-    // Convert GitHub web URL to archive URL
+    // Build archive URL from template URL
     // https://github.com/DocuBook/docubook/tree/main/packages/template/nextjs-vercel
     // -> https://github.com/DocuBook/docubook/archive/refs/heads/main.tar.gz
-    const archiveUrl = "https://github.com/DocuBook/docubook/archive/refs/heads/main.tar.gz";
-    
-    // Download archive
+    const repoMatch = templateUrl.match(/https:\/\/github\.com\/([^/]+\/[^/]+)\//);
+    if (!repoMatch) {
+      throw new Error(`Invalid template URL: ${templateUrl}`);
+    }
+
+    const archiveUrl = `https://github.com/${repoMatch[1]}/archive/refs/heads/main.tar.gz`;
     const archivePath = path.join(tempDir, "repo.tar.gz");
-    execSync(`curl -L -o "${archivePath}" "${archiveUrl}"`, { stdio: "pipe" });
 
-    // Extract archive
-    execSync(`tar -xzf "${archivePath}" -C "${tempDir}"`, { stdio: "pipe" });
+    // Show progress for download
+    const downloadSpinner = ora(`Downloading template...`).start();
+
+    try {
+      execSync(`curl -L -o "${archivePath}" "${archiveUrl}"`, { stdio: "pipe" });
+      downloadSpinner.succeed("Template downloaded");
+    } catch (err) {
+      downloadSpinner.fail("Failed to download template");
+      throw err;
+    }
+
+    // Show progress for extraction
+    const extractSpinner = ora(`Extracting template...`).start();
+
+    try {
+      execSync(`tar -xzf "${archivePath}" -C "${tempDir}"`, { stdio: "pipe" });
+      extractSpinner.succeed("Template extracted");
+    } catch (err) {
+      extractSpinner.fail("Failed to extract template");
+      throw err;
+    }
 
     // Find template in extracted repo
-    const extractedDir = path.join(tempDir, "docubook-main", "packages", "template", templateId);
-    
+    const repoName = repoMatch[1].split('/')[1];
+    const extractedDir = path.join(tempDir, `${repoName}-main`, "packages", "template", templateId);
+
     if (!fs.existsSync(extractedDir)) {
       throw new Error(`Template "${templateId}" not found in repository.`);
     }

package/src/utils/display.js

@@ -1,37 +1,5 @@
 import chalk from "chalk";
 import boxen from "boxen";
-import cliProgress from "cli-progress";
-
-/**
- * Displays an introduction message for the CLI.
- */
-export function displayIntro() {
-  console.log(`\n${chalk.bold.green("🚀 DocuBook Installer")}\n`);
-}
-
-/**
- * Displays a progress bar to simulate final setup.
- * @returns {Promise<void>} Promise that resolves when simulation completes.
- */
-export async function simulateInstallation() {
-  const bar = new cliProgress.SingleBar(
-    {
-      format: `Finishing setup... ${chalk.greenBright("{bar}")} | {percentage}%`,
-      barCompleteChar: "\u2588",
-      barIncompleteChar: "\u2591",
-      hideCursor: true,
-    },
-    cliProgress.Presets.shades_classic
-  );
-
-  bar.start(100, 0);
-  for (let i = 0; i <= 100; i++) {
-    await new Promise((r) => setTimeout(r, 20)); // Faster simulation
-    bar.update(i);
-  }
-  bar.stop();
-  console.log("\n");
-}
 
 /**
  * Displays manual installation steps if automatic installation fails.
@@ -56,29 +24,4 @@ export function displayManualSteps(projectDirectory, packageManager) {
       titleAlignment: "center",
     })
   );
-}
-
-/**
- * Displays next steps after successful installation.
- * @param {string} directoryName - Project directory name.
- * @param {string} packageManager - Package manager being used.
- */
-export function displayNextSteps(directoryName, packageManager) {
-  const steps = `
-  ${chalk.bold("Next steps:")}
-
-  1. ${chalk.blueBright(`cd ${directoryName}`)}
-  2. ${chalk.blueBright(`${packageManager} run dev`)}
-  `;
-
-  console.log(
-    boxen(steps, {
-      padding: 1,
-      margin: 1,
-      borderStyle: "round",
-      borderColor: "green",
-      title: "Success!",
-      titleAlignment: "center",
-    })
-  );
 }

package/src/utils/templateDetect.js

@@ -15,30 +15,30 @@ export function getAvailableTemplates() {
       const data = JSON.parse(content);
       return data.templates || [];
     }
-  } catch (err) {
+  } catch {
     // Fallback to directory scanning
   }
 
   // Fallback: scan template directories
   const distPath = path.join(__dirname, '..', '..', 'dist');
-  const templateDir = fs.existsSync(distPath) 
-    ? distPath 
+  const templateDir = fs.existsSync(distPath)
+    ? distPath
     : path.join(__dirname, '..', '..', '..', '..', 'packages', 'template');
-  
+
   if (!fs.existsSync(templateDir)) {
     return [];
   }
-  
+
   const entries = fs.readdirSync(templateDir, { withFileTypes: true });
   const templates = [];
-  
+
   for (const entry of entries) {
     if (!entry.isDirectory()) continue;
-    
+
     const configPath = path.join(templateDir, entry.name, 'template.config.json');
-    
+
     if (!fs.existsSync(configPath)) continue;
-    
+
     try {
       const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
       templates.push({
@@ -51,7 +51,7 @@ export function getAvailableTemplates() {
       console.error(`Failed to read template config for ${entry.name}`);
     }
   }
-  
+
   return templates;
 }