boltdocs 1.0.4 → 1.3.1

package/dist/node/index.mjs

@@ -1,133 +1,24 @@
+import {
+  FileCache,
+  TransformCache,
+  capitalize,
+  escapeHtml,
+  extractNumberPrefix,
+  fileToRoutePath,
+  isDocFile,
+  normalizePath,
+  parseFrontmatter,
+  stripNumberPrefix
+} from "../chunk-GSYECEZY.mjs";
+
 // src/node/plugin/index.ts
 import { loadEnv } from "vite";
 
 // src/node/routes/index.ts
 import fastGlob from "fast-glob";
 
-// src/node/utils.ts
-import fs from "fs";
-import matter from "gray-matter";
-function normalizePath(p) {
-  return p.replace(/\\/g, "/");
-}
-function stripNumberPrefix(name) {
-  return name.replace(/^\d+\./, "");
-}
-function extractNumberPrefix(name) {
-  const match = name.match(/^(\d+)\./);
-  return match ? parseInt(match[1], 10) : void 0;
-}
-function isDocFile(filePath) {
-  return /\.mdx?$/.test(filePath);
-}
-function getFileMtime(filePath) {
-  try {
-    return fs.statSync(filePath).mtimeMs;
-  } catch {
-    return 0;
-  }
-}
-function parseFrontmatter(filePath) {
-  const raw = fs.readFileSync(filePath, "utf-8");
-  const { data, content } = matter(raw);
-  return { data, content };
-}
-function escapeHtml(str) {
-  return str.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
-}
-function fileToRoutePath(relativePath) {
-  let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
-  let routePath = cleanedPath.replace(/\.mdx?$/, "");
-  if (routePath === "index" || routePath.endsWith("/index")) {
-    routePath = routePath.replace(/index$/, "");
-  }
-  if (!routePath.startsWith("/")) {
-    routePath = "/" + routePath;
-  }
-  if (routePath.length > 1 && routePath.endsWith("/")) {
-    routePath = routePath.slice(0, -1);
-  }
-  return routePath;
-}
-function capitalize(str) {
-  return str.charAt(0).toUpperCase() + str.slice(1);
-}
-
-// src/node/cache.ts
-var FileCache = class {
-  entries = /* @__PURE__ */ new Map();
-  /**
-   * Retrieves parsed data for a file from the cache.
-   * Compares the current filesystem mtime with the cached mtime.
-   *
-   * @param filePath - The absolute path of the file
-   * @returns The cached data if valid, or `null` if the file has changed or doesn't exist
-   */
-  get(filePath) {
-    const entry = this.entries.get(filePath);
-    if (!entry) return null;
-    const currentMtime = getFileMtime(filePath);
-    if (currentMtime !== entry.mtime) return null;
-    return entry.data;
-  }
-  /**
-   * Stores parsed data for a file in the cache, recording its current mtime.
-   *
-   * @param filePath - The absolute path to the file
-   * @param data - The parsed data to store
-   */
-  set(filePath, data) {
-    this.entries.set(filePath, {
-      data,
-      mtime: getFileMtime(filePath)
-    });
-  }
-  /**
-   * Checks if a specific file's cache is still valid (based on its mtime).
-   *
-   * @param filePath - The absolute path to the file
-   * @returns `true` if the cache is valid, `false` otherwise
-   */
-  isValid(filePath) {
-    return this.get(filePath) !== null;
-  }
-  /**
-   * Manually removes a specific file from the cache.
-   * Useful when forcefully invalidating a single updated file.
-   *
-   * @param filePath - The absolute path to the file
-   */
-  invalidate(filePath) {
-    this.entries.delete(filePath);
-  }
-  /**
-   * Clears the entire cache, forcing all files to be re-parsed on the next request.
-   * Useful when global dependencies (like config) change.
-   */
-  invalidateAll() {
-    this.entries.clear();
-  }
-  /**
-   * Removes cached entries for files that no longer exist on the filesystem.
-   * Prevents memory leaks from deleted files.
-   *
-   * @param currentFiles - A Set of absolute file paths currently discovered on the disk
-   */
-  pruneStale(currentFiles) {
-    for (const key of this.entries.keys()) {
-      if (!currentFiles.has(key)) {
-        this.entries.delete(key);
-      }
-    }
-  }
-  /** Number of cached entries */
-  get size() {
-    return this.entries.size;
-  }
-};
-
 // src/node/routes/cache.ts
-var docCache = new FileCache();
+var docCache = new FileCache({ name: "routes" });
 function invalidateRouteCache() {
   docCache.invalidateAll();
 }
@@ -139,8 +30,18 @@ function invalidateFile(filePath) {
 import path from "path";
 import GithubSlugger from "github-slugger";
 function parseDocFile(file, docsDir, basePath, config) {
+  const decodedFile = decodeURIComponent(file);
+  const absoluteFile = path.resolve(decodedFile);
+  const absoluteDocsDir = path.resolve(docsDir);
+  const relativePath = normalizePath(
+    path.relative(absoluteDocsDir, absoluteFile)
+  );
+  if (relativePath.startsWith("../") || relativePath === ".." || absoluteFile.includes("\0")) {
+    throw new Error(
+      `Security breach: File is outside of docs directory or contains null bytes: ${file}`
+    );
+  }
   const { data, content } = parseFrontmatter(file);
-  const relativePath = normalizePath(path.relative(docsDir, file));
   let parts = relativePath.split("/");
   let locale;
   let version;
@@ -186,25 +87,30 @@ function parseDocFile(file, docsDir, basePath, config) {
     const level = match[1].length;
     const text = match[2].replace(/\[([^\]]+)\]\([^\)]+\)/g, "$1").replace(/[_*`]/g, "").trim();
     const id = slugger.slug(text);
-    headings.push({ level, text, id });
+    headings.push({ level, text: escapeHtml(text), id });
   }
+  const sanitizedTitle = data.title ? escapeHtml(data.title) : inferredTitle;
+  const sanitizedDescription = data.description ? escapeHtml(data.description) : "";
+  const sanitizedBadge = data.badge ? escapeHtml(data.badge) : void 0;
   return {
     route: {
       path: finalPath,
       componentPath: file,
       filePath: relativePath,
-      title: data.title || inferredTitle,
-      description: data.description || "",
+      title: sanitizedTitle,
+      description: sanitizedDescription,
       sidebarPosition,
       headings,
       locale,
       version,
-      badge: data.badge
+      badge: sanitizedBadge
     },
     relativeDir: cleanDirName,
     isGroupIndex,
     groupMeta: isGroupIndex ? {
-      title: data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : ""),
+      title: escapeHtml(
+        data.groupTitle || data.title || (cleanDirName ? capitalize(cleanDirName) : "")
+      ),
       position: data.groupPosition ?? data.sidebarPosition ?? (rawDirName ? extractNumberPrefix(rawDirName) : void 0)
     } : void 0,
     inferredGroupPosition: rawDirName ? extractNumberPrefix(rawDirName) : void 0
@@ -240,6 +146,7 @@ function compareByGroupPosition(a, b) {
 
 // src/node/routes/index.ts
 async function generateRoutes(docsDir, config, basePath = "/docs") {
+  docCache.load();
   const files = await fastGlob(["**/*.md", "**/*.mdx"], {
     cwd: docsDir,
     absolute: true
@@ -248,15 +155,25 @@ async function generateRoutes(docsDir, config, basePath = "/docs") {
   if (config?.i18n) {
     docCache.invalidateAll();
   }
+  let cacheHits = 0;
   const parsed = await Promise.all(
     files.map(async (file) => {
       const cached = docCache.get(file);
-      if (cached) return cached;
+      if (cached) {
+        cacheHits++;
+        return cached;
+      }
       const result = parseDocFile(file, docsDir, basePath, config);
       docCache.set(file, result);
       return result;
     })
   );
+  if (files.length > 0) {
+    console.log(
+      `[boltdocs] Routes generated: ${files.length} files (${cacheHits} from cache, ${files.length - cacheHits} parsed)`
+    );
+  }
+  docCache.save();
   const groupMeta = /* @__PURE__ */ new Map();
   for (const p of parsed) {
     if (p.relativeDir) {
@@ -336,7 +253,7 @@ import { ViteImageOptimizer } from "vite-plugin-image-optimizer";
 // src/node/config.ts
 import path2 from "path";
 import { pathToFileURL } from "url";
-import fs2 from "fs";
+import fs from "fs";
 var CONFIG_FILES = [
   "boltdocs.config.js",
   "boltdocs.config.mjs",
@@ -357,7 +274,7 @@ async function resolveConfig(docsDir) {
   };
   for (const filename of CONFIG_FILES) {
     const configPath = path2.resolve(projectRoot, filename);
-    if (fs2.existsSync(configPath)) {
+    if (fs.existsSync(configPath)) {
       try {
         const fileUrl = pathToFileURL(configPath).href + "?t=" + Date.now();
         const mod = await import(fileUrl);
@@ -383,7 +300,7 @@ async function resolveConfig(docsDir) {
 }
 
 // src/node/ssg/index.ts
-import fs3 from "fs";
+import fs2 from "fs";
 import path3 from "path";
 import { fileURLToPath } from "url";
 import { createRequire } from "module";
@@ -456,7 +373,7 @@ async function generateStaticPages(options) {
   const siteTitle = config?.themeConfig?.title || "Boltdocs";
   const siteDescription = config?.themeConfig?.description || "";
   const ssrModulePath = path3.resolve(_dirname, "../client/ssr.js");
-  if (!fs3.existsSync(ssrModulePath)) {
+  if (!fs2.existsSync(ssrModulePath)) {
     console.error(
       "[boltdocs] SSR module not found at",
       ssrModulePath,
@@ -466,11 +383,11 @@ async function generateStaticPages(options) {
   }
   const { render } = _require(ssrModulePath);
   const templatePath = path3.join(outDir, "index.html");
-  if (!fs3.existsSync(templatePath)) {
+  if (!fs2.existsSync(templatePath)) {
     console.warn("[boltdocs] No index.html found in outDir, skipping SSG.");
     return;
   }
-  const template = fs3.readFileSync(templatePath, "utf-8");
+  const template = fs2.readFileSync(templatePath, "utf-8");
   let homePageComp;
   if (config?._homePagePath) {
     try {
@@ -497,8 +414,8 @@ async function generateStaticPages(options) {
           description: escapeHtml(pageDescription)
         }).replace("<!--app-html-->", appHtml).replace(`<div id="root"></div>`, `<div id="root">${appHtml}</div>`);
         const routeDir = path3.join(outDir, route.path);
-        await fs3.promises.mkdir(routeDir, { recursive: true });
-        await fs3.promises.writeFile(
+        await fs2.promises.mkdir(routeDir, { recursive: true });
+        await fs2.promises.writeFile(
           path3.join(routeDir, "index.html"),
           html,
           "utf-8"
@@ -512,10 +429,12 @@ async function generateStaticPages(options) {
     routes.map((r) => r.path),
     config
   );
-  fs3.writeFileSync(path3.join(outDir, "sitemap.xml"), sitemap, "utf-8");
+  fs2.writeFileSync(path3.join(outDir, "sitemap.xml"), sitemap, "utf-8");
   console.log(
     `[boltdocs] Generated ${routes.length} static pages + sitemap.xml`
   );
+  const { flushCache } = await import("../cache-EHR7SXRU.mjs");
+  await flushCache();
 }
 
 // src/node/plugin/index.ts
@@ -696,6 +615,8 @@ function boltdocsPlugin(options = {}, passedConfig) {
         if (!isBuild) return;
         const outDir = viteConfig?.build?.outDir ? path4.resolve(viteConfig.root, viteConfig.build.outDir) : path4.resolve(process.cwd(), "dist");
         await generateStaticPages({ docsDir, outDir, config });
+        const { flushCache } = await import("../cache-EHR7SXRU.mjs");
+        await flushCache();
       }
     },
     ViteImageOptimizer({
@@ -725,10 +646,13 @@ import remarkGfm from "remark-gfm";
 import remarkFrontmatter from "remark-frontmatter";
 import rehypeSlug from "rehype-slug";
 import rehypePrettyCode from "rehype-pretty-code";
+import crypto from "crypto";
+var mdxCache = new TransformCache("mdx");
+var mdxCacheLoaded = false;
 function boltdocsMdxPlugin(config) {
   const extraRemarkPlugins = config?.plugins?.flatMap((p) => p.remarkPlugins || []) || [];
   const extraRehypePlugins = config?.plugins?.flatMap((p) => p.rehypePlugins || []) || [];
-  return mdxPlugin({
+  const baseMdxPlugin = mdxPlugin({
     remarkPlugins: [remarkGfm, remarkFrontmatter, ...extraRemarkPlugins],
     rehypePlugins: [
       rehypeSlug,
@@ -736,16 +660,64 @@ function boltdocsMdxPlugin(config) {
       [
         rehypePrettyCode,
         {
-          theme: "one-dark-pro",
+          theme: config?.themeConfig?.codeTheme || "one-dark-pro",
           keepBackground: false
         }
       ]
     ],
-    // Provide React as default for JSX
     jsxRuntime: "automatic",
     providerImportSource: "@mdx-js/react"
   });
+  return {
+    ...baseMdxPlugin,
+    name: "vite-plugin-boltdocs-mdx",
+    async buildStart() {
+      hits = 0;
+      total = 0;
+      if (!mdxCacheLoaded) {
+        mdxCache.load();
+        mdxCacheLoaded = true;
+      }
+      if (baseMdxPlugin.buildStart) {
+        await baseMdxPlugin.buildStart.call(this);
+      }
+    },
+    async transform(code, id, options) {
+      if (!id.endsWith(".md") && !id.endsWith(".mdx")) {
+        return baseMdxPlugin.transform?.call(this, code, id, options);
+      }
+      total++;
+      const contentHash = crypto.createHash("md5").update(code).digest("hex");
+      const cacheKey = `${id}:${contentHash}`;
+      const cached = mdxCache.get(cacheKey);
+      if (cached) {
+        hits++;
+        return { code: cached, map: null };
+      }
+      const result = await baseMdxPlugin.transform.call(
+        this,
+        code,
+        id,
+        options
+      );
+      if (result && typeof result === "object" && result.code) {
+        mdxCache.set(cacheKey, result.code);
+      } else if (typeof result === "string") {
+        mdxCache.set(cacheKey, result);
+      }
+      return result;
+    },
+    async buildEnd() {
+      mdxCache.save();
+      await mdxCache.flush();
+      if (baseMdxPlugin.buildEnd) {
+        await baseMdxPlugin.buildEnd.call(this);
+      }
+    }
+  };
 }
+var hits = 0;
+var total = 0;
 
 // src/node/index.ts
 async function boltdocs(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boltdocs",
-  "version": "1.0.4",
+  "version": "1.3.1",
   "description": "A lightweight documentation generator for React projects.",
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",
@@ -54,7 +54,7 @@
     "remark-gfm": "^4.0.1",
     "sharp": "^0.34.5",
     "shiki": "^3.23.0",
-    "svgo": "^4.0.0",
+    "svgo": "^4.0.1",
     "unist-util-visit": "^5.1.0",
     "vite": "^7.3.1",
     "vite-plugin-image-optimizer": "^2.0.3"