@farming-labs/docs 0.0.30 → 0.0.32

package/dist/cli/index.mjs

@@ -226,6 +226,14 @@ const THEME_INFO = {
 function getThemeInfo(theme) {
 	return THEME_INFO[theme] ?? THEME_INFO.fumadocs;
 }
+function renderI18nConfig(cfg, indent = "  ") {
+	const i18n = cfg.i18n;
+	if (!i18n || i18n.locales.length === 0) return "";
+	return `${indent}i18n: {\n${indent}  locales: [${i18n.locales.map((locale) => `"${locale}"`).join(", ")}],\n${indent}  defaultLocale: "${i18n.defaultLocale}",\n${indent}},\n`;
+}
+function toLocaleImportName(locale) {
+	return `LocalePage_${locale.replace(/[^a-zA-Z0-9_$]/g, "_")}`;
+}
 function getThemeExportName(themeName) {
 	const base = themeName.replace(/\.ts$/i, "").trim();
 	if (!base) return "customTheme";
@@ -315,7 +323,7 @@ import { ${exportName} } from "${cfg.useAlias ? "@/themes/" + cfg.customThemeNam
 
 export default defineDocs({
   entry: "${cfg.entry}",
-  theme: ${exportName}({
+  ${renderI18nConfig(cfg)}  theme: ${exportName}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -335,7 +343,7 @@ import { ${t.factory} } from "${t.nextImport}";
 
 export default defineDocs({
   entry: "${cfg.entry}",
-  theme: ${t.factory}({
+  ${renderI18nConfig(cfg)}  theme: ${t.factory}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -473,6 +481,48 @@ export default function Layout({ children }: { children: React.ReactNode }) {
 }
 `;
 }
+function nextLocaleDocPageTemplate(defaultLocale) {
+	return `\
+import type { ComponentType } from "react";
+
+type SearchParams = Promise<{ lang?: string | string[] | undefined }> | undefined;
+
+function normalizeLang(value: string | string[] | undefined) {
+  return Array.isArray(value) ? value[0] : value;
+}
+
+export async function resolveLocaleDocPage<T extends ComponentType>(
+  searchParams: SearchParams,
+  pages: Record<string, T>,
+  fallbackLocale = "${defaultLocale}",
+) {
+  const params = (await searchParams) ?? {};
+  const locale = normalizeLang(params.lang) ?? fallbackLocale;
+
+  return pages[locale] ?? pages[fallbackLocale];
+}
+`;
+}
+function nextLocalizedPageTemplate(options) {
+	const importLines = options.pageImports.map(({ locale, importPath }) => `import ${toLocaleImportName(locale)} from "${importPath}";`).join("\n");
+	const pageMap = options.pageImports.map(({ locale }) => `    ${JSON.stringify(locale)}: ${toLocaleImportName(locale)},`).join("\n");
+	return `\
+${importLines}
+import { resolveLocaleDocPage } from "${options.helperImport}";
+
+type PageProps = {
+  searchParams?: Promise<{ lang?: string | string[] | undefined }>;
+};
+
+export default async function ${options.componentName}({ searchParams }: PageProps) {
+  const Page = await resolveLocaleDocPage(searchParams, {
+${pageMap}
+  }, "${options.defaultLocale}");
+
+  return <Page />;
+}
+`;
+}
 function postcssConfigTemplate() {
 	return `\
 const config = {
@@ -696,7 +746,8 @@ import { ${exportName} } from "${"../../themes/" + cfg.customThemeName.replace(/
 
 export default defineDocs({
   entry: "${cfg.entry}",
-  theme: ${exportName}({
+  contentDir: "${cfg.entry}",
+  ${renderI18nConfig(cfg)}  theme: ${exportName}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -723,7 +774,8 @@ import { ${t.factory} } from "${t.svelteImport}";
 
 export default defineDocs({
   entry: "${cfg.entry}",
-  theme: ${t.factory}({
+  contentDir: "${cfg.entry}",
+  ${renderI18nConfig(cfg)}  theme: ${t.factory}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -1005,7 +1057,7 @@ import { ${exportName} } from "${"../../themes/" + cfg.customThemeName.replace(/
 export default defineDocs({
   entry: "${cfg.entry}",
   contentDir: "${cfg.entry}",
-  theme: ${exportName}({
+  ${renderI18nConfig(cfg)}  theme: ${exportName}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -1033,7 +1085,7 @@ import { ${t.factory} } from "${t.astroImport}";
 export default defineDocs({
   entry: "${cfg.entry}",
   contentDir: "${cfg.entry}",
-  theme: ${t.factory}({
+  ${renderI18nConfig(cfg)}  theme: ${t.factory}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -1361,7 +1413,7 @@ import { ${exportName} } from "${cfg.useAlias ? "~/themes/" + cfg.customThemeNam
 export default defineDocs({
   entry: "${cfg.entry}",
   contentDir: "${cfg.entry}",
-  theme: ${exportName}({
+  ${renderI18nConfig(cfg)}  theme: ${exportName}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -1389,7 +1441,7 @@ import { ${t.factory} } from "${t.nuxtImport}";
 export default defineDocs({
   entry: "${cfg.entry}",
   contentDir: "${cfg.entry}",
-  theme: ${t.factory}({
+  ${renderI18nConfig(cfg)}  theme: ${t.factory}({
     ui: {
       colors: { primary: "#6366f1" },
     },
@@ -1713,6 +1765,79 @@ const VALID_TEMPLATES = [
 	"sveltekit",
 	"astro"
 ];
+const COMMON_LOCALE_OPTIONS = [
+	{
+		value: "en",
+		label: "English",
+		hint: "en"
+	},
+	{
+		value: "fr",
+		label: "French",
+		hint: "fr"
+	},
+	{
+		value: "es",
+		label: "Spanish",
+		hint: "es"
+	},
+	{
+		value: "de",
+		label: "German",
+		hint: "de"
+	},
+	{
+		value: "pt",
+		label: "Portuguese",
+		hint: "pt"
+	},
+	{
+		value: "it",
+		label: "Italian",
+		hint: "it"
+	},
+	{
+		value: "ja",
+		label: "Japanese",
+		hint: "ja"
+	},
+	{
+		value: "ko",
+		label: "Korean",
+		hint: "ko"
+	},
+	{
+		value: "zh",
+		label: "Chinese",
+		hint: "zh"
+	},
+	{
+		value: "ar",
+		label: "Arabic",
+		hint: "ar"
+	},
+	{
+		value: "hi",
+		label: "Hindi",
+		hint: "hi"
+	},
+	{
+		value: "ru",
+		label: "Russian",
+		hint: "ru"
+	}
+];
+function normalizeLocaleCode(value) {
+	const trimmed = value.trim();
+	if (!trimmed) return "";
+	const [language, ...rest] = trimmed.split("-");
+	const normalizedLanguage = language.toLowerCase();
+	if (rest.length === 0) return normalizedLanguage;
+	return `${normalizedLanguage}-${rest.join("-").toUpperCase()}`;
+}
+function parseLocaleInput(input) {
+	return Array.from(new Set(input.split(",").map((value) => normalizeLocaleCode(value)).filter(Boolean)));
+}
 async function init(options = {}) {
 	const cwd = process.cwd();
 	p.intro(pc.bgCyan(pc.black(" @farming-labs/docs ")));
@@ -2032,6 +2157,64 @@ async function init(options = {}) {
 		process.exit(0);
 	}
 	const entryPath = entry.trim() || defaultEntry;
+	const enableI18n = await p.confirm({
+		message: "Do you want to scaffold internationalized docs with locale folders?",
+		initialValue: false
+	});
+	if (p.isCancel(enableI18n)) {
+		p.outro(pc.red("Init cancelled."));
+		process.exit(0);
+	}
+	let docsI18n;
+	if (enableI18n) {
+		const selectedLocales = await p.multiselect({
+			message: "Which languages should we scaffold?",
+			options: COMMON_LOCALE_OPTIONS.map((option) => ({
+				value: option.value,
+				label: option.label,
+				hint: option.hint
+			}))
+		});
+		if (p.isCancel(selectedLocales)) {
+			p.outro(pc.red("Init cancelled."));
+			process.exit(0);
+		}
+		const extraLocalesAnswer = await p.text({
+			message: "Any additional locale codes? (comma-separated, optional)",
+			placeholder: "nl, sv, pt-BR",
+			defaultValue: "",
+			validate: (value) => {
+				return parseLocaleInput(value ?? "").every((locale) => /^[a-z]{2,3}(?:-[A-Z]{2})?$/.test(locale)) ? void 0 : "Use locale codes like en, fr, zh, or pt-BR";
+			}
+		});
+		if (p.isCancel(extraLocalesAnswer)) {
+			p.outro(pc.red("Init cancelled."));
+			process.exit(0);
+		}
+		const locales = Array.from(new Set([...(selectedLocales ?? []).map((locale) => normalizeLocaleCode(locale)), ...parseLocaleInput(extraLocalesAnswer ?? "")])).filter(Boolean);
+		if (locales.length === 0) {
+			p.log.error("Pick at least one locale to scaffold i18n support.");
+			p.outro(pc.red("Init cancelled."));
+			process.exit(1);
+		}
+		const defaultLocaleAnswer = await p.select({
+			message: "Which locale should be the default?",
+			options: locales.map((locale) => ({
+				value: locale,
+				label: locale,
+				hint: locale === "en" ? "Recommended default" : void 0
+			})),
+			initialValue: locales[0]
+		});
+		if (p.isCancel(defaultLocaleAnswer)) {
+			p.outro(pc.red("Init cancelled."));
+			process.exit(0);
+		}
+		docsI18n = {
+			locales,
+			defaultLocale: defaultLocaleAnswer
+		};
+	}
 	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" : framework === "nextjs" ? `${nextAppDir}/globals.css` : "app/globals.css";
@@ -2078,6 +2261,7 @@ async function init(options = {}) {
 		framework,
 		useAlias,
 		astroAdapter,
+		i18n: docsI18n,
 		...framework === "nextjs" && { nextAppDir }
 	};
 	const s = p.spinner();
@@ -2219,6 +2403,9 @@ async function init(options = {}) {
 		process.exit(1);
 	}
 }
+function getScaffoldContentRoots(cfg) {
+	return cfg.i18n?.locales?.length ? cfg.i18n.locales.map((locale) => `${cfg.entry}/${locale}`) : [cfg.entry];
+}
 function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	const appDir = cfg.nextAppDir ?? "app";
 	if (cfg.theme === "custom" && cfg.customThemeName) {
@@ -2258,6 +2445,46 @@ function scaffoldNextJs(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	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));
+	if (cfg.i18n?.locales.length) {
+		write(`${appDir}/components/locale-doc-page.tsx`, nextLocaleDocPageTemplate(cfg.i18n.defaultLocale));
+		write(`${appDir}/${cfg.entry}/page.tsx`, nextLocalizedPageTemplate({
+			locales: cfg.i18n.locales,
+			defaultLocale: cfg.i18n.defaultLocale,
+			componentName: "DocsIndexPage",
+			helperImport: "../components/locale-doc-page",
+			pageImports: cfg.i18n.locales.map((locale) => ({
+				locale,
+				importPath: `./${locale}/page.mdx`
+			}))
+		}));
+		write(`${appDir}/${cfg.entry}/installation/page.tsx`, nextLocalizedPageTemplate({
+			locales: cfg.i18n.locales,
+			defaultLocale: cfg.i18n.defaultLocale,
+			componentName: "InstallationPage",
+			helperImport: "../../components/locale-doc-page",
+			pageImports: cfg.i18n.locales.map((locale) => ({
+				locale,
+				importPath: `../${locale}/installation/page.mdx`
+			}))
+		}));
+		write(`${appDir}/${cfg.entry}/quickstart/page.tsx`, nextLocalizedPageTemplate({
+			locales: cfg.i18n.locales,
+			defaultLocale: cfg.i18n.defaultLocale,
+			componentName: "QuickstartPage",
+			helperImport: "../../components/locale-doc-page",
+			pageImports: cfg.i18n.locales.map((locale) => ({
+				locale,
+				importPath: `../${locale}/quickstart/page.mdx`
+			}))
+		}));
+		for (const locale of cfg.i18n.locales) {
+			const base = `${appDir}/${cfg.entry}/${locale}`;
+			write(`${base}/page.mdx`, welcomePageTemplate(cfg));
+			write(`${base}/installation/page.mdx`, installationPageTemplate(cfg));
+			write(`${base}/quickstart/page.mdx`, quickstartPageTemplate(cfg));
+		}
+		return;
+	}
 	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));
@@ -2273,6 +2500,7 @@ function scaffoldSvelteKit(cwd, cfg, globalCssRelPath, write, skipped, written)
 	write(`src/routes/${cfg.entry}/+layout.svelte`, svelteDocsLayoutTemplate(cfg));
 	write(`src/routes/${cfg.entry}/+layout.server.js`, svelteDocsLayoutServerTemplate(cfg));
 	write(`src/routes/${cfg.entry}/[...slug]/+page.svelte`, svelteDocsPageTemplate(cfg));
+	if (cfg.i18n?.locales.length) write(`src/routes/${cfg.entry}/+page.svelte`, svelteDocsPageTemplate(cfg));
 	if (!readFileSafe(path.join(cwd, "src/routes/+layout.svelte"))) write("src/routes/+layout.svelte", svelteRootLayoutTemplate(globalCssRelPath));
 	const globalCssAbsPath = path.join(cwd, globalCssRelPath);
 	const existingGlobalCss = readFileSafe(globalCssAbsPath);
@@ -2293,9 +2521,11 @@ function scaffoldSvelteKit(cwd, cfg, globalCssRelPath, write, skipped, written)
 			written.push(globalCssRelPath + " (updated)");
 		} else skipped.push(globalCssRelPath + " (already configured)");
 	} else write(globalCssRelPath, cfg.theme === "custom" && cfg.customThemeName ? svelteGlobalCssTemplate("custom", cfg.customThemeName, globalCssRelPath) : svelteGlobalCssTemplate(cssTheme));
-	write(`${cfg.entry}/page.md`, svelteWelcomePageTemplate(cfg));
-	write(`${cfg.entry}/installation/page.md`, svelteInstallationPageTemplate(cfg));
-	write(`${cfg.entry}/quickstart/page.md`, svelteQuickstartPageTemplate(cfg));
+	for (const base of getScaffoldContentRoots(cfg)) {
+		write(`${base}/page.md`, svelteWelcomePageTemplate(cfg));
+		write(`${base}/installation/page.md`, svelteInstallationPageTemplate(cfg));
+		write(`${base}/quickstart/page.md`, svelteQuickstartPageTemplate(cfg));
+	}
 }
 function scaffoldAstro(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	if (cfg.theme === "custom" && cfg.customThemeName) {
@@ -2328,9 +2558,11 @@ function scaffoldAstro(cwd, cfg, globalCssRelPath, write, skipped, written) {
 			written.push(globalCssRelPath + " (updated)");
 		} else skipped.push(globalCssRelPath + " (already configured)");
 	} else write(globalCssRelPath, cfg.theme === "custom" && cfg.customThemeName ? astroGlobalCssTemplate("custom", cfg.customThemeName, globalCssRelPath) : astroGlobalCssTemplate(cssTheme));
-	write(`${cfg.entry}/page.md`, astroWelcomePageTemplate(cfg));
-	write(`${cfg.entry}/installation/page.md`, astroInstallationPageTemplate(cfg));
-	write(`${cfg.entry}/quickstart/page.md`, astroQuickstartPageTemplate(cfg));
+	for (const base of getScaffoldContentRoots(cfg)) {
+		write(`${base}/page.md`, astroWelcomePageTemplate(cfg));
+		write(`${base}/installation/page.md`, astroInstallationPageTemplate(cfg));
+		write(`${base}/quickstart/page.md`, astroQuickstartPageTemplate(cfg));
+	}
 }
 function scaffoldNuxt(cwd, cfg, globalCssRelPath, write, skipped, written) {
 	if (cfg.theme === "custom" && cfg.customThemeName) {
@@ -2365,9 +2597,11 @@ function scaffoldNuxt(cwd, cfg, globalCssRelPath, write, skipped, written) {
 			written.push(globalCssRelPath + " (updated)");
 		} else skipped.push(globalCssRelPath + " (already configured)");
 	} else write(globalCssRelPath, cfg.theme === "custom" && cfg.customThemeName ? nuxtGlobalCssTemplate("custom", cfg.customThemeName, globalCssRelPath) : nuxtGlobalCssTemplate(cssTheme));
-	write(`${cfg.entry}/page.md`, nuxtWelcomePageTemplate(cfg));
-	write(`${cfg.entry}/installation/page.md`, nuxtInstallationPageTemplate(cfg));
-	write(`${cfg.entry}/quickstart/page.md`, nuxtQuickstartPageTemplate(cfg));
+	for (const base of getScaffoldContentRoots(cfg)) {
+		write(`${base}/page.md`, nuxtWelcomePageTemplate(cfg));
+		write(`${base}/installation/page.md`, nuxtInstallationPageTemplate(cfg));
+		write(`${base}/quickstart/page.md`, nuxtQuickstartPageTemplate(cfg));
+	}
 }
 
 //#endregion

package/package.json

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