@farming-labs/docs 0.0.20 → 0.0.22

package/dist/cli/index.mjs

@@ -79,6 +79,17 @@ function detectGlobalCssFiles(cwd) {
 	return GLOBAL_CSS_CANDIDATES.filter((rel) => fs.existsSync(path.join(cwd, rel)));
 }
 /**
+* Detect whether the Next.js project uses `app` or `src/app` for the App Router.
+* Returns the directory that exists; if both exist, prefers src/app; if neither, returns null.
+*/
+function detectNextAppDir(cwd) {
+	const hasSrcApp = fs.existsSync(path.join(cwd, "src", "app"));
+	const hasApp = fs.existsSync(path.join(cwd, "app"));
+	if (hasSrcApp) return "src/app";
+	if (hasApp) return "app";
+	return null;
+}
+/**
 * Run a shell command synchronously, inheriting stdio.
 */
 function exec(command, cwd) {
@@ -257,13 +268,15 @@ function customThemeCssTemplate(themeName) {
 }
 `;
 }
-/** Config import for Next.js app/layout.tsx → root docs.config */
-function nextRootLayoutConfigImport(useAlias) {
-	return useAlias ? "@/docs.config" : "../docs.config";
+/** Config import for Next.js root layout → root docs.config */
+function nextRootLayoutConfigImport(useAlias, nextAppDir = "app") {
+	if (useAlias) return "@/docs.config";
+	return nextAppDir === "src/app" ? "../../docs.config" : "../docs.config";
 }
 /** Config import for Next.js app/{entry}/layout.tsx → root docs.config */
-function nextDocsLayoutConfigImport(useAlias) {
-	return useAlias ? "@/docs.config" : "../../docs.config";
+function nextDocsLayoutConfigImport(useAlias, nextAppDir = "app") {
+	if (useAlias) return "@/docs.config";
+	return nextAppDir === "src/app" ? "../../../docs.config" : "../../docs.config";
 }
 /** Config import for SvelteKit src/lib/docs.server.ts → src/lib/docs.config */
 function svelteServerConfigImport(useAlias) {
@@ -363,10 +376,11 @@ function rootLayoutTemplate(cfg, globalCssRelPath = "app/globals.css") {
 	if (globalCssRelPath.startsWith("app/")) cssImport = "./" + globalCssRelPath.slice(4);
 	else if (globalCssRelPath.startsWith("src/app/")) cssImport = "./" + globalCssRelPath.slice(8);
 	else cssImport = "../" + globalCssRelPath;
+	const appDir = cfg.nextAppDir ?? "app";
 	return `\
 import type { Metadata } from "next";
 import { RootProvider } from "@farming-labs/theme";
-import docsConfig from "${nextRootLayoutConfigImport(cfg.useAlias)}";
+import docsConfig from "${nextRootLayoutConfigImport(cfg.useAlias, appDir)}";
 import "${cssImport}";
 
 export const metadata: Metadata = {
@@ -440,8 +454,9 @@ function injectCssImport(existingContent, theme, customThemeName, globalCssRelPa
 	return lines.join("\n");
 }
 function docsLayoutTemplate(cfg) {
+	const appDir = cfg.nextAppDir ?? "app";
 	return `\
-import docsConfig from "${nextDocsLayoutConfigImport(cfg.useAlias)}";
+import docsConfig from "${nextDocsLayoutConfigImport(cfg.useAlias, appDir)}";
 import { createDocsLayout, createDocsMetadata } from "@farming-labs/theme";
 
 export const metadata = createDocsMetadata(docsConfig);
@@ -494,6 +509,7 @@ function tsconfigTemplate(useAlias = false) {
 `;
 }
 function welcomePageTemplate(cfg) {
+	const appDir = cfg.nextAppDir ?? "app";
 	return `\
 ---
 title: "Documentation"
@@ -505,7 +521,7 @@ description: "Welcome to ${cfg.projectName} documentation"
 Get started with our documentation. Browse the pages on the left to learn more.
 
 <Callout type="info">
-  This documentation was generated by \`@farming-labs/docs\`. Edit the MDX files in \`app/${cfg.entry}/\` to customize.
+  This documentation was generated by \`@farming-labs/docs\`. Edit the MDX files in \`${appDir}/${cfg.entry}/\` to customize.
 </Callout>
 
 ## Overview
@@ -571,7 +587,7 @@ export default defineDocs({
 ## Project Structure
 
 \`\`\`
-app/
+${cfg.nextAppDir ?? "app"}/
   ${cfg.entry}/
     layout.tsx          # Docs layout
     page.mdx            # /${cfg.entry}
@@ -602,13 +618,13 @@ This guide walks you through creating your first documentation page.
 
 ## Creating a Page
 
-Create a new folder under \`app/${cfg.entry}/\` with a \`page.mdx\` file:
+Create a new folder under \`${cfg.nextAppDir ?? "app"}/${cfg.entry}/\` with a \`page.mdx\` file:
 
 \`\`\`bash
-mkdir -p app/${cfg.entry}/my-page
+mkdir -p ${cfg.nextAppDir ?? "app"}/${cfg.entry}/my-page
 \`\`\`
 
-Then create \`app/${cfg.entry}/my-page/page.mdx\`:
+Then create \`${cfg.nextAppDir ?? "app"}/${cfg.entry}/my-page/page.mdx\`:
 
 \`\`\`mdx
 ---
@@ -1832,6 +1848,7 @@ async function init(options = {}) {
 		}
 		const devCmd = pmFresh === "yarn" ? "yarn dev" : pmFresh === "npm" ? "npm run dev" : pmFresh === "bun" ? "bun dev" : "pnpm dev";
 		p.outro(pc.green(`Done! Run ${pc.cyan(`cd ${projectName} && ${devCmd}`)} to start the dev server and navigate to the /docs.`));
+		p.outro(pc.green("Happy documenting!"));
 		process.exit(0);
 	}
 	let framework = detectFramework(cwd);
@@ -1871,6 +1888,24 @@ async function init(options = {}) {
 		}
 		framework = picked;
 	}
+	let nextAppDir = "app";
+	if (framework === "nextjs") {
+		const detected = detectNextAppDir(cwd);
+		if (detected) {
+			nextAppDir = detected;
+			p.log.info(`Using App Router at ${pc.cyan(nextAppDir)} (detected ${detected === "src/app" ? "src directory" : "root app"})`);
+		} else {
+			const useSrcApp = await p.confirm({
+				message: "Do you use the src directory for the App Router? (e.g. src/app instead of app)",
+				initialValue: false
+			});
+			if (p.isCancel(useSrcApp)) {
+				p.outro(pc.red("Init cancelled."));
+				process.exit(0);
+			}
+			nextAppDir = useSrcApp ? "src/app" : "app";
+		}
+	}
 	const theme = await p.select({
 		message: "Which theme would you like to use?",
 		options: [
@@ -1998,7 +2033,7 @@ async function init(options = {}) {
 	const entryPath = entry.trim() || defaultEntry;
 	const detectedCssFiles = detectGlobalCssFiles(cwd);
 	let globalCssRelPath;
-	const defaultCssPath = framework === "sveltekit" ? "src/app.css" : framework === "astro" ? "src/styles/global.css" : framework === "nuxt" ? "assets/css/main.css" : "app/globals.css";
+	const defaultCssPath = framework === "sveltekit" ? "src/app.css" : framework === "astro" ? "src/styles/global.css" : framework === "nuxt" ? "assets/css/main.css" : framework === "nextjs" ? `${nextAppDir}/globals.css` : "app/globals.css";
 	if (detectedCssFiles.length === 1) {
 		globalCssRelPath = detectedCssFiles[0];
 		p.log.info(`Found global CSS at ${pc.cyan(globalCssRelPath)}`);
@@ -2041,7 +2076,8 @@ async function init(options = {}) {
 		projectName,
 		framework,
 		useAlias,
-		astroAdapter
+		astroAdapter,
+		...framework === "nextjs" && { nextAppDir }
 	};
 	const s = p.spinner();
 	s.start("Scaffolding docs files");
@@ -2183,6 +2219,7 @@ async function init(options = {}) {
 	}
 }
 function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
+	const appDir = cfg.nextAppDir ?? "app";
 	if (cfg.theme === "custom" && cfg.customThemeName) {
 		const baseName = cfg.customThemeName.replace(/\.(ts|css)$/i, "");
 		write(`themes/${baseName}.ts`, customThemeTsTemplate(baseName));
@@ -2198,16 +2235,16 @@ function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
 			written.push(configFile + " (updated)");
 		} else skipped.push(configFile + " (already configured)");
 	} else write("next.config.ts", nextConfigTemplate());
-	const rootLayoutPath = path.join(cwd, "app/layout.tsx");
+	const rootLayoutPath = path.join(cwd, `${appDir}/layout.tsx`);
 	const existingRootLayout = readFileSafe(rootLayoutPath);
-	if (!existingRootLayout) write("app/layout.tsx", rootLayoutTemplate(cfg, globalCssRelPath), true);
+	if (!existingRootLayout) write(`${appDir}/layout.tsx`, rootLayoutTemplate(cfg, globalCssRelPath), true);
 	else if (!existingRootLayout.includes("RootProvider")) {
 		const injected = injectRootProviderIntoLayout(existingRootLayout);
 		if (injected) {
 			writeFileSafe(rootLayoutPath, injected, true);
-			written.push("app/layout.tsx (injected RootProvider)");
-		} else skipped.push("app/layout.tsx (could not inject RootProvider)");
-	} else skipped.push("app/layout.tsx (already has RootProvider)");
+			written.push(`${appDir}/layout.tsx (injected RootProvider)`);
+		} else skipped.push(`${appDir}/layout.tsx (could not inject RootProvider)`);
+	} else skipped.push(`${appDir}/layout.tsx (already has RootProvider)`);
 	const globalCssAbsPath = path.join(cwd, globalCssRelPath);
 	const existingGlobalCss = readFileSafe(globalCssAbsPath);
 	if (existingGlobalCss) {
@@ -2217,12 +2254,12 @@ function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
 			written.push(globalCssRelPath + " (updated)");
 		} else skipped.push(globalCssRelPath + " (already configured)");
 	} else write(globalCssRelPath, globalCssTemplate(cfg.theme, cfg.customThemeName, globalCssRelPath));
-	write(`app/${cfg.entry}/layout.tsx`, docsLayoutTemplate(cfg));
+	write(`${appDir}/${cfg.entry}/layout.tsx`, docsLayoutTemplate(cfg));
 	write("postcss.config.mjs", postcssConfigTemplate());
 	if (!fileExists(path.join(cwd, "tsconfig.json"))) write("tsconfig.json", tsconfigTemplate(cfg.useAlias));
-	write(`app/${cfg.entry}/page.mdx`, welcomePageTemplate(cfg));
-	write(`app/${cfg.entry}/installation/page.mdx`, installationPageTemplate(cfg));
-	write(`app/${cfg.entry}/quickstart/page.mdx`, quickstartPageTemplate(cfg));
+	write(`${appDir}/${cfg.entry}/page.mdx`, welcomePageTemplate(cfg));
+	write(`${appDir}/${cfg.entry}/installation/page.mdx`, installationPageTemplate(cfg));
+	write(`${appDir}/${cfg.entry}/quickstart/page.mdx`, quickstartPageTemplate(cfg));
 }
 function scaffoldSvelteKit(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	if (cfg.theme === "custom" && cfg.customThemeName) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",