boltdocs 1.4.0 → 1.4.1

package/dist/{cache-GQHF6BXI.mjs → cache-KNL5B4EE.mjs}

@@ -3,7 +3,7 @@ import {
   FileCache,
   TransformCache,
   flushCache
-} from "./chunk-CYBWLFOG.mjs";
+} from "./chunk-FFBNU6IJ.mjs";
 export {
   AssetCache,
   FileCache,

package/dist/{chunk-CYBWLFOG.mjs → chunk-FFBNU6IJ.mjs}

@@ -41,7 +41,8 @@ function escapeXml(str) {
 }
 function fileToRoutePath(relativePath) {
   let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
-  let routePath = cleanedPath.replace(/\.mdx?$/, "");
+  let routePath = cleanedPath.replace(/\/$/, "");
+  routePath = routePath.replace(/\.mdx?$/, "");
   if (routePath === "index" || routePath.endsWith("/index")) {
     routePath = routePath.replace(/index$/, "");
   }

package/dist/node/index.js

@@ -64,7 +64,8 @@ function escapeXml(str) {
 }
 function fileToRoutePath(relativePath) {
   let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
-  let routePath = cleanedPath.replace(/\.mdx?$/, "");
+  let routePath = cleanedPath.replace(/\/$/, "");
+  routePath = routePath.replace(/\.mdx?$/, "");
   if (routePath === "index" || routePath.endsWith("/index")) {
     routePath = routePath.replace(/index$/, "");
   }
@@ -478,7 +479,12 @@ function parseDocFile(file, docsDir, basePath, config) {
     }
   }
   const cleanRelativePath = parts.join("/");
-  const cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+  let cleanRoutePath;
+  if (data.permalink) {
+    cleanRoutePath = data.permalink.startsWith("/") ? data.permalink : `/${data.permalink}`;
+  } else {
+    cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+  }
   let finalPath = basePath;
   if (version) {
     finalPath += "/" + version;
@@ -677,8 +683,8 @@ var CONFIG_FILES = [
   "boltdocs.config.mjs",
   "boltdocs.config.ts"
 ];
-async function resolveConfig(docsDir) {
-  const projectRoot = process.cwd();
+async function resolveConfig(docsDir, root = process.cwd()) {
+  const projectRoot = root;
   const defaults = {
     docsDir: import_path3.default.resolve(docsDir),
     themeConfig: {
@@ -694,7 +700,8 @@ async function resolveConfig(docsDir) {
     const configPath = import_path3.default.resolve(projectRoot, filename);
     if (import_fs3.default.existsSync(configPath)) {
       try {
-        const fileUrl = (0, import_url.pathToFileURL)(configPath).href + "?t=" + Date.now();
+        const isTest = process.env.NODE_ENV === "test" || global.__vitest_worker__;
+        const fileUrl = (0, import_url.pathToFileURL)(configPath).href + (isTest ? "" : "?t=" + Date.now());
         const mod = await import(fileUrl);
         const userConfig = mod.default || mod;
         const userThemeConfig = userConfig.themeConfig || userConfig;
@@ -806,12 +813,6 @@ async function generateStaticPages(options) {
     return;
   }
   const template = import_fs4.default.readFileSync(templatePath, "utf-8");
-  let homePageComp;
-  if (config?._homePagePath) {
-    try {
-    } catch (e) {
-    }
-  }
   await Promise.all(
     routes.map(async (route) => {
       const pageTitle = `${route.title} | ${siteTitle}`;
@@ -825,7 +826,8 @@ async function generateStaticPages(options) {
           routes,
           config: config || {},
           modules: fakeModules,
-          homePage: homePageComp
+          homePage: void 0
+          // No custom home page for now
         });
         const html = replaceMetaTags(template, {
           title: escapeHtml(pageTitle),
@@ -1070,10 +1072,10 @@ var import_crypto2 = __toESM(require("crypto"));
 init_cache();
 var mdxCache = new TransformCache("mdx");
 var mdxCacheLoaded = false;
-function boltdocsMdxPlugin(config) {
+function boltdocsMdxPlugin(config, compiler = import_rollup.default) {
   const extraRemarkPlugins = config?.plugins?.flatMap((p) => p.remarkPlugins || []) || [];
   const extraRehypePlugins = config?.plugins?.flatMap((p) => p.rehypePlugins || []) || [];
-  const baseMdxPlugin = (0, import_rollup.default)({
+  const baseMdxPlugin = compiler({
     remarkPlugins: [import_remark_gfm.default, import_remark_frontmatter.default, ...extraRemarkPlugins],
     rehypePlugins: [
       import_rehype_slug.default,
@@ -1089,6 +1091,9 @@ function boltdocsMdxPlugin(config) {
     jsxRuntime: "automatic",
     providerImportSource: "@mdx-js/react"
   });
+  if (baseMdxPlugin.isMock) {
+    console.log("MDX PLUGIN IS MOCKED");
+  }
   return {
     ...baseMdxPlugin,
     name: "vite-plugin-boltdocs-mdx",
@@ -1123,8 +1128,6 @@ function boltdocsMdxPlugin(config) {
       );
       if (result && typeof result === "object" && result.code) {
         mdxCache.set(cacheKey, result.code);
-      } else if (typeof result === "string") {
-        mdxCache.set(cacheKey, result);
       }
       return result;
     },

package/dist/node/index.mjs

@@ -10,7 +10,7 @@ import {
   normalizePath,
   parseFrontmatter,
   stripNumberPrefix
-} from "../chunk-CYBWLFOG.mjs";
+} from "../chunk-FFBNU6IJ.mjs";
 
 // src/node/plugin/index.ts
 import { loadEnv } from "vite";
@@ -61,7 +61,12 @@ function parseDocFile(file, docsDir, basePath, config) {
     }
   }
   const cleanRelativePath = parts.join("/");
-  const cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+  let cleanRoutePath;
+  if (data.permalink) {
+    cleanRoutePath = data.permalink.startsWith("/") ? data.permalink : `/${data.permalink}`;
+  } else {
+    cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+  }
   let finalPath = basePath;
   if (version) {
     finalPath += "/" + version;
@@ -260,8 +265,8 @@ var CONFIG_FILES = [
   "boltdocs.config.mjs",
   "boltdocs.config.ts"
 ];
-async function resolveConfig(docsDir) {
-  const projectRoot = process.cwd();
+async function resolveConfig(docsDir, root = process.cwd()) {
+  const projectRoot = root;
   const defaults = {
     docsDir: path2.resolve(docsDir),
     themeConfig: {
@@ -277,7 +282,8 @@ async function resolveConfig(docsDir) {
     const configPath = path2.resolve(projectRoot, filename);
     if (fs.existsSync(configPath)) {
       try {
-        const fileUrl = pathToFileURL(configPath).href + "?t=" + Date.now();
+        const isTest = process.env.NODE_ENV === "test" || global.__vitest_worker__;
+        const fileUrl = pathToFileURL(configPath).href + (isTest ? "" : "?t=" + Date.now());
         const mod = await import(fileUrl);
         const userConfig = mod.default || mod;
         const userThemeConfig = userConfig.themeConfig || userConfig;
@@ -385,12 +391,6 @@ async function generateStaticPages(options) {
     return;
   }
   const template = fs2.readFileSync(templatePath, "utf-8");
-  let homePageComp;
-  if (config?._homePagePath) {
-    try {
-    } catch (e) {
-    }
-  }
   await Promise.all(
     routes.map(async (route) => {
       const pageTitle = `${route.title} | ${siteTitle}`;
@@ -404,7 +404,8 @@ async function generateStaticPages(options) {
           routes,
           config: config || {},
           modules: fakeModules,
-          homePage: homePageComp
+          homePage: void 0
+          // No custom home page for now
         });
         const html = replaceMetaTags(template, {
           title: escapeHtml(pageTitle),
@@ -430,7 +431,7 @@ async function generateStaticPages(options) {
   console.log(
     `[boltdocs] Generated ${routes.length} static pages + sitemap.xml`
   );
-  const { flushCache } = await import("../cache-GQHF6BXI.mjs");
+  const { flushCache } = await import("../cache-KNL5B4EE.mjs");
   await flushCache();
 }
 
@@ -612,7 +613,7 @@ 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-GQHF6BXI.mjs");
+        const { flushCache } = await import("../cache-KNL5B4EE.mjs");
         await flushCache();
       }
     },
@@ -646,10 +647,10 @@ import rehypePrettyCode from "rehype-pretty-code";
 import crypto from "crypto";
 var mdxCache = new TransformCache("mdx");
 var mdxCacheLoaded = false;
-function boltdocsMdxPlugin(config) {
+function boltdocsMdxPlugin(config, compiler = mdxPlugin) {
   const extraRemarkPlugins = config?.plugins?.flatMap((p) => p.remarkPlugins || []) || [];
   const extraRehypePlugins = config?.plugins?.flatMap((p) => p.rehypePlugins || []) || [];
-  const baseMdxPlugin = mdxPlugin({
+  const baseMdxPlugin = compiler({
     remarkPlugins: [remarkGfm, remarkFrontmatter, ...extraRemarkPlugins],
     rehypePlugins: [
       rehypeSlug,
@@ -665,6 +666,9 @@ function boltdocsMdxPlugin(config) {
     jsxRuntime: "automatic",
     providerImportSource: "@mdx-js/react"
   });
+  if (baseMdxPlugin.isMock) {
+    console.log("MDX PLUGIN IS MOCKED");
+  }
   return {
     ...baseMdxPlugin,
     name: "vite-plugin-boltdocs-mdx",
@@ -699,8 +703,6 @@ function boltdocsMdxPlugin(config) {
       );
       if (result && typeof result === "object" && result.code) {
         mdxCache.set(cacheKey, result.code);
-      } else if (typeof result === "string") {
-        mdxCache.set(cacheKey, result);
       }
       return result;
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boltdocs",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "A lightweight documentation generator for React projects.",
   "main": "dist/node/index.js",
   "module": "dist/node/index.mjs",

package/src/node/config.ts

@@ -139,11 +139,15 @@ export const CONFIG_FILES = [
  * Loads user's configuration file (e.g., `boltdocs.config.js` or `boltdocs.config.ts`) if it exists,
  * merges it with the default configuration, and returns the final `BoltdocsConfig`.
  *
- * @param docsDir - The fallback/default documentation directory
- * @returns A promise resolving to the final merged configuration object
+ * @param docsDir - The directory containing the documentation files
+ * @param root - The project root directory (defaults to process.cwd())
+ * @returns The merged configuration object
  */
-export async function resolveConfig(docsDir: string): Promise<BoltdocsConfig> {
-  const projectRoot = process.cwd();
+export async function resolveConfig(
+  docsDir: string,
+  root: string = process.cwd(),
+): Promise<BoltdocsConfig> {
+  const projectRoot = root;
 
   const defaults: BoltdocsConfig = {
     docsDir: path.resolve(docsDir),
@@ -162,8 +166,11 @@ export async function resolveConfig(docsDir: string): Promise<BoltdocsConfig> {
     const configPath = path.resolve(projectRoot, filename);
     if (fs.existsSync(configPath)) {
       try {
-        // Add a timestamp query parameter to bust the ESM cache
-        const fileUrl = pathToFileURL(configPath).href + "?t=" + Date.now();
+        // Add a timestamp query parameter to bust the ESM cache in dev
+        const isTest =
+          process.env.NODE_ENV === "test" || (global as any).__vitest_worker__;
+        const fileUrl =
+          pathToFileURL(configPath).href + (isTest ? "" : "?t=" + Date.now());
         const mod = await import(fileUrl);
         const userConfig = mod.default || mod;
 

package/src/node/mdx.ts

@@ -24,15 +24,19 @@ let mdxCacheLoaded = false;
  * Also wraps the plugin with a persistent cache to avoid re-compiling unchanged MDX files.
  *
  * @param config - The Boltdocs configuration containing custom plugins
+ * @param compiler - The MDX compiler plugin (for testing)
  * @returns A Vite plugin configured for MDX parsing with caching
  */
-export function boltdocsMdxPlugin(config?: BoltdocsConfig): Plugin {
+export function boltdocsMdxPlugin(
+  config?: BoltdocsConfig,
+  compiler = mdxPlugin,
+): Plugin {
   const extraRemarkPlugins =
     config?.plugins?.flatMap((p) => p.remarkPlugins || []) || [];
   const extraRehypePlugins =
     config?.plugins?.flatMap((p) => p.rehypePlugins || []) || [];
 
-  const baseMdxPlugin = mdxPlugin({
+  const baseMdxPlugin = compiler({
     remarkPlugins: [remarkGfm, remarkFrontmatter, ...extraRemarkPlugins],
     rehypePlugins: [
       rehypeSlug,
@@ -49,6 +53,11 @@ export function boltdocsMdxPlugin(config?: BoltdocsConfig): Plugin {
     providerImportSource: "@mdx-js/react",
   }) as Plugin;
 
+  // @ts-ignore
+  if (baseMdxPlugin.isMock) {
+    console.log("MDX PLUGIN IS MOCKED");
+  }
+
   return {
     ...baseMdxPlugin,
     name: "vite-plugin-boltdocs-mdx",
@@ -90,8 +99,6 @@ export function boltdocsMdxPlugin(config?: BoltdocsConfig): Plugin {
 
       if (result && typeof result === "object" && result.code) {
         mdxCache.set(cacheKey, result.code);
-      } else if (typeof result === "string") {
-        mdxCache.set(cacheKey, result);
       }
 
       return result;

package/src/node/routes/parser.ts

@@ -70,7 +70,16 @@ export function parseDocFile(
   }
 
   const cleanRelativePath = parts.join("/");
-  const cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+
+  let cleanRoutePath: string;
+  if (data.permalink) {
+    // If a permalink is specified, ensure it starts with a slash
+    cleanRoutePath = data.permalink.startsWith("/")
+      ? data.permalink
+      : `/${data.permalink}`;
+  } else {
+    cleanRoutePath = fileToRoutePath(cleanRelativePath || "index.md");
+  }
 
   let finalPath = basePath;
   if (version) {

package/src/node/ssg/index.ts

@@ -49,15 +49,6 @@ export async function generateStaticPages(options: SSGOptions): Promise<void> {
   }
   const template = fs.readFileSync(templatePath, "utf-8");
 
-  // Load user's homePage if configured
-  let homePageComp;
-  if ((config as any)?._homePagePath) {
-    try {
-      // Simplistic: if there's a custom home page compiled, we'd need it available to SSR.
-      // In a full framework this is complex, but for Boltdocs we assume it's bundled if needed.
-    } catch (e) {}
-  }
-
   // Generate an HTML file for each route concurrently
   await Promise.all(
     routes.map(async (route) => {
@@ -74,7 +65,7 @@ export async function generateStaticPages(options: SSGOptions): Promise<void> {
           routes: routes,
           config: config || {},
           modules: fakeModules,
-          homePage: homePageComp,
+          homePage: undefined, // No custom home page for now
         });
 
         const html = replaceMetaTags(template, {

package/src/node/utils.ts

@@ -113,7 +113,10 @@ export function fileToRoutePath(relativePath: string): string {
   // Strip number prefixes from every segment
   let cleanedPath = relativePath.split("/").map(stripNumberPrefix).join("/");
 
-  let routePath = cleanedPath.replace(/\.mdx?$/, "");
+  // Remove trailing slash if present
+  let routePath = cleanedPath.replace(/\/$/, "");
+
+  routePath = routePath.replace(/\.mdx?$/, "");
 
   // Handle index files → directory root
   if (routePath === "index" || routePath.endsWith("/index")) {