fumadocs-mdx 11.7.1 → 11.7.4

package/dist/vite/index.cjs

@@ -168,7 +168,7 @@ module.exports = __toCommonJS(vite_exports);
 // src/config/build.ts
 function buildConfig(config) {
   const collections = /* @__PURE__ */ new Map();
-  let globalConfig;
+  let globalConfig = {};
   for (const [k, v] of Object.entries(config)) {
     if (!v) {
       continue;
@@ -183,34 +183,30 @@ function buildConfig(config) {
         continue;
       }
     }
-    if (k === "default") {
+    if (k === "default" && v) {
       globalConfig = v;
       continue;
     }
-    return [
-      `Unknown export "${k}", you can only export collections from source configuration file.`,
-      null
-    ];
+    throw new Error(
+      `Unknown export "${k}", you can only export collections from source configuration file.`
+    );
   }
   let cachedMdxOptions;
-  return [
-    null,
-    {
-      global: globalConfig,
-      collections,
-      async getDefaultMDXOptions() {
-        if (cachedMdxOptions) return cachedMdxOptions;
-        const input = this.global?.mdxOptions;
-        async function uncached() {
-          const options = typeof input === "function" ? await input() : input;
-          const { getDefaultMDXOptions: getDefaultMDXOptions2 } = await Promise.resolve().then(() => (init_mdx_options(), mdx_options_exports));
-          if (options?.preset === "minimal") return options;
-          return getDefaultMDXOptions2(options ?? {});
-        }
-        return cachedMdxOptions = uncached();
+  return {
+    global: globalConfig,
+    collections,
+    async getDefaultMDXOptions() {
+      if (cachedMdxOptions) return cachedMdxOptions;
+      const input = this.global.mdxOptions;
+      async function uncached() {
+        const options = typeof input === "function" ? await input() : input;
+        const { getDefaultMDXOptions: getDefaultMDXOptions2 } = await Promise.resolve().then(() => (init_mdx_options(), mdx_options_exports));
+        if (options?.preset === "minimal") return options;
+        return getDefaultMDXOptions2(options ?? {});
       }
+      return cachedMdxOptions = uncached();
     }
-  ];
+  };
 }
 
 // src/utils/build-mdx.ts
@@ -244,9 +240,29 @@ function flattenNode(node) {
   if ("value" in node) return node.value;
   return "";
 }
+function parseSpecifier(specifier) {
+  const idx = specifier.lastIndexOf("#");
+  if (idx === -1) return { file: specifier };
+  return {
+    file: specifier.slice(0, idx),
+    section: specifier.slice(idx + 1)
+  };
+}
+function extractSection(root, section) {
+  for (const node of root.children) {
+    if (node.type === "mdxJsxFlowElement" && node.name === "section" && node.attributes.some(
+      (attr) => attr.type === "mdxJsxAttribute" && attr.name === "id" && attr.value === section
+    )) {
+      return {
+        type: "root",
+        children: node.children
+      };
+    }
+  }
+}
 function remarkInclude() {
   const TagName = "include";
-  async function update(tree, file, processor, compiler) {
+  async function update(tree, directory, processor, compiler) {
     const queue = [];
     (0, import_unist_util_visit.visit)(
       tree,
@@ -266,27 +282,41 @@ function remarkInclude() {
           }
         }
         if (!specifier) return;
+        const { file, section } = parseSpecifier(specifier);
         const targetPath = path.resolve(
-          "cwd" in params ? process.cwd() : path.dirname(file),
-          specifier
+          "cwd" in params ? process.cwd() : directory,
+          file
         );
-        const asCode = params.lang || !specifier.endsWith(".md") && !specifier.endsWith(".mdx");
+        const asCode = params.lang || !file.endsWith(".md") && !file.endsWith(".mdx");
         queue.push(
           fs.readFile(targetPath).then((buffer) => buffer.toString()).then(async (content) => {
             compiler?.addDependency(targetPath);
             if (asCode) {
-              const lang = params.lang ?? path.extname(specifier).slice(1);
+              const lang = params.lang ?? path.extname(file).slice(1);
               Object.assign(node, {
                 type: "code",
                 lang,
                 meta: params.meta,
-                value: content.toString(),
+                value: content,
                 data: {}
               });
               return;
             }
-            const parsed = processor.parse(fumaMatter(content).content);
-            await update(parsed, targetPath, processor, compiler);
+            let parsed = processor.parse(fumaMatter(content).content);
+            if (section) {
+              const extracted = extractSection(parsed, section);
+              if (!extracted)
+                throw new Error(
+                  `Cannot find section ${section} in ${file}, make sure you have encapsulated the section in a <section id="${section}"> tag`
+                );
+              parsed = extracted;
+            }
+            await update(
+              parsed,
+              path.dirname(targetPath),
+              processor,
+              compiler
+            );
             Object.assign(
               parent && parent.type === "paragraph" ? parent : node,
               parsed
@@ -294,7 +324,8 @@ function remarkInclude() {
           }).catch((e) => {
             throw new Error(
               `failed to read file ${targetPath}
-${e instanceof Error ? e.message : String(e)}`
+${e instanceof Error ? e.message : String(e)}`,
+              { cause: e }
             );
           })
         );
@@ -304,7 +335,7 @@ ${e instanceof Error ? e.message : String(e)}`
     await Promise.all(queue);
   }
   return async (tree, file) => {
-    await update(tree, file.path, this, file.data._compiler);
+    await update(tree, path.dirname(file.path), this, file.data._compiler);
   };
 }
 
@@ -430,8 +461,8 @@ function ident(code, tab = 1) {
 }
 
 // src/vite/index.ts
-var import_promises = __toESM(require("fs/promises"), 1);
-var import_node_path2 = __toESM(require("path"), 1);
+var fs2 = __toESM(require("fs/promises"), 1);
+var path4 = __toESM(require("path"), 1);
 var import_js_yaml2 = require("js-yaml");
 
 // src/utils/collections.ts
@@ -446,14 +477,163 @@ function getGlobPatterns(collection) {
   return [`**/*.{${getSupportedFormats(collection).join(",")}}`];
 }
 
+// src/vite/generate-glob.ts
+function generateGlob(name, collection) {
+  const patterns = mapGlobPatterns(getGlobPatterns(collection));
+  const options = {
+    query: {
+      collection: name
+    },
+    base: getGlobBase(collection)
+  };
+  if (collection.type === "meta") {
+    options.import = "default";
+  }
+  return `import.meta.glob(${JSON.stringify(patterns)}, ${JSON.stringify(options, null, 2)})`;
+}
+function mapGlobPatterns(patterns) {
+  return patterns.map((file) => {
+    if (file.startsWith("./")) return file;
+    if (file.startsWith("/")) return `.${file}`;
+    return `./${file}`;
+  });
+}
+function getGlobBase(collection) {
+  let dir = collection.dir;
+  if (Array.isArray(dir)) {
+    if (dir.length !== 1)
+      throw new Error(
+        `[Fumadocs MDX] Vite Plugin doesn't support multiple \`dir\` for a collection at the moment.`
+      );
+    dir = dir[0];
+  }
+  if (!dir.startsWith("./") && !dir.startsWith("/")) {
+    return "/" + dir;
+  }
+  return dir;
+}
+
+// src/utils/git-timestamp.ts
+var import_node_path2 = __toESM(require("path"), 1);
+var import_tinyexec = require("tinyexec");
+var cache2 = /* @__PURE__ */ new Map();
+async function getGitTimestamp(file) {
+  const cached = cache2.get(file);
+  if (cached) return cached;
+  try {
+    const out = await (0, import_tinyexec.x)(
+      "git",
+      ["log", "-1", '--pretty="%ai"', import_node_path2.default.relative(process.cwd(), file)],
+      {
+        throwOnError: true
+      }
+    );
+    const time = new Date(out.stdout);
+    cache2.set(file, time);
+    return time;
+  } catch {
+    return;
+  }
+}
+
 // src/vite/index.ts
-var fileRegex = /\.(md|mdx)$/;
 var onlySchema = import_zod2.z.literal(["frontmatter", "all"]);
 function mdx(config, options = {}) {
   const { generateIndexFile = true, configPath = "source.config.ts" } = options;
-  const [err, loaded] = buildConfig(config);
-  if (err || !loaded) {
-    throw new Error(err);
+  const loaded = buildConfig(config);
+  async function transformMeta(path5, query, value) {
+    const isJson = path5.endsWith(".json");
+    const parsed = (0, import_node_querystring.parse)(query);
+    const collection = parsed.collection ? loaded.collections.get(parsed.collection) : void 0;
+    if (!collection) return null;
+    let schema;
+    switch (collection.type) {
+      case "meta":
+        schema = collection.schema;
+        break;
+      case "docs":
+        schema = collection.meta.schema;
+        break;
+    }
+    if (!schema) return null;
+    let data;
+    try {
+      data = isJson ? JSON.parse(value) : (0, import_js_yaml2.load)(value);
+    } catch {
+      return null;
+    }
+    const out = await validate(
+      schema,
+      data,
+      { path: path5, source: value },
+      `invalid data in ${path5}`
+    );
+    return {
+      code: isJson ? JSON.stringify(out) : `export default ${JSON.stringify(out)}`,
+      map: null
+    };
+  }
+  async function transformContent(file, query, value) {
+    const matter = fumaMatter(value);
+    const isDevelopment = this.environment.mode === "dev";
+    const parsed = (0, import_node_querystring.parse)(query);
+    const collection = parsed.collection ? loaded.collections.get(parsed.collection) : void 0;
+    const only = parsed.only ? onlySchema.parse(parsed.only) : "all";
+    let schema;
+    let mdxOptions;
+    switch (collection?.type) {
+      case "doc":
+        mdxOptions = collection.mdxOptions;
+        schema = collection.schema;
+        break;
+      case "docs":
+        mdxOptions = collection.docs.mdxOptions;
+        schema = collection.docs.schema;
+        break;
+    }
+    if (schema) {
+      matter.data = await validate(
+        schema,
+        matter.data,
+        {
+          source: value,
+          path: file
+        },
+        `invalid frontmatter in ${file}`
+      );
+    }
+    if (only === "frontmatter") {
+      return {
+        code: `export const frontmatter = ${JSON.stringify(matter.data)}`,
+        map: null
+      };
+    }
+    const data = {};
+    if (loaded.global.lastModifiedTime === "git") {
+      data.lastModified = (await getGitTimestamp(file))?.getTime();
+    }
+    mdxOptions ??= await loaded.getDefaultMDXOptions();
+    const lineOffset = isDevelopment ? countLines(matter.matter) : 0;
+    const compiled = await buildMDX(
+      parsed.collection ?? "global",
+      "\n".repeat(lineOffset) + matter.content,
+      {
+        development: isDevelopment,
+        ...mdxOptions,
+        data,
+        filePath: file,
+        frontmatter: matter.data,
+        _compiler: {
+          addDependency: (file2) => {
+            this.addWatchFile(file2);
+          }
+        }
+      }
+    );
+    return {
+      code: String(compiled.value),
+      map: compiled.map
+    };
   }
   return {
     name: "fumadocs-mdx",
@@ -465,6 +645,7 @@ function mdx(config, options = {}) {
       const outdir = process.cwd();
       const outFile = "source.generated.ts";
       const lines = [
+        '/// <reference types="vite/client" />',
         `import { fromConfig } from 'fumadocs-mdx/runtime/vite';`,
         `import type * as Config from '${toImportPath(configPath, {
           relativeTo: outdir
@@ -497,139 +678,22 @@ ${args}
           lines.push(doc(name, collection));
         }
       }
-      await import_promises.default.writeFile(import_node_path2.default.join(outdir, outFile), lines.join("\n"));
+      await fs2.writeFile(path4.join(outdir, outFile), lines.join("\n"));
     },
     async transform(value, id) {
-      const [path4, query = ""] = id.split("?");
-      const isJson = path4.endsWith(".json");
-      const isYaml = path4.endsWith(".yaml");
-      if (isJson || isYaml) {
-        const parsed2 = (0, import_node_querystring.parse)(query);
-        const collection2 = parsed2.collection ? loaded.collections.get(parsed2.collection) : void 0;
-        if (!collection2) return null;
-        let schema2;
-        switch (collection2.type) {
-          case "meta":
-            schema2 = collection2.schema;
-            break;
-          case "docs":
-            schema2 = collection2.meta.schema;
-            break;
-        }
-        if (!schema2) return null;
-        let data;
-        try {
-          data = isJson ? JSON.parse(value) : (0, import_js_yaml2.load)(value);
-        } catch {
-          return null;
+      const [file, query = ""] = id.split("?");
+      const ext = path4.extname(file);
+      try {
+        if ([".yaml", ".json"].includes(ext))
+          return await transformMeta(file, query, value);
+        if ([".md", ".mdx"].includes(ext))
+          return await transformContent.call(this, file, query, value);
+      } catch (e) {
+        if (e instanceof ValidationError) {
+          throw new Error(e.toStringFormatted());
         }
-        const out = await validate(
-          schema2,
-          data,
-          { path: path4, source: value },
-          `invalid data in ${path4}`
-        );
-        return {
-          code: isJson ? JSON.stringify(out) : `export default ${JSON.stringify(out)}`,
-          map: null
-        };
-      }
-      if (!fileRegex.test(path4)) return;
-      const matter = fumaMatter(value);
-      const isDevelopment = this.environment.mode === "dev";
-      const parsed = (0, import_node_querystring.parse)(query);
-      const collection = parsed.collection ? loaded.collections.get(parsed.collection) : void 0;
-      const only = parsed.only ? onlySchema.parse(parsed.only) : "all";
-      let schema;
-      let mdxOptions;
-      switch (collection?.type) {
-        case "doc":
-          mdxOptions = collection.mdxOptions;
-          schema = collection.schema;
-          break;
-        case "docs":
-          mdxOptions = collection.docs.mdxOptions;
-          schema = collection.docs.schema;
-          break;
+        throw e;
       }
-      if (schema) {
-        try {
-          matter.data = await validate(
-            schema,
-            matter.data,
-            {
-              source: value,
-              path: path4
-            },
-            `invalid frontmatter in ${path4}`
-          );
-        } catch (e) {
-          if (e instanceof ValidationError) {
-            throw new Error(e.toStringFormatted());
-          }
-          throw e;
-        }
-      }
-      if (only === "frontmatter") {
-        return {
-          code: `export const frontmatter = ${JSON.stringify(matter.data)}`
-        };
-      }
-      mdxOptions ??= await loaded.getDefaultMDXOptions();
-      const lineOffset = isDevelopment ? countLines(matter.matter) : 0;
-      const file = await buildMDX(
-        parsed.collection ?? "global",
-        "\n".repeat(lineOffset) + matter.content,
-        {
-          development: isDevelopment,
-          ...mdxOptions,
-          filePath: path4,
-          frontmatter: matter.data,
-          _compiler: {
-            addDependency: (file2) => {
-              this.addWatchFile(file2);
-            }
-          }
-        }
-      );
-      return {
-        code: String(file.value),
-        map: file.map
-      };
     }
   };
 }
-function generateGlob(name, collection) {
-  const patterns = mapGlobPatterns(getGlobPatterns(collection));
-  const options = {
-    query: {
-      collection: name
-    },
-    base: getGlobBase(collection)
-  };
-  if (collection.type === "meta") {
-    options.import = "default";
-  }
-  return `import.meta.glob(${JSON.stringify(patterns)}, ${JSON.stringify(options, null, 2)})`;
-}
-function mapGlobPatterns(patterns) {
-  return patterns.map((file) => {
-    if (file.startsWith("./")) return file;
-    if (file.startsWith("/")) return `.${file}`;
-    return `./${file}`;
-  });
-}
-function getGlobBase(collection) {
-  let dir = collection.dir;
-  if (Array.isArray(dir)) {
-    if (dir.length !== 1)
-      throw new Error(
-        `[Fumadocs MDX] Vite Plugin doesn't support multiple \`dir\` for a collection at the moment.`
-      );
-    dir = dir[0];
-  }
-  if (!dir.startsWith("./") && !dir.startsWith("/")) {
-    return "/" + dir;
-  }
-  return dir;
-}