@portosaur/cli 0.1.5 → 0.3.0

package/bin/porto.mjs

@@ -57,8 +57,9 @@ program
   .action(buildCommand);
 
 program
-  .command("serve [siteDir]")
+  .command("serve [siteDir] [extraArgs...]")
   .description("Serve the built static site locally")
+  .allowUnknownOption()
   .action(serveCommand);
 
 program

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portosaur/cli",
-  "version": "0.1.5",
+  "version": "0.3.0",
   "description": "CLI for Portosaur - The static Personal portfolio site generator.",
   "license": "GPL-3.0-only",
   "author": "soymadip",
@@ -16,7 +16,7 @@
   ],
   "type": "module",
   "bin": {
-    "porto": "./bin/porto.mjs"
+    "porto": "bin/porto.mjs"
   },
   "exports": {
     ".": {
@@ -26,9 +26,9 @@
   },
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@portosaur/core": "^0.1.5",
-    "@portosaur/logger": "^0.1.5",
-    "@portosaur/wizard": "^0.1.5",
+    "@portosaur/core": "^0.3.0",
+    "@portosaur/logger": "^0.3.0",
+    "@portosaur/wizard": "^0.3.0",
     "commander": "^13.1.0",
     "js-yaml": "^4.1.1"
   }

package/src/commands/build.mjs

@@ -12,6 +12,7 @@ import {
   loadUserConfig,
   generateFavicons,
   generateRobotsTxt,
+  getCssVar,
 } from "@portosaur/core";
 
 /**
@@ -50,11 +51,21 @@ export async function buildCommand(siteDir, extraArgs = []) {
 
     logger.info("Generating site assets...");
 
+    const cssFilesToParse = [
+      path.join(portoPaths.theme, "css/custom.css"),
+      path.join(portoPaths.theme, "css/overrides/variables.css"),
+    ];
+
+    const themeColor =
+      getCssVar("--ifm-color-primary", cssFilesToParse) || "#3578e5";
+
     const faviconRes = await generateFavicons(UserRoot, {
       imagePath: userConfig.home_page?.hero?.profile_pic,
       siteTitle: userConfig.site?.title,
       siteTagline: userConfig.site?.tagline,
       staticDirs: ["static"],
+      portoAssetsDir: portoPaths.assets,
+      themeColor: themeColor,
     });
 
     const configPath = writeConfigShim(UserRoot, portoPaths, {

package/src/commands/dev.mjs

@@ -41,9 +41,14 @@ export async function devCommand(siteDir, extraArgs = []) {
       const watcher = fs.watch(configYamlPath, (eventType) => {
         if (eventType === "change") {
           logger.info(`Detected change in ${configYaml}, reloading...`);
-          // Touch the shim config to trigger Docusaurus reload
-          const now = new Date();
-          fs.utimesSync(configPath, now, now);
+
+          // Regenerate the static config shim with the updated values,
+          // which triggers Docusaurus' own file watcher to hot-reload.
+          try {
+            writeConfigShim(UserRoot, portoPaths);
+          } catch (err) {
+            logger.warn(`Failed to regenerate config: ${err.message}`);
+          }
         }
       });
 

package/src/commands/init.mjs

@@ -384,9 +384,7 @@ export async function initCommand(options = {}) {
   // to the CLI package to avoid loose dev-mode predictions.
   const isTestProject = looksLikeTestProject(state.projectName);
 
-  const portoVer = isTestProject
-    ? "link:@portosaur/cli"
-    : porto.version || "0.0.0";
+  const portoVer = isTestProject ? "*" : `^${porto.version || "0.0.0"}`;
 
   const templateVars = {
     projectName: state.projectName,

package/src/commands/serve.mjs

@@ -1,27 +1,42 @@
 import path from "path";
-import { runDocusaurus, validateProject } from "../utils/index.mjs";
+import {
+  runDocusaurus,
+  validateProject,
+  Paths,
+  writeConfigShim,
+} from "../utils/index.mjs";
 import { logger } from "@portosaur/logger";
 
 /**
  * Serves the built Portosaur site locally.
- *
- * Note: Docusaurus 'serve' doesn't require a config shim,
- * as it serves the already built static files from the output directory.
  */
 export async function serveCommand(siteDir, extraArgs = []) {
   const UserRoot = siteDir
     ? path.resolve(process.cwd(), siteDir)
     : process.cwd();
 
+  // Ensure extraArgs is always an array (in case options object is passed)
+  const argsArray = Array.isArray(extraArgs) ? extraArgs : [];
+
   // ------- Setup -------
 
   validateProject(UserRoot);
 
+  const portoPaths = {
+    root: Paths.root,
+    assets: path.join(Paths.theme, "assets"),
+    theme: path.join(Paths.theme, "theme"),
+    plugins: path.join(Paths.theme, "src/plugins"),
+  };
+
   try {
     logger.info("Serving built site...");
 
+    // Generate config shim so Docusaurus can locate site configuration
+    const configPath = writeConfigShim(UserRoot, portoPaths);
+
     // Docusaurus serve looks for the 'build' directory by default.
-    await runDocusaurus("serve", UserRoot, "", extraArgs);
+    await runDocusaurus("serve", UserRoot, configPath, argsArray);
   } catch (error) {
     logger.error(`Failed to serve site: ${error.message}`);
     process.exit(1);

package/src/index.d.ts

@@ -41,7 +41,7 @@ export function buildCommand(siteDir?: string, extraArgs?: string[]): void;
 /**
  * Serves the built static site locally.
  */
-export function serveCommand(siteDir?: string): void;
+export function serveCommand(siteDir?: string, extraArgs?: string[]): void;
 
 /**
  * Generates the config schema.

package/src/templates/config.yml

@@ -8,8 +8,8 @@ site:
   title: "{{fullName}}"
   tagline: "Short description about you, your passion, your goals etc."
 
-  favicon: "{{portoRoot}}/src/assets/img/svg/icon.svg"
-  social_card: "{{portoRoot}}/src/assets/img/social-card.jpeg"
+  favicon: "{{portoRoot}}/assets/img/svg/icon.svg"
+  social_card: "{{portoRoot}}/assets/img/social-card.jpeg"
 
   # Auto set if deploying in Github/GitLab Pages
   url: "auto"
@@ -55,7 +55,7 @@ home_page:
       - "skill 1"
       - "skill 2"
       - "skill 3"
-    resume: "{{portoRoot}}/src/assets/sample-resume.pdf"
+    resume: "{{portoRoot}}/assets/sample-resume.pdf"
 
   project_shelf:
     enable: true
@@ -69,7 +69,7 @@ home_page:
         repo: "https://github.com/yourname/project1"
 
       - title: "Your Awesome Project 2"
-        icon: "{{portoRoot}}/src/assets/img/svg/icon.svg"
+        icon: "{{portoRoot}}/assets/img/svg/icon.svg"
         bg: "#5c8f2d"
         tags: ["tag1", "tag2", "tag3", "tag4", "tag5", "tag6", "tag7"]
         featured: true

package/src/templates/gitignore

@@ -1,4 +1,4 @@
-# gitignore, init time renamed
+# gitignore, init time generated
 
 node_modules/
 .docusaurus/

package/src/templates/package.json

@@ -9,7 +9,7 @@
     "serve": "porto serve"
   },
   "dependencies": {
-    "@portosaur/cli": "^{{portoVer}}",
-    "@portosaur/theme": "^{{portoVer}}"
+    "@portosaur/cli": "{{portoVer}}",
+    "@portosaur/theme": "{{portoVer}}"
   }
 }

package/src/utils/paths.mjs

@@ -1,6 +1,10 @@
 import fs from "node:fs";
 import path from "node:path";
 
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+
 const srcDir = path.resolve(import.meta.dirname, "../");
 const pkgDir = path.resolve(srcDir, "../");
 
@@ -27,17 +31,20 @@ export const Paths = {
   packageJson: path.join(pkgDir, "package.json"),
 
   /** Absolute path to the core package. */
-  core: path.resolve(pkgDir, "../core"),
+  get core() {
+    try {
+      return path.dirname(require.resolve("@portosaur/core/package.json"));
+    } catch {
+      return path.resolve(pkgDir, "../core");
+    }
+  },
 
   /** Absolute path to the theme package. */
   get theme() {
-    const localNodeModulesTheme = path.resolve(
-      process.cwd(),
-      "node_modules/@portosaur/theme",
-    );
-    if (fs.existsSync(localNodeModulesTheme)) {
-      return localNodeModulesTheme;
+    try {
+      return path.dirname(require.resolve("@portosaur/theme/package.json"));
+    } catch {
+      return path.resolve(pkgDir, "../theme");
     }
-    return path.resolve(pkgDir, "../theme");
   },
 };

package/src/utils/runner.mjs

@@ -1,13 +1,18 @@
 import fs from "fs";
 import path from "path";
 import { spawn } from "child_process";
+import { createRequire } from "module";
+import { loadUserConfig, buildDocuConfig } from "@portosaur/core";
 
 /**
- * Generates a Docusaurus config shim that loads Portosaur logic.
+ * Generates a static Docusaurus config file by evaluating the Portosaur config
+ * at CLI time and serializing the result. This avoids importing @portosaur/core
+ * inside Docusaurus' own build/serve runtime.
+ *
  * @param {string} UserRoot - The user's project directory.
- * @param {Object} portoPaths - Paths to Portosaur assets and core.
+ * @param {Object} portoPaths - Paths to Portosaur assets and theme.
  * @param {Object} [context={}] - Additional context for config generation.
- * @returns {string} The path to the generated shim file.
+ * @returns {string} The path to the generated config file.
  */
 export function writeConfigShim(UserRoot, portoPaths, context = {}) {
   const dotDir = path.join(UserRoot, ".docusaurus", "portosaur");
@@ -16,35 +21,19 @@ export function writeConfigShim(UserRoot, portoPaths, context = {}) {
     fs.mkdirSync(dotDir, { recursive: true });
   }
 
-  // Resolve config file
-  const configYaml = ["config.yaml", "config.yml"].find((file) =>
-    fs.existsSync(path.join(UserRoot, file)),
-  );
-  if (!configYaml) throw new Error("config.yml not found");
-
-  const configYamlAbsolute = path
-    .resolve(UserRoot, configYaml)
-    .replace(/\\/g, "/");
-
-  // Prepare shim template
-  const shimContent = `// Auto-generated by portosaur
-import fs from "fs";
-import yaml from "js-yaml";
-
-export default async function getConfig() {
-  const { buildDocuConfig } = await import("@portosaur/core");
-  const yamlContent = fs.readFileSync("${configYamlAbsolute}", "utf8");
-  const rawConf = yaml.load(yamlContent);
+  // Load the user's YAML config and evaluate the full Docusaurus config object now.
+  const rawConf = loadUserConfig(UserRoot);
 
-  return buildDocuConfig(rawConf, "${UserRoot.replace(/\\/g, "/")}", {
-    portoPaths: ${JSON.stringify(portoPaths)},
-    portoRoot: "${path.resolve(portoPaths.root).replace(/\\/g, "/")}",
-    ...${JSON.stringify(context)}
+  const docuConfig = buildDocuConfig(rawConf, UserRoot, {
+    portoPaths,
+    portoRoot: path.resolve(portoPaths.root),
+    ...context,
   });
-}
-`;
 
-  // Write and return shim path
+  // Serialize the config as a static export so Docusaurus never needs to
+  // dynamically import @portosaur/core during its own build or serve run.
+  const shimContent = `// Auto-generated by portosaur — do not edit\nexport default ${JSON.stringify(docuConfig, null, 2)};\n`;
+
   const shimPath = path.join(dotDir, "docusaurus.config.js");
   fs.writeFileSync(shimPath, shimContent);
 
@@ -155,27 +144,60 @@ export async function runDocusaurus(
   configPath,
   extraArgs = [],
 ) {
-  const args = [
-    "run",
-    "--bun",
-    "docusaurus",
-    command,
-    UserRoot,
-    "--config",
-    configPath,
-    ...extraArgs,
-  ];
+  const isBun =
+    typeof process !== "undefined" &&
+    process.versions &&
+    process.versions.bun !== undefined;
+
+  let bin;
+  let args;
+
+  if (isBun) {
+    bin = "bun";
+    args = ["run", "--bun", "docusaurus", command, UserRoot];
+  } else {
+    bin = "node";
+    let docusaurusBin;
+    try {
+      const require = createRequire(import.meta.url);
+      docusaurusBin = require.resolve("docusaurus/bin/docusaurus.mjs", {
+        paths: [UserRoot],
+      });
+    } catch (e) {
+      docusaurusBin = path.join(
+        UserRoot,
+        "node_modules",
+        "docusaurus",
+        "bin",
+        "docusaurus.mjs",
+      );
+    }
+    args = [docusaurusBin, command, UserRoot];
+  }
+
+  if (configPath) {
+    args.push("--config", configPath);
+  }
+
+  args.push(...extraArgs);
 
   // Skip actual execution in test mode
   if (process.env.PORTO_TEST_MODE === "true") {
-    console.log(`[TEST_MODE] Would run docusaurus ${command} in ${UserRoot}`);
+    console.log(
+      `[TEST_MODE] Would run docusaurus ${command} in ${UserRoot} using ${bin}`,
+    );
     return Promise.resolve();
   }
 
-  const child = spawn("bun", args, {
+  const childEnv = { ...process.env, FORCE_COLOR: "true" };
+  if (command === "build") {
+    childEnv.CI = "true";
+  }
+
+  const child = spawn(bin, args, {
     stdio: "inherit",
     cwd: UserRoot,
-    env: { ...process.env, FORCE_COLOR: "true" },
+    env: childEnv,
   });
 
   return new Promise((resolve, reject) => {

package/src/templates/notes/index.mdx

@@ -1,9 +0,0 @@
----
-hide_table_of_contents: true
----
-
-import NoteCards from "portosaur/src/theme/components/NoteIndex/index.js";
-
-# Notes
-
-<NoteCards />