fumadocs-mdx 11.6.0 → 13.0.1

package/dist/vite/index.d.cts

@@ -0,0 +1,45 @@
+import { Plugin } from 'vite';
+
+interface IndexFileOptions {
+    /**
+     * Runtime compat fallbacks for Vite specific APIs
+     *
+     * - `bun`: use Bun-specific APIs.
+     * - `node`: use Node.js APIs.
+     * - `false` (default): no fallback.
+     */
+    runtime?: 'bun' | 'node' | false;
+    /**
+     * add `.js` extensions to imports, needed for ESM without bundler resolution
+     */
+    addJsExtension?: boolean;
+}
+
+interface PluginOptions {
+    /**
+     * Automatically generate index files for accessing files with `import.meta.glob`.
+     *
+     * @defaultValue true
+     */
+    generateIndexFile?: boolean | IndexFileOptions;
+    /**
+     * @defaultValue source.config.ts
+     */
+    configPath?: string;
+    /**
+     * Update Vite config to fix module resolution of Fumadocs
+     *
+     * @defaultValue true
+     */
+    updateViteConfig?: boolean;
+    /**
+     * Output directory of generated files
+     *
+     * @defaultValue '.source'
+     */
+    outDir?: string;
+}
+declare function mdx(config: Record<string, unknown>, pluginOptions?: PluginOptions): Promise<Plugin>;
+declare function postInstall(configPath?: string, pluginOptions?: PluginOptions): Promise<void>;
+
+export { type PluginOptions, mdx as default, postInstall };

package/dist/vite/index.d.ts

@@ -0,0 +1,45 @@
+import { Plugin } from 'vite';
+
+interface IndexFileOptions {
+    /**
+     * Runtime compat fallbacks for Vite specific APIs
+     *
+     * - `bun`: use Bun-specific APIs.
+     * - `node`: use Node.js APIs.
+     * - `false` (default): no fallback.
+     */
+    runtime?: 'bun' | 'node' | false;
+    /**
+     * add `.js` extensions to imports, needed for ESM without bundler resolution
+     */
+    addJsExtension?: boolean;
+}
+
+interface PluginOptions {
+    /**
+     * Automatically generate index files for accessing files with `import.meta.glob`.
+     *
+     * @defaultValue true
+     */
+    generateIndexFile?: boolean | IndexFileOptions;
+    /**
+     * @defaultValue source.config.ts
+     */
+    configPath?: string;
+    /**
+     * Update Vite config to fix module resolution of Fumadocs
+     *
+     * @defaultValue true
+     */
+    updateViteConfig?: boolean;
+    /**
+     * Output directory of generated files
+     *
+     * @defaultValue '.source'
+     */
+    outDir?: string;
+}
+declare function mdx(config: Record<string, unknown>, pluginOptions?: PluginOptions): Promise<Plugin>;
+declare function postInstall(configPath?: string, pluginOptions?: PluginOptions): Promise<void>;
+
+export { type PluginOptions, mdx as default, postInstall };

package/dist/vite/index.js

@@ -0,0 +1,297 @@
+import {
+  ident,
+  toImportPath
+} from "../chunk-CXA4JO4Z.js";
+import {
+  buildConfig
+} from "../chunk-U4MQ44TS.js";
+import {
+  toVite
+} from "../chunk-YVCR6FUH.js";
+import {
+  createMdxLoader
+} from "../chunk-XQ5O7IPO.js";
+import "../chunk-3J3WL7WN.js";
+import "../chunk-K5ZLPEIQ.js";
+import {
+  ValidationError,
+  createCore,
+  findConfigFile,
+  validate
+} from "../chunk-EELYB2XC.js";
+import "../chunk-VWJKRQZR.js";
+import {
+  getGlobPatterns
+} from "../chunk-XZY2AWJI.js";
+
+// src/vite/index.ts
+import {
+  mergeConfig
+} from "vite";
+import { parse } from "querystring";
+import * as path3 from "path";
+import { load } from "js-yaml";
+
+// src/utils/glob-import.ts
+import { globSync } from "tinyglobby";
+import path from "path";
+import { pathToFileURL } from "url";
+function generateGlobImport(patterns, options) {
+  let code = "{";
+  const result = globSync(patterns, {
+    cwd: options.base
+  });
+  for (const item of result) {
+    const fullPath = path.join(options.base, item);
+    const url = pathToFileURL(fullPath);
+    for (const [k, v] of Object.entries(options.query ?? {})) {
+      url.searchParams.set(k, v);
+    }
+    let line = `${JSON.stringify(item)}: () => import(${JSON.stringify(url.href)})`;
+    if (options.import) {
+      line += `.then(mod => mod[${JSON.stringify(options.import)}])`;
+    }
+    code += `${line}, `;
+  }
+  code += "}";
+  return code;
+}
+
+// src/plugins/vite.ts
+import path2 from "path";
+function vite(options) {
+  let config;
+  return {
+    config(v) {
+      config = v;
+    },
+    emit() {
+      return [
+        {
+          path: "index.ts",
+          content: indexFile(this.configPath, this.outDir, config, options)
+        }
+      ];
+    }
+  };
+}
+function indexFile(configPath, outDir, config, options) {
+  const { addJsExtension = false, runtime } = options;
+  const lines = [
+    '/// <reference types="vite/client" />',
+    `import { fromConfig } from 'fumadocs-mdx/runtime/vite';`,
+    `import type * as Config from '${toImportPath(configPath, {
+      relativeTo: outDir,
+      jsExtension: addJsExtension
+    })}';`,
+    "",
+    `export const create = fromConfig<typeof Config>();`
+  ];
+  function docs(name, collection) {
+    const obj = [
+      ident(`doc: ${doc(name, collection.docs)}`),
+      ident(`meta: ${meta(name, collection.meta)}`)
+    ].join(",\n");
+    return `{
+${obj}
+}`;
+  }
+  function doc(name, collection) {
+    const patterns = getGlobPatterns(collection);
+    const base = getGlobBase(collection);
+    const docGlob = generateGlob(patterns, {
+      query: {
+        collection: name
+      },
+      base
+    });
+    if (collection.async) {
+      const headBlob = generateGlob(patterns, {
+        query: {
+          only: "frontmatter",
+          collection: name
+        },
+        import: "frontmatter",
+        base
+      });
+      return `create.docLazy("${name}", "${base}", ${headBlob}, ${docGlob})`;
+    }
+    return `create.doc("${name}", "${base}", ${docGlob})`;
+  }
+  function meta(name, collection) {
+    const patterns = getGlobPatterns(collection);
+    const base = getGlobBase(collection);
+    return `create.meta("${name}", "${base}", ${generateGlob(patterns, {
+      import: "default",
+      base,
+      query: {
+        collection: name
+      }
+    })})`;
+  }
+  function generateGlob(patterns, options2) {
+    patterns = mapGlobPatterns(patterns);
+    if (runtime === "node" || runtime === "bun") {
+      return generateGlobImport(patterns, options2);
+    } else {
+      return `import.meta.glob(${JSON.stringify(patterns)}, ${JSON.stringify(
+        {
+          ...options2,
+          base: path2.relative(outDir, options2.base)
+        },
+        null,
+        2
+      )})`;
+    }
+  }
+  for (const [name, collection] of config.collections.entries()) {
+    let body;
+    if (collection.type === "docs") {
+      body = docs(name, collection);
+    } else if (collection.type === "meta") {
+      body = meta(name, collection);
+    } else {
+      body = doc(name, collection);
+    }
+    lines.push("");
+    lines.push(`export const ${name} = ${body};`);
+  }
+  return lines.join("\n");
+}
+function mapGlobPatterns(patterns) {
+  return patterns.map(enforceRelative);
+}
+function enforceRelative(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];
+  }
+  return enforceRelative(dir);
+}
+
+// src/vite/index.ts
+var FumadocsDeps = ["fumadocs-core", "fumadocs-ui", "fumadocs-openapi"];
+async function mdx(config, pluginOptions = {}) {
+  const options = applyDefaults(pluginOptions);
+  const core = await createViteCore(options).init({
+    config: buildConfig(config)
+  });
+  const mdxLoader = toVite(createMdxLoader(core.creatConfigLoader()));
+  async function transformMeta(path4, query, value) {
+    const isJson = path4.endsWith(".json");
+    const parsed = parse(query);
+    const collection = parsed.collection ? core.getConfig().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) : load(value);
+    } catch {
+      return null;
+    }
+    const out = await validate(
+      schema,
+      data,
+      { path: path4, source: value },
+      `invalid data in ${path4}`
+    );
+    return {
+      code: isJson ? JSON.stringify(out) : `export default ${JSON.stringify(out)}`,
+      map: null
+    };
+  }
+  return {
+    name: "fumadocs-mdx",
+    // needed, otherwise other plugins will be executed before our `transform`.
+    enforce: "pre",
+    config(config2) {
+      if (!options.updateViteConfig) return config2;
+      return mergeConfig(config2, {
+        optimizeDeps: {
+          exclude: FumadocsDeps
+        },
+        resolve: {
+          noExternal: FumadocsDeps,
+          dedupe: FumadocsDeps
+        }
+      });
+    },
+    async buildStart() {
+      await core.emitAndWrite();
+    },
+    async configureServer(server) {
+      await core.initServer({
+        watcher: server.watcher
+      });
+    },
+    async transform(value, id) {
+      const [file, query = ""] = id.split("?");
+      const ext = path3.extname(file);
+      try {
+        if ([".yaml", ".json"].includes(ext))
+          return await transformMeta(file, query, value);
+        if ([".md", ".mdx"].includes(ext))
+          return await mdxLoader.call(this, file, query, value);
+      } catch (e) {
+        if (e instanceof ValidationError) {
+          throw new Error(e.toStringFormatted());
+        }
+        throw e;
+      }
+    }
+  };
+}
+async function postInstall(configPath = findConfigFile(), pluginOptions = {}) {
+  const { loadConfig } = await import("../load-MNG3CLET.js");
+  const options = applyDefaults(pluginOptions);
+  const core = await createViteCore(options).init({
+    config: loadConfig(configPath, options.outDir, true)
+  });
+  await core.emitAndWrite();
+}
+function createViteCore({
+  configPath,
+  outDir,
+  generateIndexFile
+}) {
+  return createCore(
+    {
+      environment: "vite",
+      configPath,
+      outDir
+    },
+    [
+      generateIndexFile !== false && vite(typeof generateIndexFile === "object" ? generateIndexFile : {})
+    ]
+  );
+}
+function applyDefaults(options) {
+  return {
+    updateViteConfig: options.updateViteConfig ?? true,
+    generateIndexFile: options.generateIndexFile ?? true,
+    configPath: options.configPath ?? "source.config.ts",
+    outDir: options.outDir ?? ".source"
+  };
+}
+export {
+  mdx as default,
+  postInstall
+};