portosaurus 2.0.2 → 2.1.0

package/bin/portosaurus.mjs

@@ -4,20 +4,17 @@ import { Command } from "commander";
 import fs from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
-import { spawn, execSync } from "child_process";
 
-import { logger } from "../src/core/logger.mjs";
-import {
-  detectPackageManager,
-  getInstallCommand,
-  findDocusaurusBin,
-} from "../src/core/packageManager.mjs";
+import { initCommand } from "../src/cli/init.mjs";
+import { devCommand } from "../src/cli/dev.mjs";
+import { buildCommand } from "../src/cli/build.mjs";
+import { serveCommand } from "../src/cli/serve.mjs";
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const portosaurusRoot = path.resolve(__dirname, "..");
+const PortoRoot = path.resolve(__dirname, "..");
 
 const packageJson = JSON.parse(
-  fs.readFileSync(path.resolve(portosaurusRoot, "package.json"), "utf8"),
+  fs.readFileSync(path.resolve(PortoRoot, "package.json"), "utf8"),
 );
 
 const program = new Command();
@@ -27,116 +24,7 @@ program
   .description("CLI for Portosaurus — The complete portfolio solution")
   .version(packageJson.version, "-v, --version", "output the current version");
 
-// ─── Helpers ────────────────────────────────────────────────
-
-/**
- * Write the ephemeral .portosaurus/docusaurus.config.mjs shim.
- * This tiny file imports the user's config.js and passes it
- * to the portosaurus config generator using absolute paths.
- */
-function writeConfigShim(projectRoot) {
-  const dotDir = path.join(projectRoot, ".docusaurus", "portosaurus");
-  fs.mkdirSync(dotDir, { recursive: true });
-
-  const configJsAbsolute = path
-    .join(projectRoot, "config.js")
-    .replace(/\\/g, "/");
-  const createDocuConfAbsolute = path
-    .resolve(portosaurusRoot, "src/core/createDocuConf.mjs")
-    .replace(/\\/g, "/");
-
-  // Docusaurus 3 supports ESM and async config functions.
-  const shimContent = `// Auto-generated by Portosaurus CLI — do not edit
-/** @type {import('@docusaurus/types').Config} */
-export default async function getConfig() {
-  const { createDocuConf } = await import("file://${createDocuConfAbsolute}");
-  const { usrConf } = await import("file://${configJsAbsolute}");
-  return createDocuConf(usrConf, "${projectRoot.replace(/\\/g, "/")}");
-}
-`;
-
-  const shimPath = path.join(dotDir, "docusaurus.config.js");
-  fs.writeFileSync(shimPath, shimContent);
-  logger.debug(`Config shim written to ${shimPath}`);
-
-  return shimPath;
-}
-
-/**
- * Validate that the current directory is a Portosaurus project.
- */
-function validateProject(projectRoot) {
-  const configPath = path.join(projectRoot, "config.js");
-  if (!fs.existsSync(configPath)) {
-    console.log();
-    logger.error(
-      "config.js not found. Are you in a Portosaurus project directory?",
-    );
-    process.exit(1);
-  }
-}
-
-/**
- * Ensure essential user content directories exist.
- */
-function ensureContentDirs(projectRoot) {
-  for (const dir of ["notes", "blog", "static"]) {
-    fs.mkdirSync(path.join(projectRoot, dir), { recursive: true });
-  }
-
-  // Ensure notes has at least an index.mdx so Docusaurus doesn't error
-  const notesIndex = path.join(projectRoot, "notes", "index.mdx");
-  if (!fs.existsSync(notesIndex)) {
-    fs.writeFileSync(
-      notesIndex,
-      `---\nhide_table_of_contents: true\n---\n\nimport NoteCards from "portosaurus/src/components/NoteIndex/index.js";\n\n# Notes\n\n<NoteCards />\n`,
-    );
-    logger.debug("Created default notes/index.mdx");
-  }
-}
-
-/**
- * Spawn a Docusaurus command and wait for it to complete.
- */
-function runDocusaurus(command, extraArgs, projectRoot, configPath) {
-  const {
-    command: cmd,
-    args: pmArgs,
-    packageManager,
-  } = findDocusaurusBin(projectRoot);
-
-  logger.info(`Running docusaurus ${command} (via ${packageManager})`);
-
-  // Use the dynamically detected package manager command instead of hardcoding
-  const spawnCommand = cmd;
-  const finalArgs = [
-    ...pmArgs,
-    command,
-    projectRoot,
-    "--config",
-    configPath,
-    ...extraArgs,
-  ];
-
-  const child = spawn(spawnCommand, finalArgs, {
-    stdio: "inherit",
-    cwd: projectRoot,
-    env: { ...process.env, FORCE_COLOR: "true" },
-  });
-
-  return new Promise((resolve, reject) => {
-    child.on("error", (err) => {
-      logger.error(`Failed to run docusaurus ${command}: ${err.message}`);
-      reject(err);
-    });
-    child.on("close", (code) => {
-      if (code === 0) resolve();
-      else process.exit(code);
-    });
-  });
-}
-
-// ─── INIT COMMAND ───────────────────────────────────────────
+// ─── COMMANDS ───────────────────────────────────────────────
 
 program
   .command("init")
@@ -144,225 +32,24 @@ program
   .argument("<project-name>", "Name of the project directory")
   .option("--no-install", "Skip dependency installation")
   .option("--no-github-pages", "Skip GitHub Pages deployment setup")
-  .action(async (projectName, options) => {
-    const projectPath = path.resolve(process.cwd(), projectName);
-
-    if (fs.existsSync(projectPath)) {
-      logger.error(`Directory "${projectName}" already exists.`);
-      process.exit(1);
-    }
-
-    logger.info(`Creating new Portosaurus project in ${projectName}...`);
-
-    try {
-      fs.mkdirSync(projectPath, { recursive: true });
-
-      // Copy template files if they exist
-      const templatePath = path.resolve(portosaurusRoot, "src/template");
-      if (fs.existsSync(templatePath)) {
-        copyDirSync(templatePath, projectPath);
-      }
-
-      // Ensure content directories
-      for (const dir of ["blog", "notes", "static"]) {
-        fs.mkdirSync(path.join(projectPath, dir), { recursive: true });
-      }
-
-      // Create a minimal config.js if the template didn't provide one
-      const configDest = path.join(projectPath, "config.js");
-      if (!fs.existsSync(configDest)) {
-        fs.writeFileSync(
-          configDest,
-          `exports.usrConf = {\n  dark_mode: true,\n  site_url: "auto",\n  site_path: "auto",\n\n  hero_section: {\n    title: "${projectName}",\n    profession: "Your Profession",\n    description: "Short description about you.",\n  },\n};\n`,
-        );
-      }
-
-      // Create package.json
-      const pkg = {
-        name: projectName,
-        version: "0.0.1",
-        private: true,
-        scripts: {
-          dev: "portosaurus dev",
-          start: "portosaurus start",
-          build: "portosaurus build",
-          serve: "portosaurus serve",
-        },
-        dependencies: {
-          portosaurus: `^${packageJson.version}`,
-        },
-        overrides: {
-          webpack: "5.105.4",
-        },
-        resolutions: {
-          webpack: "5.105.4",
-        },
-      };
-      fs.writeFileSync(
-        path.join(projectPath, "package.json"),
-        JSON.stringify(pkg, null, 2),
-      );
-
-      // Create .gitignore
-      fs.writeFileSync(
-        path.join(projectPath, ".gitignore"),
-        `node_modules/\nbuild/\n.docusaurus/\n.cache-loader/\n`,
-      );
-
-      // Git init
-      try {
-        execSync("git init", { cwd: projectPath, stdio: "ignore" });
-        execSync("git add .", { cwd: projectPath, stdio: "ignore" });
-        execSync('git commit -m "Initialize Portosaurus project"', {
-          cwd: projectPath,
-          stdio: "ignore",
-        });
-      } catch {
-        logger.warn("Failed to initialize git repository.");
-      }
-
-      // GitHub Pages setup
-      if (options.githubPages === false) {
-        const ghDir = path.join(projectPath, ".github");
-        if (fs.existsSync(ghDir)) {
-          fs.rmSync(ghDir, { recursive: true, force: true });
-          logger.info("Skipped GitHub Pages setup.");
-        }
-      } else {
-        fs.writeFileSync(path.join(projectPath, "static", ".nojekyll"), "");
-        logger.success("GitHub Pages deployment configured.");
-        logger.tip(
-          "Enable GitHub Pages: Settings > Pages > Source: GitHub Actions",
-        );
-      }
-
-      logger.success(`Created ${projectName} at ${projectPath}`);
-
-      // Install dependencies
-      const pm = detectPackageManager(projectPath) || "npm";
-      const installCmd = getInstallCommand(pm);
-      const runCmd = pm === "npm" ? "npm run" : `${pm} run`;
-
-      if (options.install !== false) {
-        logger.info(`Running ${installCmd}...`);
-        try {
-          execSync(installCmd, { cwd: projectPath, stdio: "inherit" });
-          logger.success("Dependencies installed!");
-        } catch {
-          logger.error("Failed to install dependencies.");
-        }
-      }
-
-      logger.tip("You can now run:");
-      logger.info(`  cd ${projectName}`);
-      logger.info(`  ${runCmd} dev`);
-    } catch (error) {
-      logger.error(`Failed to initialize project: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// ─── DEV / START COMMAND ────────────────────────────────────
+  .action(initCommand);
 
 program
-  .command("start [extraArgs...]")
+  .command("start [siteDir] [extraArgs...]")
   .alias("dev")
   .description("Start the development server")
   .allowUnknownOption()
-  .action(async function (extraArgs) {
-    const projectRoot = process.cwd();
-    validateProject(projectRoot);
-    ensureContentDirs(projectRoot);
-
-    logger.info("Starting development server...");
-    try {
-      const configPath = writeConfigShim(projectRoot);
-      runDocusaurus("start", extraArgs || [], projectRoot, configPath);
-    } catch (error) {
-      logger.error(`Failed to start: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// ─── BUILD COMMAND ──────────────────────────────────────────
+  .action(devCommand);
 
 program
-  .command("build [extraArgs...]")
+  .command("build [siteDir] [extraArgs...]")
   .description("Build the static site")
   .allowUnknownOption()
-  .action(async function (extraArgs) {
-    const projectRoot = process.cwd();
-    validateProject(projectRoot);
-    ensureContentDirs(projectRoot);
-
-    logger.info("Building Portosaurus site...");
-    try {
-      const configPath = writeConfigShim(projectRoot);
-      const buildDir = path.join(projectRoot, "build");
-      const args = ["--out-dir", buildDir, ...(extraArgs || [])];
-
-      await runDocusaurus("build", args, projectRoot, configPath);
-
-      // Create .nojekyll for GitHub Pages compatibility
-      if (fs.existsSync(buildDir)) {
-        fs.writeFileSync(path.join(buildDir, ".nojekyll"), "");
-        logger.info("Created .nojekyll");
-      }
-
-      logger.success("Build completed successfully!");
-      logger.info(`Output directory: ${buildDir}`);
-    } catch (error) {
-      logger.error(`Failed to build: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// ─── SERVE COMMAND ──────────────────────────────────────────
+  .action(buildCommand);
 
 program
-  .command("serve")
+  .command("serve [siteDir]")
   .description("Serve the built static site locally")
-  .action(async () => {
-    const projectRoot = process.cwd();
-    validateProject(projectRoot);
-
-    const buildDir = path.join(projectRoot, "build");
-    if (!fs.existsSync(buildDir)) {
-      logger.error("Build directory not found. Run 'portosaurus build' first.");
-      process.exit(1);
-    }
-
-    logger.info("Serving Portosaurus site...");
-    try {
-      const configPath = writeConfigShim(projectRoot);
-      await runDocusaurus(
-        "serve",
-        ["--dir", buildDir],
-        projectRoot,
-        configPath,
-      );
-    } catch (error) {
-      logger.error(`Failed to serve: ${error.message}`);
-      process.exit(1);
-    }
-  });
-
-// ─── Utility ────────────────────────────────────────────────
-
-/**
- * Recursively copy a directory.
- */
-function copyDirSync(src, dest) {
-  fs.mkdirSync(dest, { recursive: true });
-  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-    if (entry.isDirectory()) {
-      copyDirSync(srcPath, destPath);
-    } else {
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-}
+  .action(serveCommand);
 
 program.parse();

package/package.json

@@ -1,25 +1,28 @@
 {
   "name": "portosaurus",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "private": false,
+  "homepage": "https://github.com/soymadip/portosaurus",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/soymadip/portosaurus.git"
+  },
   "bin": {
     "portosaurus": "bin/portosaurus.mjs"
   },
   "files": [
     "bin/",
-    "src/components/",
-    "src/config/",
+    "src/assets/",
+    "src/cli/",
     "src/core/",
-    "src/css/",
-    "src/pages/",
     "src/theme/",
-    "src/template/",
-    "src/assets/"
+    "src/utils/",
+    "src/template/"
   ],
   "scripts": {
-    "dev": "$npm_execpath bin/portosaurus.mjs dev",
-    "build": "$npm_execpath bin/portosaurus.mjs build",
-    "serve": "$npm_execpath bin/portosaurus.mjs serve"
+    "test": "bun test",
+    "lint": "prettier --check .",
+    "format": "prettier --write ."
   },
   "dependencies": {
     "@docusaurus/core": "^3.10.0",
@@ -29,6 +32,7 @@
     "chalk": "^5.4.1",
     "clsx": "^2.1.1",
     "commander": "^13.1.0",
+    "consola": "^3.4.2",
     "favicons": "7.2.0",
     "framer-motion": "^12.38.0",
     "plugin-image-zoom": "github:flexanalytics/plugin-image-zoom",
@@ -44,7 +48,8 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "^3.10.0",
-    "@docusaurus/types": "^3.10.0"
+    "@docusaurus/types": "^3.10.0",
+    "prettier": "^3.8.3"
   },
   "browserslist": {
     "production": [

package/src/cli/build.mjs

@@ -0,0 +1,43 @@
+import path from "path";
+import fs from "fs";
+import { logger } from "../utils/logger.mjs";
+import {
+  validateProject,
+  ensureContentDirs,
+  writePortoConfigShim,
+  runDocusaurus,
+  PortoRoot,
+} from "../utils/helpers.mjs";
+
+export async function buildCommand(siteDir, extraArgs) {
+  const UserRoot = siteDir
+    ? path.resolve(process.cwd(), siteDir)
+    : process.cwd();
+  validateProject(UserRoot);
+  ensureContentDirs(UserRoot);
+
+  const packageJsonPath = path.resolve(PortoRoot, "package.json");
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+
+  logger.box("Portosaurus Build", `v${packageJson.version}`);
+  logger.info("Building Portosaurus site...");
+  try {
+    const configPath = writePortoConfigShim(UserRoot);
+    const buildDir = path.join(UserRoot, "build");
+    const args = ["--out-dir", buildDir, ...(extraArgs || [])];
+
+    await runDocusaurus("build", args, UserRoot, configPath);
+
+    // Create .nojekyll for GitHub Pages compatibility
+    if (fs.existsSync(buildDir)) {
+      fs.writeFileSync(path.join(buildDir, ".nojekyll"), "");
+      logger.info("Created .nojekyll");
+    }
+
+    logger.success("Build completed successfully!");
+    logger.info(`Output directory: ${buildDir}`);
+  } catch (error) {
+    logger.error(`Failed to build: ${error.message}`);
+    process.exit(1);
+  }
+}

package/src/cli/dev.mjs

@@ -0,0 +1,31 @@
+import path from "path";
+import fs from "fs";
+import { logger } from "../utils/logger.mjs";
+import {
+  validateProject,
+  ensureContentDirs,
+  writePortoConfigShim,
+  runDocusaurus,
+  PortoRoot,
+} from "../utils/helpers.mjs";
+
+export async function devCommand(siteDir, extraArgs) {
+  const UserRoot = siteDir
+    ? path.resolve(process.cwd(), siteDir)
+    : process.cwd();
+  validateProject(UserRoot);
+  ensureContentDirs(UserRoot);
+
+  const packageJsonPath = path.resolve(PortoRoot, "package.json");
+  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+
+  logger.box("Portosaurus Dev Server", `v${packageJson.version}`);
+  logger.info("Starting development server...");
+  try {
+    const configPath = writePortoConfigShim(UserRoot);
+    await runDocusaurus("start", extraArgs || [], UserRoot, configPath);
+  } catch (error) {
+    logger.error(`Failed to start: ${error.message}`);
+    process.exit(1);
+  }
+}

package/src/cli/init.mjs

@@ -0,0 +1,135 @@
+import fs from "fs";
+import path from "path";
+import { logger } from "../utils/logger.mjs";
+import { getPackageManager } from "../utils/packageManager.mjs";
+import { PortoRoot, mirrorSync } from "../utils/helpers.mjs";
+
+export async function initCommand(projectName, options) {
+  const projectDir = path.resolve(process.cwd(), projectName);
+  const templateDir = path.resolve(PortoRoot, "src/template");
+  const packageJson = JSON.parse(
+    fs.readFileSync(path.resolve(PortoRoot, "package.json"), "utf8"),
+  );
+
+  const TemplateVars = {
+    projectName: projectName,
+    portoVer: packageJson.version,
+    portoHome: packageJson.homepage,
+    portoRepo: packageJson.repository.url,
+  };
+
+  const ignoreList = [
+    "node_modules",
+    ".docusaurus",
+    ".cache-loader",
+    "build",
+    ".DS_Store",
+    ".git",
+  ];
+
+  const contentDirs = ["blog", "notes", "static"];
+
+  if (fs.existsSync(projectDir)) {
+    logger.error(`Target Directory "${projectName}" already exists.`);
+    process.exit(1);
+  }
+
+  logger.box(
+    "Initializing New Portosaurus Project",
+    ` v${packageJson.version} `,
+  );
+
+  logger.info(`Creating new project in ${projectName}...`);
+
+  try {
+    const { execSync } = await import("child_process");
+
+    // Create user project directory
+    fs.mkdirSync(projectDir, { recursive: true });
+
+    // Git Init
+    try {
+      execSync("git init", { cwd: projectDir, stdio: "ignore" });
+    } catch {
+      logger.warn("Failed to initialize git repository.");
+      process.exit(1);
+    }
+
+    // Make Content directories
+    for (const dir of contentDirs) {
+      fs.mkdirSync(path.join(projectDir, dir), { recursive: true });
+    }
+
+    // Copy template files, dirs
+    if (fs.existsSync(templateDir)) {
+      mirrorSync(templateDir, projectDir, TemplateVars, ignoreList);
+    } else {
+      logger.error(`Portosaurus template directory not found: ${templateDir}`);
+      process.exit(1);
+    }
+
+    // Initial Commit
+    try {
+      // Add all files to git
+      execSync("git add .", {
+        cwd: projectDir,
+        stdio: "ignore",
+      });
+
+      // Initial Commit
+      execSync('git commit -m "Initialize Portosaurus project"', {
+        cwd: projectDir,
+        stdio: "ignore",
+      });
+    } catch {
+      logger.warn(
+        "Failed to commit changes.\nPlease commit your changes manually.",
+      );
+    }
+
+    // GitHub Pages setup
+    if (options.githubPages === false) {
+      const ghDir = path.join(projectDir, ".github");
+
+      // Delete copied .github directory
+      if (fs.existsSync(ghDir)) {
+        fs.rmSync(ghDir, { recursive: true, force: true });
+        logger.info("Skipped GitHub Pages setup.");
+      }
+    } else {
+      logger.success("GitHub Pages deployment configured.");
+      logger.tip(
+        "Enable GitHub Pages in repo: Settings > Pages > Source: GitHub Actions",
+      );
+    }
+
+    logger.success(`Created ${projectName} at ${projectDir}`);
+
+    // Install dependencies
+    const pm = getPackageManager(projectDir);
+
+    logger.info(`Installing dependencies with ${pm.name}...`);
+
+    if (options.install !== false) {
+      logger.info(`Running ${pm.install}...`);
+      try {
+        const { execSync } = await import("child_process");
+        execSync(pm.install, { cwd: projectDir, stdio: "inherit" });
+        logger.success("Dependencies installed!");
+      } catch {
+        logger.error(
+          "Failed to install dependencies. You can run it manually later.",
+        );
+      }
+    }
+
+    logger.tip("You can now run:");
+    logger.info(`  cd ${projectName}`);
+    logger.info(`  ${pm.run} dev`);
+
+    // end
+  } catch (error) {
+    logger.error(`Failed to initialize project: ${error.message}`);
+    process.exit(1);
+  }
+}

package/src/cli/serve.mjs

@@ -0,0 +1,30 @@
+import path from "path";
+import fs from "fs";
+import { logger } from "../utils/logger.mjs";
+import {
+  validateProject,
+  writePortoConfigShim,
+  runDocusaurus,
+} from "../utils/helpers.mjs";
+
+export async function serveCommand(siteDir) {
+  const UserRoot = siteDir
+    ? path.resolve(process.cwd(), siteDir)
+    : process.cwd();
+  validateProject(UserRoot);
+
+  const buildDir = path.join(UserRoot, "build");
+  if (!fs.existsSync(buildDir)) {
+    logger.error("Build directory not found. Run 'portosaurus build' first.");
+    process.exit(1);
+  }
+
+  logger.info("Serving Portosaurus site...");
+  try {
+    const configPath = writePortoConfigShim(UserRoot);
+    await runDocusaurus("serve", ["--dir", buildDir], UserRoot, configPath);
+  } catch (error) {
+    logger.error(`Failed to serve: ${error.message}`);
+    process.exit(1);
+  }
+}