@docubook/create 1.14.0 → 1.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docubook/create",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "description": "CLI to create DocuBook projects",
   "main": "src/index.js",
   "type": "module",
@@ -23,8 +23,8 @@
     "chalk": "^5.3.0",
     "cli-progress": "^3.12.0",
     "commander": "^12.1.0",
-    "enquirer": "^2.4.1",
     "figlet": "^1.8.0",
-    "ora": "^8.1.0"
+    "ora": "^8.1.0",
+    "prompts": "^2.4.2"
   }
 }

package/src/cli/program.js

@@ -1,8 +1,8 @@
 import { program } from "commander";
-import chalk from "chalk";
-import { displayAsciiArt } from "../utils/display.js";
+import { displayIntro } from "../utils/display.js";
 import { collectUserInput } from "./promptHandler.js";
 import { createProject } from "../installer/projectInstaller.js";
+import log from "../utils/logger.js";
 
 /**
  * Initializes the CLI program
@@ -11,22 +11,21 @@ import { createProject } from "../installer/projectInstaller.js";
 export function initializeProgram(version) {
   program
     .version(version)
-    .description("CLI to create a new Docubook project")
-    .action(async () => {
+    .description("CLI to create a new DocuBook project")
+    // 1. Define optional argument here (handled below with .argument)
+    .argument("[directory]", "The name of the project directory")
+    .action(async (directory) => { // 2. Capture argument in action function
       try {
-        await displayAsciiArt();
-        console.log(chalk.white("DocuBook Installer\n"));
+        displayIntro();
+        // 3. Pass the argument to the prompt function
+        const options = await collectUserInput(directory);
 
-        // Collect user input
-        const options = await collectUserInput();
-
-        // Create project with collected options
         await createProject(options);
       } catch (err) {
-        // Error handling is done in the respective modules
+        log.error(err.message || "An unexpected error occurred.");
         process.exit(1);
       }
     });
 
   return program;
-}
+}

package/src/cli/promptHandler.js

@@ -1,73 +1,67 @@
-import enquirer from "enquirer";
+import prompts from "prompts";
 import { detectDefaultPackageManager, getPackageManagerVersion } from "../utils/packageManager.js";
 import log from "../utils/logger.js";
-
-const { prompt } = enquirer;
-
-/**
- * Detects if the command was run with yarn or yarn dlx
- * @returns {boolean}
- */
-function isYarnCommand() {
-  const userAgent = process.env.npm_config_user_agent || '';
-  return userAgent.includes('yarn') || process.argv.some(arg => arg.includes('yarn'));
-}
+import chalk from "chalk";
 
 /**
  * Collects user input for project creation
+ * @param {string} [cliProvidedDir] - The directory name provided via CLI argument.
  * @returns {Promise<Object>} User answers
  */
-export async function collectUserInput() {
-  // Skip installation prompt if running with yarn/yarn dlx
-  const isYarn = isYarnCommand();
+export async function collectUserInput(cliProvidedDir) {
   const defaultPackageManager = detectDefaultPackageManager();
+  let answers = {
+    directoryName: cliProvidedDir
+  };
 
-  // Get initial answers (directory name and package manager)
-  const { directoryName, packageManager } = await prompt([
+  const questions = [
     {
-      type: "input",
+      // Skip this question if directory name is provided
+      type: cliProvidedDir ? null : "text",
       name: "directoryName",
-      message: "📁 Project name",
+      message: "What is your project named?",
       initial: "docubook",
+      validate: (name) => name.trim().length > 0 ? true : "Project name cannot be empty.",
     },
     {
       type: "select",
       name: "packageManager",
-      message: "📦 Package manager",
-      choices: ["npm", "pnpm", "yarn", "bun"],
-      initial: defaultPackageManager,
-    }
-  ]);
-
-  // Only ask about installation if not using yarn
-  let installNow = false;
-  if (packageManager !== 'yarn') {
-    const { shouldInstall } = await prompt({
-      type: "confirm",
-      name: "shouldInstall",
-      message: "Install dependencies now?",
+      message: "Select your package manager:",
+      choices: [
+        { title: "npm", value: "npm" },
+        { title: "pnpm", value: "pnpm" },
+        { title: "yarn", value: "yarn" },
+        { title: "bun", value: "bun" },
+      ],
+      initial: ["npm", "pnpm", "yarn", "bun"].indexOf(defaultPackageManager),
+    },
+    {
+      type: (prev) => (prev !== 'yarn' ? "confirm" : null),
+      name: "installNow",
+      message: "Would you like to install dependencies now?",
       initial: true,
-    });
-    installNow = shouldInstall;
-  }
+    },
+  ];
 
-  // Prepare the answers object
-  const answers = {
-    directoryName,
-    packageManager,
-    installNow
-  };
+  const promptAnswers = await prompts(questions, {
+    onCancel: () => {
+      log.error("Scaffolding cancelled.");
+      process.exit(0);
+    },
+  });
 
-  // Validate package manager is installed
-  const version = getPackageManagerVersion(packageManager);
+  // Combine answers from CLI and from prompt
+  answers = { ...answers, ...promptAnswers };
 
+  // Validate the selected package manager
+  const version = getPackageManagerVersion(answers.packageManager);
   if (!version) {
-    log.error(`${packageManager} is not installed on your system.`);
-    process.exit(1);
+    throw new Error(`${chalk.bold(answers.packageManager)} is not installed on your system. Please install it to continue.`);
   }
 
   return {
     ...answers,
-    version
+    directoryName: answers.directoryName.trim(),
+    version,
   };
-}
+}

package/src/dist/app/page.tsx

@@ -6,7 +6,7 @@ import { cn } from "@/lib/utils";
 import AnimatedShinyText from "@/components/ui/animated-shiny-text";
 import { getMetadata } from "@/app/layout";
 import { Card, CardContent, CardHeader, CardTitle } from "@/components/ui/card";
-// v1.14.0
+
 export const metadata = getMetadata({
   title: "Home",
 });
@@ -25,7 +25,7 @@ export default function Home() {
             )}
           >
             <AnimatedShinyText className="inline-flex items-center justify-center px-4 py-1 transition ease-out hover:text-neutral-100 hover:duration-300 hover:dark:text-neutral-200">
-              <span>🚀 New Version - Release v1.14.0</span>
+              <span>🚀 New Version - Release v1.14.1</span>
               <ArrowRightIcon className="ml-1 size-3 transition-transform duration-300 ease-in-out group-hover:translate-x-0.5" />
             </AnimatedShinyText>
           </div>

package/src/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docubook",
-  "version": "1.14.0",
+  "version": "1.14.1",
   "private": true,
   "scripts": {
     "dev": "next dev",

package/src/installer/projectInstaller.js

@@ -9,117 +9,102 @@ import { configurePackageManager } from "../utils/packageManager.js";
 import { displayManualSteps, simulateInstallation, displayNextSteps } from "../utils/display.js";
 
 /**
- * Creates a new DocuBook project
- * @param {Object} options - Installation options
- * @param {string} options.directoryName - Project directory name
- * @param {string} options.packageManager - Package manager to use
- * @param {string} options.version - Package manager version
- * @param {boolean} options.installNow - Whether to install dependencies immediately
- * @returns {Promise<void>}
+ * Creates a new DocuBook project.
+ * @param {Object} options - Installation options.
  */
 export async function createProject({ directoryName, packageManager, version, installNow }) {
   const projectPath = path.resolve(process.cwd(), directoryName);
-  const spinner = ora("Creating your DocuBook project...").start();
+
+  if (fs.existsSync(projectPath)) {
+    throw new Error(`Directory "${directoryName}" already exists.`);
+  }
+
+  log.info(`Creating a new DocuBook project in ${chalk.cyan(projectPath)}...`);
+
+  const spinner = ora("Setting up project files...").start();
 
   try {
-    // Get the template directory path
+    // 1. Create project directory and copy template files
     const __filename = fileURLToPath(import.meta.url);
     const __dirname = path.dirname(__filename);
     const templatePath = path.join(__dirname, "../dist");
-
-    // Create project directory if it doesn't exist
-    if (!fs.existsSync(projectPath)) {
-      fs.mkdirSync(projectPath, { recursive: true });
-    }
-
-    // Copy template files to project directory
     copyDirectoryRecursive(templatePath, projectPath);
+    spinner.succeed("Project files created.");
 
-    // Configure package manager specific settings
+    // 2. Configure package manager specific settings
+    spinner.start("Configuring package manager...");
     configurePackageManager(packageManager, projectPath);
+    spinner.succeed("Package manager configured.");
 
-    // Update package.json with package manager info
+    // 3. Update package.json
+    spinner.start("Updating package.json...");
     const pkgPath = path.join(projectPath, "package.json");
-    let pkgVersion = "";
     if (fs.existsSync(pkgPath)) {
       const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+      pkg.name = directoryName; // Set project name
       pkg.packageManager = `${packageManager}@${version}`;
-      pkgVersion = pkg.version || "";
       fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
     }
+    spinner.succeed("package.json updated.");
 
-    spinner.succeed();
-    log.success(`DocuBook v${pkgVersion} using "${packageManager}"`);
+    log.success(`DocuBook project ready to go!`);
 
-    if (!installNow) {
+    if (installNow) {
+      await installDependencies(directoryName, packageManager, projectPath);
+      await simulateInstallation();
+      displayNextSteps(directoryName, packageManager);
+    } else {
       displayManualSteps(directoryName, packageManager);
-      return;
     }
-
-    await installDependencies(directoryName, packageManager, projectPath);
   } catch (err) {
     spinner.fail("Failed to create project.");
-    log.error(err.message);
+    // Cleanup created directory on failure
+    if (fs.existsSync(projectPath)) {
+      fs.rmSync(projectPath, { recursive: true, force: true });
+    }
     throw err;
   }
 }
 
 /**
- * Recursively copies a directory
- * @param {string} source - Source directory path
- * @param {string} destination - Destination directory path
+ * Recursively copies a directory.
+ * @param {string} source - Source directory path.
+ * @param {string} destination - Destination directory path.
  */
 function copyDirectoryRecursive(source, destination) {
-  // Create destination directory if it doesn't exist
   if (!fs.existsSync(destination)) {
     fs.mkdirSync(destination, { recursive: true });
   }
 
-  // Read source directory contents
   const entries = fs.readdirSync(source, { withFileTypes: true });
-
-  // Process each entry
   for (const entry of entries) {
     const srcPath = path.join(source, entry.name);
     const destPath = path.join(destination, entry.name);
 
-    // If entry is a directory, recursively copy it
     if (entry.isDirectory()) {
       copyDirectoryRecursive(srcPath, destPath);
     } else {
-      // Otherwise, copy the file
       fs.copyFileSync(srcPath, destPath);
     }
   }
 }
 
 /**
- * Installs project dependencies
- * @param {string} directoryName - Project directory name
- * @param {string} packageManager - Package manager to use
- * @param {string} projectPath - Path to the project directory
- * @returns {Promise<void>}
+ * Installs project dependencies.
+ * @param {string} directoryName - Project directory name.
+ * @param {string} packageManager - Package manager to use.
+ * @param {string} projectPath - Path to the project directory.
  */
 async function installDependencies(directoryName, packageManager, projectPath) {
   log.info("Installing dependencies...");
-  console.log(chalk.yellow("This is a joke for you:"));
-  console.log(
-    chalk.white(
-      "You don't need to worry about this process not running, you just need the latest device for a faster installation process."
-    )
-  );
-
-  const installSpinner = ora(`Using ${packageManager}...`).start();
+  const installSpinner = ora(`Running ${chalk.cyan(`${packageManager} install`)}...`).start();
 
   try {
     execSync(`${packageManager} install`, { cwd: projectPath, stdio: "ignore" });
-    installSpinner.succeed("Dependencies installed.");
-
-    await simulateInstallation();
-    displayNextSteps(directoryName, packageManager);
+    installSpinner.succeed("Dependencies installed successfully.");
   } catch (error) {
     installSpinner.fail("Failed to install dependencies.");
     displayManualSteps(directoryName, packageManager);
-    throw new Error("Failed to install dependencies");
+    throw new Error("Dependency installation failed.");
   }
-}
+}

package/src/utils/display.js

@@ -1,83 +1,84 @@
 import chalk from "chalk";
-import figlet from "figlet";
 import boxen from "boxen";
 import cliProgress from "cli-progress";
 
 /**
- * Displays ASCII art "DocuBook" when CLI is launched
- * @returns {Promise} Promise that resolves when ASCII art is displayed
+ * Displays an introduction message for the CLI.
  */
-export function displayAsciiArt() {
-  return new Promise((resolve, reject) => {
-    figlet.text("DocuBook", { horizontalLayout: "full" }, (err, data) => {
-      if (err) return reject(err);
-      console.log(chalk.green(data));
-      resolve();
-    });
-  });
+export function displayIntro() {
+  console.log(`\n${chalk.bold.green("🚀 DocuBook Installer")}\n`);
 }
 
 /**
- * Displays a progress bar to simulate final setup
- * @returns {Promise} Promise that resolves when simulation completes
+ * 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.green('{bar}') + '| {percentage}% || {value}/{total}',
-      barCompleteChar: '\u2588',
-      barIncompleteChar: '\u2591',
+      format: `Finishing setup... ${chalk.cyan("{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, 50));
+    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
- * @param {string} projectDirectory - Project directory name
- * @param {string} packageManager - Package manager being used
+ * Displays manual installation steps if automatic installation fails.
+ * @param {string} projectDirectory - Project directory name.
+ * @param {string} packageManager - Package manager being used.
  */
 export function displayManualSteps(projectDirectory, packageManager) {
-  const manualInstructions = `
-  Please follow these steps manually to finish setting up your project:
+  const steps = `
+  ${chalk.yellow("Automatic installation failed.")} Please finish setup manually:
 
   1. ${chalk.cyan(`cd ${projectDirectory}`)}
   2. ${chalk.cyan(`${packageManager} install`)}
   3. ${chalk.cyan(`${packageManager} run dev`)}
   `;
-
   console.log(
-    boxen(manualInstructions, {
-      padding: 0.5,
+    boxen(steps, {
+      padding: 1,
+      margin: 1,
       borderStyle: "round",
-      borderColor: "cyan",
+      borderColor: "yellow",
+      title: "Manual Setup Required",
+      titleAlignment: "center",
     })
   );
 }
 
 /**
- * Displays next steps after successful installation
- * @param {string} directoryName - Project directory name
- * @param {string} packageManager - Package manager being used
+ * 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.cyan(`cd ${directoryName}`)}
+  2. ${chalk.cyan(`${packageManager} run dev`)}
+  `;
+
   console.log(
-    boxen(
-      `Next Steps:\n\n` +
-        `1. ${chalk.cyan(`cd ${directoryName}`)}\n` +
-        `2. ${chalk.cyan(`${packageManager} run dev`)}`,
-      {
-        padding: 0.5,
-        borderStyle: "round",
-        borderColor: "cyan",
-      }
-    )
+    boxen(steps, {
+      padding: 1,
+      margin: 1,
+      borderStyle: "round",
+      borderColor: "green",
+      title: "Success!",
+      titleAlignment: "center",
+    })
   );
-}
+}

package/src/utils/logger.js

@@ -1,11 +1,10 @@
 import chalk from "chalk";
 
-// Logging helper with styles
 const log = {
-  info: (msg) => console.log(chalk.cyan("! " + msg)),
-  success: (msg) => console.log(chalk.green("✔ " + msg)),
-  warn: (msg) => console.log(chalk.yellow("⚠️  " + msg)),
-  error: (msg) => console.log(chalk.red("x " + msg)),
+  info: (msg) => console.log(`${chalk.blue("ℹ")} ${msg}`),
+  success: (msg) => console.log(`${chalk.green("✔")} ${msg}`),
+  warn: (msg) => console.log(`${chalk.yellow("⚠")} ${msg}`),
+  error: (msg) => console.log(`\n${chalk.red("✖")} ${chalk.bold(msg)}\n`),
 };
 
-export default log;
+export default log;

package/src/utils/packageManager.js

@@ -51,4 +51,4 @@ export function configurePackageManager(packageManager, projectPath) {
     const yarnrcPath = path.join(projectPath, ".yarnrc.yml");
     fs.writeFileSync(yarnrcPath, "nodeLinker: node-modules\n");
   }
-}
+}