create-fumadocs-app 16.0.1 → 16.0.2

package/dist/{chunk-YVEWA65C.js → chunk-6C2B326N.js}

@@ -1,11 +1,32 @@
 // src/create-app.ts
-import path from "path";
+import path2 from "path";
 import fs2 from "fs/promises";
 
-// src/git.ts
-import * as fs from "fs/promises";
-import { join } from "path";
+// src/utils.ts
+import fs from "fs/promises";
+import path, { join } from "path";
 import { x } from "tinyexec";
+async function copy(from, to, options = {}) {
+  const {
+    rename = (s) => s,
+    filterDir = () => true,
+    filter = () => true
+  } = options;
+  const stats = await fs.stat(from);
+  if (stats.isDirectory() && filterDir(from)) {
+    const files = await fs.readdir(from);
+    await Promise.all(
+      files.map(
+        (file) => copy(path.join(from, file), path.join(to, file), options)
+      )
+    );
+  }
+  if (stats.isFile() && filter(from)) {
+    to = rename(to);
+    await fs.mkdir(path.dirname(to), { recursive: true });
+    await fs.copyFile(from, to);
+  }
+}
 async function isInGitRepository(cwd2) {
   const { exitCode } = await x("git", ["rev-parse", "--is-inside-work-tree"], {
     nodeOptions: { cwd: cwd2 }
@@ -57,9 +78,51 @@ async function tryGitInit(cwd2) {
     return false;
   }
 }
+function pick(obj, keys) {
+  const result = {};
+  for (const key of keys) {
+    if (key in obj) {
+      result[key] = obj[key];
+    }
+  }
+  return result;
+}
+
+// src/auto-install.ts
+import { x as x2 } from "tinyexec";
+var managers = ["npm", "yarn", "bun", "pnpm"];
+function getPackageManager() {
+  const userAgent = process.env.npm_config_user_agent ?? "";
+  if (userAgent.startsWith("yarn")) {
+    return "yarn";
+  }
+  if (userAgent.startsWith("pnpm")) {
+    return "pnpm";
+  }
+  if (userAgent.startsWith("bun")) {
+    return "bun";
+  }
+  return "npm";
+}
+async function autoInstall(manager, dest) {
+  await x2(manager, ["install"], {
+    throwOnError: true,
+    nodeOptions: {
+      env: {
+        ...process.env,
+        NODE_ENV: "development",
+        DISABLE_OPENCOLLECTIVE: "1"
+      },
+      cwd: dest
+    }
+  });
+}
+
+// src/constants.ts
+import { fileURLToPath } from "url";
 
 // src/versions.js
-var versions = { "fumadocs-core": "16.0.1", "fumadocs-ui": "16.0.1", "fumadocs-mdx": "13.0.0", "@fumadocs/mdx-remote": "1.4.3", "@fumadocs/content-collections": "1.2.4" };
+var versions = { "fumadocs-core": "16.0.2", "fumadocs-ui": "16.0.2", "fumadocs-mdx": "13.0.0", "@fumadocs/mdx-remote": "1.4.3", "@fumadocs/content-collections": "1.2.4" };
 
 // ../create-app-versions/package.json
 var package_default = {
@@ -72,6 +135,7 @@ var package_default = {
     "@content-collections/core": "^0.11.1",
     "@content-collections/mdx": "^0.2.2",
     "@content-collections/next": "^0.2.8",
+    "@orama/core": "^1.2.13",
     "@react-router/dev": "^7.9.4",
     "@react-router/node": "^7.9.4",
     "@react-router/serve": "^7.9.4",
@@ -103,60 +167,58 @@ var package_default = {
   }
 };
 
-// src/auto-install.ts
-import { x as x2 } from "tinyexec";
-var managers = ["npm", "yarn", "bun", "pnpm"];
-function getPackageManager() {
-  const userAgent = process.env.npm_config_user_agent ?? "";
-  if (userAgent.startsWith("yarn")) {
-    return "yarn";
-  }
-  if (userAgent.startsWith("pnpm")) {
-    return "pnpm";
-  }
-  if (userAgent.startsWith("bun")) {
-    return "bun";
-  }
-  return "npm";
-}
-async function autoInstall(manager, dest) {
-  await x2(manager, ["install"], {
-    throwOnError: true,
-    nodeOptions: {
-      env: {
-        ...process.env,
-        NODE_ENV: "development",
-        DISABLE_OPENCOLLECTIVE: "1"
-      },
-      cwd: dest
-    }
-  });
-}
-
 // src/constants.ts
-import { fileURLToPath } from "url";
 var sourceDir = fileURLToPath(new URL(`../`, import.meta.url).href);
 var cwd = process.cwd();
-
-// src/create-app.ts
 var templates = [
-  "+next+content-collections",
-  "+next+fuma-docs-mdx",
-  "react-router",
-  "tanstack-start",
-  "waku"
+  {
+    value: "+next+fuma-docs-mdx",
+    label: "Next.js: Fumadocs MDX",
+    hint: "recommended",
+    componentsDir: "components"
+  },
+  {
+    value: "waku",
+    label: "Waku: Fumadocs MDX",
+    componentsDir: "src/components"
+  },
+  {
+    value: "react-router",
+    label: "React Router: Fumadocs MDX (not RSC)",
+    componentsDir: "app/components"
+  },
+  {
+    value: "react-router-spa",
+    label: "React Router SPA: Fumadocs MDX (not RSC)",
+    hint: "SPA mode allows you to host the site statically, compatible with a CDN.",
+    componentsDir: "app/components"
+  },
+  {
+    value: "tanstack-start",
+    label: "Tanstack Start: Fumadocs MDX (not RSC)",
+    componentsDir: "src/components"
+  }
 ];
+var depVersions = {
+  ...versions,
+  ...package_default.dependencies
+};
+
+// src/create-app.ts
 function defaults(options) {
   return {
     ...options,
-    useSrcDir: options.useSrcDir ?? false,
-    tailwindcss: options.tailwindcss ?? true,
+    plugins: options.plugins ?? [],
+    useSrcDir: options.template.startsWith("+next") && options.useSrcDir === true,
     lint: options.lint ?? false,
     initializeGit: options.initializeGit ?? false,
     installDeps: options.installDeps ?? false,
     log: console.log
   };
 }
+function isRelative(dir, file) {
+  return !path2.relative(dir, file).startsWith(`..${path2.sep}`);
+}
 async function create(createOptions) {
   const options = defaults(createOptions);
   const {
@@ -168,72 +230,57 @@ async function create(createOptions) {
     lint,
     initializeGit,
     packageManager,
-    tailwindcss
+    plugins
   } = options;
-  const projectName = path.basename(outputDir);
-  const dest = path.resolve(cwd, outputDir);
+  const projectName = path2.basename(outputDir);
+  const dest = path2.resolve(cwd, outputDir);
   const isNext = options.template.startsWith("+next");
-  function isRelative(dir, file) {
-    return !path.relative(path.join(dest, dir), file).startsWith(`..${path.sep}`);
-  }
-  function defaultRename(file) {
-    file = file.replace("example.gitignore", ".gitignore");
-    if (!useSrcDir || !isNext) {
+  const pluginContext = {
+    template: templates.find((item) => item.value === template),
+    dest,
+    options
+  };
+  await copy(path2.join(sourceDir, `template/${template}`), dest, {
+    rename(file) {
+      file = file.replace("example.gitignore", ".gitignore");
+      if (useSrcDir && (path2.basename(file) === "mdx-components.tsx" || isRelative(path2.join(dest, "app"), file) || isRelative(path2.join(dest, "lib"), file))) {
+        return path2.join(dest, "src", path2.relative(dest, file));
+      }
       return file;
     }
-    if (path.basename(file) === "mdx-components.tsx" || isRelative("app", file) || isRelative("lib", file)) {
-      return path.join(dest, "src", path.relative(dest, file));
-    }
-    return file;
+  });
+  if (isNext && lint) {
+    await copy(path2.join(sourceDir, `template/+next+${lint}`), dest);
+    log("Configured Linter");
   }
-  if (isNext) {
-    await copy(path.join(sourceDir, `template/+next`), dest, defaultRename);
-    await copy(
-      path.join(sourceDir, `template/${template}`),
-      dest,
-      defaultRename
-    );
-    if (tailwindcss) {
-      await copy(
-        path.join(sourceDir, `template/+next+tailwindcss`),
-        dest,
-        defaultRename
-      );
-      log("Configured Tailwind CSS");
-    }
-    if (lint) {
-      await copy(
-        path.join(sourceDir, `template/+next+${lint}`),
-        dest,
-        defaultRename
-      );
-      log("Configured Linter");
-    }
-    if (useSrcDir) {
-      const tsconfigPath = path.join(dest, "tsconfig.json");
-      const content = (await fs2.readFile(tsconfigPath)).toString();
-      const config = JSON.parse(content);
-      if (config.compilerOptions?.paths) {
-        Object.assign(config.compilerOptions.paths, {
-          "@/*": ["./src/*"]
-        });
-      }
-      await fs2.writeFile(tsconfigPath, JSON.stringify(config, null, 2));
+  if (isNext && useSrcDir) {
+    const tsconfigPath = path2.join(dest, "tsconfig.json");
+    const content = (await fs2.readFile(tsconfigPath)).toString();
+    const config = JSON.parse(content);
+    if (config.compilerOptions?.paths) {
+      Object.assign(config.compilerOptions.paths, {
+        "@/*": ["./src/*"]
+      });
     }
-  } else {
-    await copy(
-      path.join(sourceDir, `template/${template}`),
-      dest,
-      defaultRename
-    );
+    await fs2.writeFile(tsconfigPath, JSON.stringify(config, null, 2));
+  }
+  let packageJson = await createPackageJson(projectName, dest, options);
+  for (const plugin of plugins) {
+    const result = await plugin.packageJson?.call(pluginContext, packageJson);
+    if (result) packageJson = result;
   }
-  const packageJson = isNext ? await createNextPackageJson(projectName, options) : await createPackageJson(projectName, dest);
   await fs2.writeFile(
-    path.join(dest, "package.json"),
+    path2.join(dest, "package.json"),
     JSON.stringify(packageJson, null, 2)
   );
-  const readMe = await getReadme(dest, projectName);
-  await fs2.writeFile(path.join(dest, "README.md"), readMe);
+  let readme = await getReadme(dest, projectName);
+  for (const plugin of plugins) {
+    readme = await plugin.readme?.call(pluginContext, readme) ?? readme;
+  }
+  await fs2.writeFile(path2.join(dest, "README.md"), readme);
+  for (const plugin of plugins) {
+    await plugin.afterWrite?.call(pluginContext);
+  }
   if (installDeps) {
     try {
       await autoInstall(packageManager, dest);
@@ -247,124 +294,79 @@ async function create(createOptions) {
   }
 }
 async function getReadme(dest, projectName) {
-  const template = await fs2.readFile(path.join(dest, "README.md")).then((res) => res.toString());
+  const template = await fs2.readFile(path2.join(dest, "README.md")).then((res) => res.toString());
   return `# ${projectName}
 
 ${template}`;
 }
-async function copy(from, to, rename = (s) => s) {
-  const stats = await fs2.stat(from);
-  if (stats.isDirectory()) {
-    const files = await fs2.readdir(from);
-    await Promise.all(
-      files.map(
-        (file) => copy(path.join(from, file), rename(path.join(to, file)))
-      )
-    );
-  } else {
-    await fs2.mkdir(path.dirname(to), { recursive: true });
-    await fs2.copyFile(from, to);
-  }
-}
-async function createNextPackageJson(projectName, { template, lint, tailwindcss }) {
-  return {
-    name: projectName,
-    version: "0.0.0",
-    private: true,
-    scripts: {
-      build: "next build",
-      dev: "next dev --turbo",
-      start: "next start",
-      ...template === "+next+fuma-docs-mdx" && {
-        postinstall: "fumadocs-mdx"
-      },
-      ...lint && {
-        eslint: {
-          lint: "eslint"
-        },
-        biome: { lint: "biome check", format: "biome format --write" }
-      }[lint]
-    },
-    dependencies: {
-      ...pick(package_default.dependencies, [
-        "next",
-        "react",
-        "react-dom",
-        "lucide-react"
-      ]),
-      ...pick(versions, ["fumadocs-ui", "fumadocs-core"]),
-      ...{
-        "+next+content-collections": {
-          ...pick(package_default.dependencies, [
-            "@content-collections/mdx",
-            "@content-collections/core",
-            "@content-collections/next"
-          ]),
-          ...pick(versions, ["@fumadocs/content-collections"])
-        },
-        "+next+fuma-docs-mdx": pick(versions, ["fumadocs-mdx"]),
-        waku: null,
-        "tanstack-start": null,
-        "react-router": null
-      }[template]
-    },
-    devDependencies: {
-      ...pick(package_default.dependencies, [
-        "@types/node",
-        "@types/react",
-        "@types/react-dom",
-        "typescript",
-        "@types/mdx"
-      ]),
-      ...tailwindcss && pick(package_default.dependencies, [
-        "@tailwindcss/postcss",
-        "tailwindcss",
-        "postcss"
-      ]),
-      ...lint && {
-        eslint: {
-          eslint: "^9",
-          "eslint-config-next": package_default.dependencies.next,
-          "@eslint/eslintrc": "^3"
-        },
-        biome: pick(package_default.dependencies, ["@biomejs/biome"])
-      }[lint]
-    }
-  };
-}
-async function createPackageJson(projectName, dir) {
+async function createPackageJson(projectName, dir, { template, lint }) {
+  const isNext = template.startsWith("+next");
   function replaceWorkspaceDeps(deps) {
     for (const k in deps) {
-      if (deps[k].startsWith("workspace:") && k in versions) {
-        deps[k] = versions[k];
+      if (deps[k].startsWith("workspace:") && k in depVersions) {
+        deps[k] = depVersions[k];
       }
     }
     return deps;
   }
-  const packageJson = JSON.parse(
-    await fs2.readFile(path.join(dir, "package.json")).then((res) => res.toString())
+  let packageJson = JSON.parse(
+    await fs2.readFile(path2.join(dir, "package.json")).then((res) => res.toString())
   );
-  return {
+  packageJson = {
     name: projectName,
     ...packageJson,
     dependencies: replaceWorkspaceDeps(packageJson.dependencies),
     devDependencies: replaceWorkspaceDeps(packageJson.devDependencies)
   };
-}
-function pick(obj, keys) {
-  const result = {};
-  for (const key of keys) {
-    if (key in obj) {
-      result[key] = obj[key];
-    }
+  if (isNext) {
+    packageJson = {
+      ...packageJson,
+      scripts: {
+        ...packageJson.scripts,
+        postinstall: "fumadocs-mdx"
+      }
+    };
   }
-  return result;
+  if (isNext && lint === "biome") {
+    packageJson = {
+      ...packageJson,
+      scripts: {
+        ...packageJson.scripts,
+        lint: "biome check",
+        format: "biome format --write"
+      },
+      devDependencies: {
+        ...packageJson.devDependencies,
+        ...pick(depVersions, ["@biomejs/biome"])
+      }
+    };
+  }
+  if (isNext && lint === "eslint") {
+    packageJson = {
+      ...packageJson,
+      scripts: {
+        ...packageJson.scripts,
+        lint: "eslint"
+      },
+      devDependencies: {
+        ...packageJson.devDependencies,
+        eslint: "^9",
+        "eslint-config-next": depVersions.next,
+        "@eslint/eslintrc": "^3"
+      }
+    };
+  }
+  return packageJson;
 }
 
 export {
+  copy,
+  pick,
   managers,
   getPackageManager,
+  sourceDir,
   cwd,
   templates,
+  depVersions,
   create
 };

package/dist/create-app.d.ts

@@ -1,8 +1,25 @@
 type PackageManager = (typeof managers)[number];
 declare const managers: readonly ["npm", "yarn", "bun", "pnpm"];
 
-declare const templates: readonly ["+next+content-collections", "+next+fuma-docs-mdx", "react-router", "tanstack-start", "waku"];
-type Template = (typeof templates)[number];
+interface TemplateInfo {
+    label: string;
+    value: string;
+    hint?: string;
+    componentsDir: string;
+}
+declare const templates: ({
+    value: string;
+    label: string;
+    hint: string;
+    componentsDir: string;
+} | {
+    value: string;
+    label: string;
+    componentsDir: string;
+    hint?: undefined;
+})[];
+
+type Template = (typeof templates)[number]['value'];
 interface Options {
     outputDir: string;
     template: Template;
@@ -15,11 +32,6 @@ interface Options {
      * @defaultValue false
      */
     useSrcDir?: boolean;
-    /**
-     * (Next.js only) Configure Tailwind CSS
-     * @defaultValue true
-     */
-    tailwindcss?: boolean;
     /**
      * (Next.js Only) Configure Lint
      * @defaultValue false
@@ -28,7 +40,22 @@ interface Options {
     installDeps?: boolean;
     initializeGit?: boolean;
     log?: (message: string) => void;
+    plugins?: TemplatePlugin[];
+}
+interface TemplatePluginContext {
+    template: TemplateInfo;
+    options: Required<Options>;
+    /**
+     * output directory
+     */
+    dest: string;
+}
+type Awaitable<T> = T | Promise<T>;
+interface TemplatePlugin {
+    packageJson?: (this: TemplatePluginContext, packageJson: any) => Awaitable<void | any>;
+    afterWrite?: (this: TemplatePluginContext) => Awaitable<void>;
+    readme?: (this: TemplatePluginContext, content: string) => Awaitable<void | string>;
 }
 declare function create(createOptions: Options): Promise<void>;
 
-export { type Options, type Template, create, templates };
+export { type Options, type Template, type TemplatePlugin, type TemplatePluginContext, create };

package/dist/create-app.js

@@ -1,8 +1,6 @@
 import {
-  create,
-  templates
-} from "./chunk-YVEWA65C.js";
+  create
+} from "./chunk-6C2B326N.js";
 export {
-  create,
-  templates
+  create
 };