@fumadocs/cli 1.5.0 → 1.6.1

package/dist/index.js

@@ -1,12 +1,17 @@
 #!/usr/bin/env node
-import { createOrLoadConfig, initConfig } from "./config.js";
-import { t as FumadocsComponentInstaller } from "./installer-Ci3Hf9it.js";
+import { i as initConfig, n as createOrLoadConfig } from "./config-Bw0kmF01.js";
+import { T as parseSourceFile } from "./codemod-auol-p4R.js";
+import { t as exists } from "./fs-D6J9dOEx.js";
+import { i as loadProject, n as frameworks } from "./project-DwRVTm4p.js";
+import { n as isCancel$1, r as UIRegistries, t as FumadocsComponentInstaller } from "./installer-CzhVfs7i.js";
+import { t as runFeature } from "./features-CXFCgOWD.js";
+import { t as features } from "./all-BBf7I8hG.js";
 import fs from "node:fs/promises";
 import path from "node:path";
-import { Command } from "commander";
+import { cac } from "cac";
 import picocolors from "picocolors";
 import { x } from "tinyexec";
-import { autocompleteMultiselect, cancel, group, intro, isCancel, log, outro, select, spinner } from "@clack/prompts";
+import { autocompleteMultiselect, cancel, confirm, group, intro, log, note, outro, select, spinner } from "@clack/prompts";
 import { exec } from "node:child_process";
 import { promisify } from "node:util";
 import { HttpRegistryConnector, LocalRegistryConnector } from "fuma-cli/registry/connector";
@@ -61,13 +66,7 @@ async function runTree(args) {
 }
 //#endregion
 //#region package.json
-var version = "1.5.0";
-//#endregion
-//#region src/commands/shared.ts
-const UIRegistries = {
-	"base-ui": "fumadocs/base-ui",
-	"radix-ui": "fumadocs/radix-ui"
-};
+var version = "1.6.1";
 //#endregion
 //#region src/commands/customise.ts
 async function customise(config, connector) {
@@ -87,9 +86,7 @@ async function customise(config, connector) {
 							subRegistry,
 							name: "layouts/docs"
 						}],
-						print() {
-							printLayout(["fumadocs-ui/layouts/docs", "@/layouts/docs"], ["fumadocs-ui/layouts/docs/page", "@/layouts/docs/page"]);
-						}
+						print: () => printLayout(config, ["fumadocs-ui/layouts/docs", "@/layouts/docs"], ["fumadocs-ui/layouts/docs/page", "@/layouts/docs/page"])
 					},
 					hint: "the default docs layout"
 				},
@@ -101,9 +98,7 @@ async function customise(config, connector) {
 							subRegistry,
 							name: "layouts/notebook"
 						}],
-						print() {
-							printLayout(["fumadocs-ui/layouts/notebook", "@/layouts/notebook"], ["fumadocs-ui/layouts/notebook/page", "@/layouts/notebook/page"]);
-						}
+						print: () => printLayout(config, ["fumadocs-ui/layouts/notebook", "@/layouts/notebook"], ["fumadocs-ui/layouts/notebook/page", "@/layouts/notebook/page"])
 					},
 					hint: "a more compact version of docs layout"
 				},
@@ -115,9 +110,7 @@ async function customise(config, connector) {
 							subRegistry,
 							name: "layouts/flux"
 						}],
-						print() {
-							printLayout(["fumadocs-ui/layouts/flux", "@/layouts/flux"], ["fumadocs-ui/layouts/flux/page", "@/layouts/flux/page"]);
-						}
+						print: () => printLayout(config, ["fumadocs-ui/layouts/flux", "@/layouts/flux"], ["fumadocs-ui/layouts/flux/page", "@/layouts/flux/page"])
 					},
 					hint: "the experimental variant of docs layout"
 				},
@@ -129,9 +122,7 @@ async function customise(config, connector) {
 							subRegistry,
 							name: "layouts/glass"
 						}],
-						print() {
-							printLayout(["fumadocs-ui/layouts/glass", "@/layouts/glass"], ["fumadocs-ui/layouts/glass/page", "@/layouts/glass/page"]);
-						}
+						print: () => printLayout(config, ["fumadocs-ui/layouts/glass", "@/layouts/glass"], ["fumadocs-ui/layouts/glass/page", "@/layouts/glass/page"])
 					},
 					hint: "a docs layout with floating, translucent panels"
 				},
@@ -143,9 +134,7 @@ async function customise(config, connector) {
 							subRegistry,
 							name: "layouts/home"
 						}],
-						print() {
-							printLayout(["fumadocs-ui/layouts/home", `@/layouts/home`]);
-						}
+						print: () => printLayout(config, ["fumadocs-ui/layouts/home", "@/layouts/home"])
 					},
 					hint: "the layout for other non-docs pages"
 				}
@@ -168,9 +157,7 @@ async function customise(config, connector) {
 						value: {
 							id: "docs-min",
 							targets: [{ name: "layouts/docs-min" }],
-							print() {
-								printLayout(["fumadocs-ui/layouts/docs", "@/layouts/docs"], ["fumadocs-ui/layouts/docs/page", "@/layouts/docs/page"]);
-							}
+							print: () => printLayout(config, ["fumadocs-ui/layouts/docs", "@/layouts/docs"], ["fumadocs-ui/layouts/docs/page", "@/layouts/docs/page"])
 						}
 					},
 					...info.unlistedIndexes.flatMap((index) => {
@@ -229,15 +216,39 @@ async function customise(config, connector) {
 		process.exit(0);
 	} })).target;
 	for (const target of targetInfo.targets) await installer.installInteractive(target.name, target.subRegistry);
-	targetInfo.print?.();
+	await targetInfo.print?.();
 	outro(picocolors.bold("Have fun!"));
 }
-function printLayout(...maps) {
+/** point the imports of route files at the installed layouts */
+async function rewriteLayoutImports(config, map) {
+	const dir = path.join(config.baseDir, frameworks[config.framework].routesDir);
+	const entries = await fs.readdir(dir, {
+		recursive: true,
+		withFileTypes: true
+	}).catch(() => []);
+	const updated = [];
+	for (const entry of entries) {
+		if (!entry.isFile() || !entry.name.endsWith(".tsx")) continue;
+		const file = path.join(entry.parentPath, entry.name);
+		const source = parseSourceFile(file, await fs.readFile(file, "utf-8"));
+		for (const node of source.program.body) {
+			if (node.type !== "ImportDeclaration") continue;
+			const to = map.get(node.source.value);
+			if (to) source.s.overwrite(node.source.start + 1, node.source.end - 1, to);
+		}
+		if (!source.s.hasChanged()) continue;
+		await source.save();
+		updated.push(file);
+	}
+	return updated;
+}
+async function printLayout(config, ...maps) {
 	intro(picocolors.bold("What is Next?"));
+	const updated = await rewriteLayoutImports(config, new Map(maps));
 	log.info([
 		"You can check the installed layouts in `layouts` folder.",
 		picocolors.dim("---"),
-		"Open your `layout.tsx` files, replace the imports of components:",
+		updated.length > 0 ? `Updated the imports of ${updated.join(", ")}.` : "Open your `layout.tsx` files, replace the imports of components:",
 		...maps.map(([from, to]) => picocolors.greenBright(`"${from}" -> "${to}"`))
 	].join("\n"));
 }
@@ -474,7 +485,7 @@ async function add(input, connector, config) {
 			message: "Select components to install",
 			options: groups.flat().sort((a, b) => a.label.localeCompare(b.label))
 		});
-		if (isCancel(value)) {
+		if (isCancel$1(value)) {
 			outro("Ended");
 			return;
 		}
@@ -487,16 +498,6 @@ async function add(input, connector, config) {
 	outro(picocolors.bold(picocolors.greenBright("Successful")));
 }
 //#endregion
-//#region src/utils/fs.ts
-async function exists(pathLike) {
-	try {
-		await fs.access(pathLike);
-		return true;
-	} catch {
-		return false;
-	}
-}
-//#endregion
 //#region src/commands/export-epub.ts
 const execAsync = promisify(exec);
 async function readPackageJson(cwd) {
@@ -517,60 +518,6 @@ const EPUB_BUILD_PATHS = {
 	"react-router-spa": "build/client/export/epub",
 	waku: "dist/public/export/epub"
 };
-const API_ROUTE_TEMPLATE = `import { source } from '@/lib/source';
-import { exportEpub } from 'fumadocs-epub';
-
-export const revalidate = false;
-
-export async function GET(request: Request): Promise<Response> {
-  // Require EXPORT_SECRET to prevent unauthenticated abuse. Pass via Authorization: Bearer <secret>
-  const secret = process.env.EXPORT_SECRET;
-  if (!secret) {
-    return new Response('EXPORT_SECRET is not configured. Set it in your environment to protect this endpoint.', { status: 503 });
-  }
-  const authHeader = request.headers.get('authorization');
-  const token = authHeader?.replace(/^Bearer\\s+/i, '') ?? '';
-  if (token !== secret) {
-    return new Response('Unauthorized', { status: authHeader ? 403 : 401 });
-  }
-  const buffer = await exportEpub({
-    source,
-    title: 'Documentation',
-    author: 'Your Team',
-    description: 'Exported documentation',
-    cover: '/cover.png',
-  });
-  return new Response(new Uint8Array(buffer), {
-    headers: {
-      'Content-Type': 'application/epub+zip',
-      'Content-Disposition': 'attachment; filename="docs.epub"',
-    },
-  });
-}
-`;
-async function findAppDir(cwd) {
-	for (const appPath of ["app", "src/app"]) {
-		const fullPath = path.join(cwd, appPath);
-		if (await exists(fullPath)) return fullPath;
-	}
-	return null;
-}
-async function scaffoldEpubRoute(cwd) {
-	const appDir = await findAppDir(cwd);
-	if (!appDir) {
-		console.error(picocolors.red("Could not find app directory (app/ or src/app/)"));
-		return false;
-	}
-	const routePath = path.join(appDir, "export", "epub", "route.ts");
-	if (await exists(routePath)) {
-		console.log(picocolors.yellow("EPUB route already exists at"), routePath);
-		return true;
-	}
-	await fs.mkdir(path.dirname(routePath), { recursive: true });
-	await fs.writeFile(routePath, API_ROUTE_TEMPLATE);
-	console.log(picocolors.green("Created EPUB route at"), routePath);
-	return true;
-}
 async function exportEpub(options) {
 	const cwd = process.cwd();
 	const outputPath = path.resolve(cwd, options.output ?? "docs.epub");
@@ -583,39 +530,6 @@ async function exportEpub(options) {
 		process.exit(1);
 	}
 	const pkg = await readPackageJson(cwd);
-	const hasNextConfig = await exists(path.join(cwd, "next.config.js")) || await exists(path.join(cwd, "next.config.ts")) || await exists(path.join(cwd, "next.config.mjs"));
-	const hasNextInPkg = !!(pkg ? {
-		...pkg.dependencies,
-		...pkg.devDependencies,
-		...pkg.peerDependencies
-	} : {}).next;
-	const hasAppOrPages = await exists(path.join(cwd, "app")) || await exists(path.join(cwd, "pages")) || await exists(path.join(cwd, "src", "app")) || await exists(path.join(cwd, "src", "pages"));
-	if (!(hasNextConfig || hasNextInPkg && hasAppOrPages) && framework === "next") {
-		console.error(picocolors.red("Next.js project not found. Run this command from a Fumadocs Next.js project root."));
-		process.exit(1);
-	}
-	if (framework === "next") {
-		spin.start("Scaffolding EPUB route");
-		const scaffolded = await scaffoldEpubRoute(cwd);
-		spin.stop(scaffolded ? "EPUB route ready" : "Scaffolding failed");
-		if (!scaffolded) process.exit(1);
-	}
-	if (options.scaffoldOnly) {
-		console.log(picocolors.cyan("\nTo export:"));
-		console.log("  1. Add fumadocs-epub to your dependencies: pnpm add fumadocs-epub");
-		console.log("  2. Ensure includeProcessedMarkdown: true in your docs collection config");
-		if (framework === "next") {
-			console.log("  3. Set EXPORT_SECRET in your environment to protect the /export/epub endpoint");
-			console.log("  4. Run production build: pnpm build");
-			console.log("  5. Start the server (e.g. pnpm start) and keep it running");
-			console.log("  6. Run: fumadocs export epub --framework next");
-		} else {
-			console.log(`  3. Add a prerender route that outputs EPUB to ${buildPath}`);
-			console.log("  4. Run production build: pnpm build");
-			console.log(`  5. Run: fumadocs export epub --framework ${framework}`);
-		}
-		return;
-	}
 	if (!pkg) {
 		console.error(picocolors.red("Cannot read or parse package.json. Ensure it exists and is valid JSON."));
 		process.exit(1);
@@ -653,6 +567,7 @@ async function exportEpub(options) {
 			});
 			if (!res.ok) {
 				if (res.status === 401 || res.status === 403) console.error(picocolors.red("Auth failed. Check that EXPORT_SECRET matches the value in your app."));
+				else if (res.status === 404) console.error(picocolors.red("Export route not found, run `fumadocs feature epub` to create it."));
 				else console.error(picocolors.red(`Server returned ${res.status}. Ensure the app is running (e.g. pnpm start) on port ${port}.`));
 				process.exit(1);
 			}
@@ -684,31 +599,124 @@ async function exportEpub(options) {
 	spin.stop(picocolors.green(`EPUB saved to ${outputPath}`));
 }
 //#endregion
+//#region src/commands/feature.ts
+function registerFeatureCommands(cli, createConnector) {
+	const ids = features.map((feature) => feature.id).join(", ");
+	register(cli.command("feature <id>", `configure a feature on your project (${ids})`), features).action(async (id, options) => {
+		const feature = features.find((item) => item.id === id);
+		if (!feature) throw new Error(`unknown feature: ${id}, available: ${ids}`);
+		await run(feature, options, createConnector(options.dir));
+	});
+	register(cli.command("init", "set up Fumadocs on an existing app, same as `feature docs`"), [features[0]]).action(async (options) => {
+		await run(features[0], options, createConnector(options.dir));
+	});
+}
+function register(command, list) {
+	command.option("--dir <string>", "the root url or directory to resolve registry").option("-y, --yes", "skip prompts, overwrite existing files").option("--no-install", "write dependencies to package.json without installing");
+	for (const feature of list) for (const [key, option] of Object.entries(feature.options ?? {})) if ("choices" in option) command.option(`--${key} <value>`, `${option.message} (${option.choices.map((choice) => choice.value).join(", ")})`);
+	else command.option(`--${key}`, option.message);
+	return command;
+}
+async function run(feature, options, connector) {
+	intro(picocolors.bgBlack(picocolors.whiteBright(feature.title)));
+	const config = await createOrLoadConfig(options.config);
+	const project = await loadProject(config);
+	log.info(`${project.framework}${project.static ? " (static)" : ""}, ${project.packageManager}`);
+	const values = {};
+	for (const [key, option] of Object.entries(feature.options ?? {})) {
+		const given = options[key];
+		if ("choices" in option) {
+			if (given !== void 0) {
+				if (!option.choices.some((choice) => choice.value === given)) throw new Error(`invalid value for --${key}: ${given}`);
+				values[key] = given;
+				continue;
+			}
+			const value = await select({
+				message: option.message,
+				options: option.choices
+			});
+			if (isCancel$1(value)) {
+				cancel("Stopped.");
+				process.exit(0);
+			}
+			values[key] = value;
+		} else if (given !== void 0) values[key] = given === true;
+		else if (options.yes) values[key] = option.initialValue ?? false;
+		else {
+			const value = await confirm({
+				message: option.message,
+				initialValue: option.initialValue
+			});
+			if (isCancel$1(value)) {
+				cancel("Stopped.");
+				process.exit(0);
+			}
+			values[key] = value;
+		}
+	}
+	const spin = spinner();
+	const io = {
+		installDependencies: options.install !== false,
+		log: (message) => spin.message(message),
+		async confirmOverwrite(file) {
+			if (options.yes) return true;
+			spin.clear();
+			const value = await confirm({
+				message: `Overwrite ${file}?`,
+				initialValue: false
+			});
+			if (isCancel$1(value)) {
+				cancel("Stopped.");
+				process.exit(0);
+			}
+			spin.start();
+			return value;
+		}
+	};
+	spin.start(`Applying ${feature.title}`);
+	try {
+		const { notes } = await runFeature(feature, values, {
+			project,
+			connector,
+			io
+		});
+		spin.stop(`${feature.title} applied`);
+		if (notes.length > 0) note(notes.join("\n\n"), "What is Next?");
+	} catch (e) {
+		spin.error(e instanceof Error ? e.message : String(e));
+		process.exit(1);
+	}
+	outro(picocolors.bold(picocolors.greenBright("Done")));
+}
+//#endregion
 //#region src/index.ts
-const program = new Command().option("--config <string>");
-program.name("fumadocs").description("CLI to setup Fumadocs, init a config").version(version).action(async () => {
+const cli = cac("fumadocs");
+cli.option("--config <string>", "path to the config file");
+cli.command("", "init a `cli.json` config file").action(async () => {
 	if (await initConfig()) console.log(picocolors.green("Initialized a `./cli.json` config file."));
 	else console.log(picocolors.redBright("A config file already exists."));
 });
-program.command("customise").alias("customize").description("simple way to customize layouts with Fumadocs UI").option("--dir <string>", "the root url or directory to resolve registry").action(async (options) => {
+cli.command("customise", "simple way to customize layouts with Fumadocs UI").alias("customize").option("--dir <string>", "the root url or directory to resolve registry").action(async (options) => {
 	await customise(await createOrLoadConfig(options.config), createClientFromDir(options.dir));
 });
 const dirShortcuts = {
 	":preview": "https://preview.fumadocs.dev/registry",
 	":dev": "http://localhost:3000/registry"
 };
-program.command("add").description("add a new component to your docs").argument("[components...]", "components to download").option("--dir <string>", "the root url or directory to resolve registry").action(async (input, options) => {
+cli.command("add [...components]", "add a new component to your docs").option("--dir <string>", "the root url or directory to resolve registry").action(async (input, options) => {
 	const config = await createOrLoadConfig(options.config);
 	await add(input, createClientFromDir(options.dir), config);
 });
-program.command("export").description("export documentation to various formats").command("epub").description("export documentation to EPUB format (run after production build)").requiredOption("--framework <name>", "framework: next, astro, tanstack-start, react-router, waku").option("--output <path>", "output file path", "docs.epub").option("--scaffold-only", "only scaffold the EPUB route, do not copy").action(async (options) => {
+registerFeatureCommands(cli, createClientFromDir);
+cli.command("export <format>", "export documentation to various formats (run after production build)").option("--framework <name>", "framework: next, astro, tanstack-start, react-router, waku").option("--output <path>", "output file path", { default: "docs.epub" }).action(async (format, options) => {
+	if (format !== "epub") throw new Error(`unsupported format: ${format}, only \`epub\` is supported.`);
+	if (!options.framework) throw new Error("option `--framework <name>` is required.");
 	await exportEpub({
-		output: options.output,
 		framework: options.framework,
-		scaffoldOnly: options.scaffoldOnly
+		output: options.output
 	});
 });
-program.command("tree").argument("[json_or_args]", "JSON output of `tree` command or arguments for the `tree` command").argument("[output]", "output path of file").option("--js", "output as JavaScript file").option("--no-root", "remove the root node").option("--import-name <name>", "where to import components (JS only)").action(async (str, output, { js, root, importName }) => {
+cli.command("tree [json_or_args] [output]", "generate a file tree for the Files component, from a directory or JSON output of `tree`").option("--js", "output as JavaScript file").option("--no-root", "remove the root node").option("--import-name <name>", "where to import components (JS only)").action(async (str, output, { js, root, importName }) => {
 	const jsExtensions = [
 		".js",
 		".tsx",
@@ -731,7 +739,15 @@ function createClientFromDir(dir = "https://fumadocs.dev/registry") {
 	if (dir in dirShortcuts) dir = dirShortcuts[dir];
 	return dir.startsWith("http://") || dir.startsWith("https://") ? new HttpRegistryConnector(dir) : new LocalRegistryConnector(dir);
 }
-program.parse();
+cli.help();
+cli.version(version);
+try {
+	cli.parse(process.argv, { run: false });
+	await cli.runMatchedCommand();
+} catch (e) {
+	console.error(picocolors.redBright(e instanceof Error ? e.message : String(e)));
+	process.exit(1);
+}
 //#endregion
 export {};