portosaurus 2.0.2 → 2.1.0

package/src/core/createDocuConf.mjs

@@ -1,490 +0,0 @@
-import fs from "fs";
-import path from "path";
-import { fileURLToPath } from "url";
-import { createRequire } from "module";
-
-import { defaults } from "./defaults.mjs";
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const portosaurusRoot = path.resolve(__dirname, "../../");
-
-// ─── Helpers ────────────────────────────────────────────────
-
-/**
- * Deep merge two objects. Source values override target values.
- * Arrays are replaced, not concatenated.
- */
-function deepMerge(target, source) {
-  const result = { ...target };
-  for (const key of Object.keys(source)) {
-    if (
-      source[key] &&
-      typeof source[key] === "object" &&
-      !Array.isArray(source[key]) &&
-      target[key] &&
-      typeof target[key] === "object" &&
-      !Array.isArray(target[key])
-    ) {
-      result[key] = deepMerge(target[key], source[key]);
-    } else if (source[key] !== undefined) {
-      result[key] = source[key];
-    }
-  }
-  return result;
-}
-
-/**
- * Resolve ${...} template references inside config string values.
- * Supports nested paths like ${hero_section.profile_pic}.
- */
-function resolveTemplateStrings(obj, rootConfig) {
-  if (typeof obj === "string") {
-    return obj.replace(/\$\{([^}]+)\}/g, (match, refPath) => {
-      const parts = refPath.split(".");
-      let val = rootConfig;
-      for (const p of parts) {
-        if (val == null || typeof val !== "object") return match;
-        val = val[p];
-      }
-      if (val === undefined) return match;
-      // Recurse in case the resolved value also has template refs
-      if (typeof val === "string" && val.includes("${")) {
-        return resolveTemplateStrings(val, rootConfig);
-      }
-      return val;
-    });
-  }
-  if (Array.isArray(obj)) {
-    return obj.map((item) => resolveTemplateStrings(item, rootConfig));
-  }
-  if (obj && typeof obj === "object") {
-    const result = {};
-    for (const [key, value] of Object.entries(obj)) {
-      result[key] = resolveTemplateStrings(value, rootConfig);
-    }
-    return result;
-  }
-  return obj;
-}
-
-/**
- * Resolves the site URL based on config value and environment.
- */
-function resolveSiteUrl(configValue) {
-  if (configValue === "auto") {
-    if (process.env.GITHUB_ACTIONS === "true") {
-      const repoOwner = process.env.GITHUB_REPOSITORY_OWNER;
-      return `https://${repoOwner}.github.io`;
-    }
-    return "http://localhost";
-  }
-  return configValue;
-}
-
-/**
- * Resolves the base path based on config value and environment.
- */
-function resolveBasePath(configValue) {
-  if (configValue === "auto") {
-    if (process.env.GITHUB_ACTIONS === "true") {
-      const repoName = process.env.GITHUB_REPOSITORY?.split("/")[1];
-      const repoOwner = process.env.GITHUB_REPOSITORY_OWNER;
-      return repoName === `${repoOwner}.github.io` ? "/" : `/${repoName}/`;
-    }
-    return "/";
-  }
-  return configValue;
-}
-
-/**
- * Read the portosaurus package version.
- */
-function getVersion() {
-  try {
-    const pkgPath = path.resolve(portosaurusRoot, "package.json");
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
-    return pkg.version || "0.0.0";
-  } catch {
-    return "0.0.0";
-  }
-}
-
-/**
- * Filter items that have enable/value conditional structure.
- */
-function useEnabled(items) {
-  if (!Array.isArray(items)) return [];
-  return items.flatMap((item) => {
-    if (
-      item &&
-      typeof item === "object" &&
-      "enable" in item &&
-      "value" in item
-    ) {
-      return item.enable === true ? [item.value] : [];
-    }
-    return [item];
-  });
-}
-
-// ─── Main Config Generator ─────────────────────────────────
-
-/**
- * Creates a Docusaurus config from a user's Portosaurus config.
- *
- * @param {Object} rawUserConfig - The user's config object (export of config.js).
- *                                 May be { usrConf: {...} } or just {...}.
- * @param {string} projectRoot   - Absolute path to the user's project root.
- * @returns {Object} Complete Docusaurus configuration object.
- */
-export function createDocuConf(rawUserConfig, projectRoot) {
-  // Support both { usrConf: {...} } and direct config objects
-  const rawConf = rawUserConfig.usrConf || rawUserConfig;
-
-  // Step 1: Deep merge user config over defaults
-  const merged = deepMerge(defaults, rawConf);
-
-  // Step 2: Resolve template strings (${hero_section.profile_pic} etc.)
-  const usrConf = resolveTemplateStrings(merged, merged);
-
-  // Step 3: Compute derived values
-  const siteUrl = resolveSiteUrl(usrConf.site_url);
-  const basePath = resolveBasePath(usrConf.site_path);
-  const version = getVersion();
-
-  const projName = usrConf.hero_section?.title || "Portosaurus Site";
-  const projDesc =
-    usrConf.hero_section?.description ||
-    "Complete portfolio solution for your digital personality.";
-
-  // Step 4: Resolve internal paths
-  const require = createRequire(import.meta.url);
-
-  // Prism themes
-  let catppuccinMocha, catppuccinLatte;
-  try {
-    const prism = require(path.resolve(portosaurusRoot, "src/config/prism.js"));
-    catppuccinMocha = prism.catppuccinMocha;
-    catppuccinLatte = prism.catppuccinLatte;
-  } catch {
-    catppuccinMocha = {};
-    catppuccinLatte = {};
-  }
-
-  // Meta tags
-  let metaTags = [];
-  try {
-    const meta = require(
-      path.resolve(portosaurusRoot, "src/config/metaTags.js"),
-    );
-    metaTags = meta.metaTags || [];
-  } catch {
-    // OK — no meta tags
-  }
-
-  // Paths for content — these point directly to the user's project
-  const notesPath = path.resolve(projectRoot, "notes");
-  const blogPath = path.resolve(projectRoot, "blog");
-
-  // Static directories — user's static/ + portosaurus internal static assets
-  const userStaticDir = path.resolve(projectRoot, "static");
-  const internalImgDir = path.resolve(portosaurusRoot, "src/assets");
-  const staticDirectories = [userStaticDir, internalImgDir].filter((d) =>
-    fs.existsSync(d),
-  );
-
-  // Pages — served from the portosaurus package
-  const internalPagesDir = path.resolve(portosaurusRoot, "src/pages");
-
-  // Theme overrides — served from the portosaurus package
-  const internalThemeDir = path.resolve(portosaurusRoot, "src/theme");
-
-  // Sidebar config
-  const sidebarPath = path.resolve(portosaurusRoot, "src/config/sidebar.js");
-
-  // CSS
-  const customCssPath = path.resolve(portosaurusRoot, "src/css/custom.css");
-
-  // ─── Build the Docusaurus config ───────────────────────
-
-  const config = {
-    projectName: projName,
-    title: projName,
-    tagline: projDesc,
-    favicon: usrConf.favicon || "favicon/favicon.ico",
-    url: siteUrl,
-    baseUrl: basePath,
-
-    organizationName: projName,
-    deploymentBranch: "gh-pages",
-    onBrokenAnchors: "ignore",
-    onBrokenLinks: "warn",
-
-    i18n: {
-      defaultLocale: "en",
-      locales: ["en"],
-    },
-
-    headTags: metaTags,
-
-    customFields: {
-      version,
-
-      heroSection: {
-        profilePic: usrConf.hero_section?.profile_pic || "img/icon.png",
-        intro: usrConf.hero_section?.intro || "Hello there, I'm",
-        title: usrConf.hero_section?.title || "Your Name",
-        subtitle: usrConf.hero_section?.subtitle || "I am a",
-        profession: usrConf.hero_section?.profession || "Your Profession",
-        description:
-          usrConf.hero_section?.description ||
-          "Short description about your profession, passion, goals.",
-        learnMoreButtonTxt:
-          usrConf.hero_section?.learn_more_button_txt || "Learn More",
-      },
-
-      aboutMe: {
-        enable: usrConf.about_me?.enable ?? true,
-        image:
-          usrConf.about_me?.image ||
-          usrConf.hero_section?.profile_pic ||
-          "img/icon.png",
-        description:
-          usrConf.about_me?.description || defaults.about_me.description,
-        skills: usrConf.about_me?.skills || defaults.about_me.skills,
-        resumeLink: usrConf.about_me?.resume_link || "",
-      },
-
-      projects: usrConf.project_shelf || defaults.project_shelf,
-      experience: usrConf.experience || defaults.experience,
-
-      socialLinks: {
-        enable: usrConf.social_links?.enable ?? true,
-        links: usrConf.social_links?.links || [],
-      },
-
-      robotsTxt: {
-        enable: usrConf.robots_txt ?? true,
-        rules: [{ disallow: ["/notes/", "/tasks/"] }],
-        customLines: [],
-      },
-
-      tasksPage: {
-        enable: usrConf.tasks_page?.enable ?? false,
-        title: usrConf.tasks_page?.title || "Tasks",
-        description:
-          usrConf.tasks_page?.description ||
-          "Track your tasks and projects here.",
-        taskList: usrConf.tasks_page?.tasks || [],
-      },
-
-      corsProxyList: [
-        usrConf.cors_proxy,
-        "https://api.allorigins.win/raw?url=",
-      ].filter(Boolean),
-    },
-
-    presets: [
-      [
-        require.resolve("@docusaurus/preset-classic"),
-        {
-          docs: {
-            routeBasePath: "notes",
-            path: notesPath,
-            sidebarPath,
-            admonitions: {
-              keywords: [
-                "note",
-                "tip",
-                "info",
-                "warning",
-                "danger",
-                "question",
-              ],
-              extendDefaults: true,
-            },
-          },
-          blog: {
-            path: blogPath,
-            feedOptions: usrConf.rss
-              ? { type: ["rss", "atom"], xslt: true }
-              : undefined,
-            showReadingTime: false,
-            onInlineTags: "warn",
-            onInlineAuthors: "warn",
-            onUntruncatedBlogPosts: "warn",
-          },
-          theme: {
-            customCss: customCssPath,
-          },
-          pages: {
-            path: internalPagesDir,
-          },
-        },
-      ],
-    ],
-
-    // Register portosaurus's src/ as a theme directory
-    // so Root.js, components, and pages are all natively transpiled by Docusaurus.
-    themes: [
-      [
-        path.resolve(portosaurusRoot, "src/core/themePlugin.mjs"),
-        { themeDir: path.resolve(portosaurusRoot, "src") },
-      ],
-    ],
-
-    markdown: {
-      mermaid: true,
-      hooks: {
-        onBrokenMarkdownLinks: "warn",
-      },
-    },
-
-    themeConfig: {
-      image: usrConf.social_card || "img/social-card.jpeg",
-      docs: {
-        sidebar: {
-          hideable: usrConf.collapsable_sidebar ?? true,
-        },
-      },
-      imageZoom: {
-        options: {
-          margin: 2,
-          background: "rgba(var(--ifm-background-color-rgb), 0.9)",
-        },
-      },
-      colorMode: {
-        defaultMode: usrConf.dark_mode ? "dark" : "light",
-        disableSwitch: usrConf.disable_theme_switch || false,
-      },
-      navbar: {
-        title: projName,
-        hideOnScroll: usrConf.hide_navbar_on_scroll ?? true,
-        logo: {
-          alt: "Site Logo",
-          src: usrConf.favicon || "favicon/favicon.ico",
-        },
-        items: useEnabled([
-          {
-            type: "search",
-            position: "right",
-            className: "navbar-search-bar",
-          },
-          {
-            enable: usrConf.about_me?.enable ?? true,
-            value: {
-              label: "About Me",
-              to: "/#about",
-              position: "right",
-              activeBaseRegex: "^/#about",
-            },
-          },
-          {
-            enable: usrConf.project_shelf?.enable ?? true,
-            value: {
-              label: "Projects",
-              to: "/#projects",
-              position: "right",
-              activeBaseRegex: "^/#projects",
-            },
-          },
-          {
-            enable: usrConf.experience?.enable ?? false,
-            value: {
-              label: "Experience",
-              to: "/#experience",
-              position: "right",
-              activeBaseRegex: "^/#experience",
-            },
-          },
-          {
-            enable: usrConf.social_links?.enable ?? true,
-            value: {
-              label: "Contact",
-              to: "/#contact",
-              position: "right",
-              activeBaseRegex: "^/$contact",
-            },
-          },
-          {
-            type: "dropdown",
-            label: "More",
-            position: "right",
-            className: "_navbar-more-items",
-            items: useEnabled([
-              { label: "Notes", to: "/notes" },
-              { label: "Blog", to: "/blog" },
-              {
-                enable: usrConf.tasks_page?.enable ?? false,
-                value: { label: "Tasks", to: "/tasks" },
-              },
-              {
-                enable: !usrConf.disable_branding,
-                value: {
-                  label: `Portosaurus v${version}`,
-                  className: "_nav-protosaurus-version",
-                  to: "https://github.com/soymadip/portosaurus",
-                },
-              },
-            ]),
-          },
-        ]),
-      },
-      tableOfContents: {
-        minHeadingLevel: 2,
-        maxHeadingLevel: 4,
-      },
-      prism: {
-        theme: catppuccinLatte,
-        darkTheme: catppuccinMocha,
-        additionalLanguages: ["java", "php", "bash"],
-      },
-      footer: {},
-    },
-
-    plugins: [
-      function portosaurusWebpackTranspiler() {
-        return {
-          name: "portosaurus-transpile",
-          configureWebpack(config) {
-            if (config.module && config.module.rules) {
-              console.log(
-                JSON.stringify(
-                  config.module.rules,
-                  (k, v) => (typeof v === "function" ? v.toString() : v),
-                  2,
-                ),
-              );
-              process.exit(1);
-            }
-            return config;
-          },
-        };
-      },
-      path.resolve(portosaurusRoot, "src/core/build-utils/generateFavicon.mjs"),
-      path.resolve(
-        portosaurusRoot,
-        "src/core/build-utils/generateRobotsTxt.mjs",
-      ),
-      [
-        require.resolve("@easyops-cn/docusaurus-search-local"),
-        {
-          hashed: true,
-          indexDocs: true,
-          docsDir: notesPath,
-          docsRouteBasePath: "notes",
-          highlightSearchTermsOnTargetPage: true,
-          explicitSearchResultPath: true,
-          hideSearchBarWithNoSearchContext: true,
-          searchContextByPaths: ["notes", "blog"],
-          language: ["en"],
-        },
-      ],
-      "plugin-image-zoom",
-    ],
-
-    staticDirectories,
-  };
-
-  return config;
-}

package/src/core/defaults.mjs

@@ -1,67 +0,0 @@
-/**
- * Internal default configuration for Portosaurus.
- * These values are used when the user's config.js does not provide them.
- * The user's config is deep-merged on top of these defaults.
- */
-export const defaults = {
-  dark_mode: true,
-  site_url: "auto",
-  site_path: "auto",
-  robots_txt: true,
-  social_card: "img/social-card.jpeg",
-  collapsable_sidebar: true,
-  hide_navbar_on_scroll: true,
-  disable_theme_switch: false,
-  rss: true,
-  cors_proxy: "https://cors-proxy.soymadip.workers.dev/?url=",
-
-  hero_section: {
-    title: "Your Name",
-    intro: "Hello there, I'm",
-    subtitle: "I am a",
-    profession: "Your Profession",
-    description:
-      "Short description about your profession, passion, goals.",
-    learn_more_button_txt: "Learn More",
-    profile_pic: "img/icon.png",
-  },
-
-  about_me: {
-    enable: true,
-    image: null, // Falls back to hero_section.profile_pic
-    description: [
-      "I'm a passionate developer with expertise in designing and building solutions for real-world problems.",
-      "My journey in software development started with a simple desire to automate repetitive tasks.",
-    ],
-    skills: ["Skill 1", "Skill 2"],
-    resume_link: "",
-  },
-
-  project_shelf: {
-    enable: true,
-    projects: [],
-  },
-
-  experience: {
-    enable: false,
-    list: [],
-  },
-
-  social_links: {
-    enable: true,
-    links: [],
-  },
-
-  tasks_page: {
-    enable: false,
-    title: "Tasks",
-    description: "Track your tasks and projects here.",
-    tasks: [],
-  },
-
-  link_shortener: {
-    enable: false,
-    deploy_path: "/l",
-    short_links: {},
-  },
-};

package/src/core/logger.mjs

@@ -1,17 +0,0 @@
-/**
- * CLI Logging Utility (ESM)
- */
-import chalk from "chalk";
-
-export const logger = {
-  info: (msg) => console.log(chalk.blue("ℹ ") + msg),
-  success: (msg) => console.log(chalk.green("✔ ") + msg),
-  warn: (msg) => console.log(chalk.yellow("⚠ ") + msg),
-  error: (msg) => console.error(chalk.red("✘ ") + msg),
-  debug: (msg) => {
-    if (process.env.DEBUG || process.argv.includes("--debug")) {
-      console.log(chalk.gray("⚙  " + msg));
-    }
-  },
-  tip: (msg) => console.log(chalk.magenta("💡 ") + msg),
-};

package/src/core/packageManager.mjs

@@ -1,72 +0,0 @@
-/**
- * Package manager detection and CLI utility (ESM)
- */
-import fs from "fs";
-import path from "path";
-
-export function detectPackageManager(projectRoot) {
-  // Always prioritize bun if it's in the environment
-  // or if bun.lockb / bun.lock exists
-  if (
-    fs.existsSync(path.join(projectRoot, "bun.lockb")) ||
-    fs.existsSync(path.join(projectRoot, "bun.lock"))
-  )
-    return "bun";
-
-  // Check common lockfiles
-  if (fs.existsSync(path.join(projectRoot, "pnpm-lock.yaml"))) return "pnpm";
-  if (fs.existsSync(path.join(projectRoot, "yarn.lock"))) return "yarn";
-  if (fs.existsSync(path.join(projectRoot, "package-lock.json"))) return "npm";
-
-  if (process.env.npm_config_user_agent) {
-    if (process.env.npm_config_user_agent.includes("bun")) return "bun";
-    if (process.env.npm_config_user_agent.includes("pnpm")) return "pnpm";
-    if (process.env.npm_config_user_agent.includes("yarn")) return "yarn";
-  }
-  if (
-    typeof process !== "undefined" &&
-    process.versions &&
-    process.versions.bun
-  )
-    return "bun";
-
-  return "npm";
-}
-
-export function getInstallCommand(pm) {
-  switch (pm) {
-    case "bun":
-      return "bun install";
-    case "pnpm":
-      return "pnpm install";
-    case "yarn":
-      return "yarn install";
-    default:
-      return "npm install";
-  }
-}
-
-export function findDocusaurusBin(projectRoot) {
-  const pm = detectPackageManager(projectRoot);
-
-  // Check for node_modules/.bin/docusaurus
-  const localDocusaurus = path.join(
-    projectRoot,
-    "node_modules",
-    ".bin",
-    "docusaurus",
-  );
-
-  if (fs.existsSync(localDocusaurus)) {
-    if (pm === "bun") {
-      return { command: "bun", args: ["docusaurus"], packageManager: pm };
-    }
-    const command = pm === "npm" ? "npm" : pm;
-    const args = pm === "npm" ? ["run", "docusaurus", "--"] : ["docusaurus"];
-    return { command, args, packageManager: pm };
-  }
-
-  // Fallback to npx/bunx if not found locally
-  const command = pm === "bun" ? "bunx" : "npx";
-  return { command, args: ["docusaurus"], packageManager: pm };
-}