@intlayer/engine 9.0.0-canary.12

package/dist/esm/init/cms.mjs

@@ -0,0 +1,131 @@
+import { enableIntlayerEditorConfig, setIntlayerConfigRoutingMode } from "./utils/configManipulation.mjs";
+import { exists, readFileFromRoot, writeFileToRoot } from "./utils/fileSystem.mjs";
+import { colorize, colorizePath, logger, v, x } from "@intlayer/config/logger";
+import fg from "fast-glob";
+import * as ANSIColors from "@intlayer/config/colors";
+
+//#region src/init/cms.ts
+/**
+* Intlayer configuration file candidates, ordered by the precedence used when
+* resolving which file to mutate.
+*/
+const INTLAYER_CONFIG_FILE_CANDIDATES = [
+	"intlayer.config.ts",
+	"intlayer.config.mjs",
+	"intlayer.config.js",
+	"intlayer.config.cjs",
+	"intlayer.config.json"
+];
+/**
+* Environment files searched (most-preferred first) when persisting the CMS
+* credentials. The first existing match is reused; otherwise a `.env` file is
+* created at the project root.
+*/
+const ENV_FILE_CANDIDATES = [
+	".env",
+	".env.local",
+	".env.development"
+];
+/**
+* Resolves the first existing Intlayer configuration file at the project root,
+* or `undefined` when none is present.
+*/
+const findIntlayerConfigFile = async (rootDir) => {
+	for (const candidate of INTLAYER_CONFIG_FILE_CANDIDATES) if (await exists(rootDir, candidate)) return candidate;
+};
+/**
+* Locates the environment file the CMS credentials should be written to. Uses
+* `fast-glob` to detect an existing dotenv file at the project root, preferring
+* a plain `.env`; falls back to `.env` (to be created) when none exist.
+*/
+const findEnvFile = async (rootDir) => {
+	const matches = await fg([...ENV_FILE_CANDIDATES], {
+		cwd: rootDir,
+		dot: true,
+		deep: 1,
+		onlyFiles: true
+	});
+	return ENV_FILE_CANDIDATES.find((candidate) => matches.includes(candidate)) ?? ".env";
+};
+/**
+* Inserts or updates a `KEY=value` line in dotenv file content. An existing
+* assignment of the same key is replaced in place; otherwise the line is
+* appended with a trailing newline.
+*/
+const upsertEnvVariable = (content, key, value) => {
+	const line = `${key}=${value}`;
+	const keyMatcher = new RegExp(`^${key}=.*$`, "m");
+	if (keyMatcher.test(content)) return content.replace(keyMatcher, line);
+	return `${content}${content.length > 0 && !content.endsWith("\n") ? "\n" : ""}${line}\n`;
+};
+/**
+* Persists the CMS access-key credentials to the project's environment file as
+* `INTLAYER_CLIENT_ID` / `INTLAYER_CLIENT_SECRET`. The target file is detected
+* with {@link findEnvFile} and created when missing. Returns the relative path
+* of the file that was written.
+*/
+const writeCmsCredentialsToEnv = async (rootDir, { clientId, clientSecret }) => {
+	const envFile = await findEnvFile(rootDir);
+	let content = "";
+	if (await exists(rootDir, envFile)) content = await readFileFromRoot(rootDir, envFile);
+	let updatedContent = content;
+	updatedContent = upsertEnvVariable(updatedContent, "INTLAYER_CLIENT_ID", clientId);
+	updatedContent = upsertEnvVariable(updatedContent, "INTLAYER_CLIENT_SECRET", clientSecret);
+	await writeFileToRoot(rootDir, envFile, updatedContent);
+	logger(`${v} Saved Intlayer CMS credentials to ${colorizePath(envFile)} (${colorize("INTLAYER_CLIENT_ID", ANSIColors.GREY_LIGHT)}, ${colorize("INTLAYER_CLIENT_SECRET", ANSIColors.GREY_LIGHT)})`);
+	return envFile;
+};
+/**
+* Enables the Intlayer visual editor in the project's configuration file:
+* flips `editor.enabled` to `true` and wires `clientId` / `clientSecret` to the
+* matching environment variables. JSON configs cannot reference `process.env`,
+* so they are skipped with a warning. Returns the config file that was updated,
+* or `undefined` when no editable config was found.
+*/
+const enableEditorInConfig = async (rootDir) => {
+	const configFile = await findIntlayerConfigFile(rootDir);
+	if (!configFile) {
+		logger(`${x} Could not find an Intlayer configuration file to enable the editor.`, { level: "warn" });
+		return;
+	}
+	if (configFile.split(".").pop() === "json") {
+		logger(`${x} ${colorizePath(configFile)} is a JSON config and cannot reference environment variables. Enable the editor and set clientId/clientSecret manually.`, { level: "warn" });
+		return;
+	}
+	const content = await readFileFromRoot(rootDir, configFile);
+	const updatedContent = enableIntlayerEditorConfig(content);
+	if (updatedContent !== content) {
+		await writeFileToRoot(rootDir, configFile, updatedContent);
+		logger(`${v} Enabled the Intlayer editor in ${colorizePath(configFile)}`);
+	} else logger(`${v} ${colorizePath(configFile)} already has the Intlayer editor enabled`);
+	return configFile;
+};
+/**
+* Sets `routing.mode` in the project's Intlayer configuration file. Returns the
+* config file that was updated, or `undefined` when none was found.
+*/
+const setRoutingModeInConfig = async (rootDir, mode) => {
+	const configFile = await findIntlayerConfigFile(rootDir);
+	if (!configFile) return void 0;
+	const extension = configFile.split(".").pop();
+	const content = await readFileFromRoot(rootDir, configFile);
+	const updatedContent = setIntlayerConfigRoutingMode(content, extension, mode);
+	if (updatedContent !== content) {
+		await writeFileToRoot(rootDir, configFile, updatedContent);
+		logger(`${v} Set ${colorize(`routing.mode = '${mode}'`, ANSIColors.GREY_LIGHT)} in ${colorizePath(configFile)}`);
+	}
+	return configFile;
+};
+/**
+* Completes the CMS setup once credentials are received from the login flow:
+* writes them to the environment file and enables the editor in the Intlayer
+* configuration file.
+*/
+const setupCmsCredentials = async (rootDir, credentials) => {
+	await writeCmsCredentialsToEnv(rootDir, credentials);
+	await enableEditorInConfig(rootDir);
+};
+
+//#endregion
+export { INTLAYER_CONFIG_FILE_CANDIDATES, enableEditorInConfig, findEnvFile, setRoutingModeInConfig, setupCmsCredentials, writeCmsCredentialsToEnv };
+//# sourceMappingURL=cms.mjs.map

package/dist/esm/init/cms.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cms.mjs","names":[],"sources":["../../../src/init/cms.ts"],"sourcesContent":["import * as ANSIColors from '@intlayer/config/colors';\nimport { colorize, colorizePath, logger, v, x } from '@intlayer/config/logger';\nimport fg from 'fast-glob';\nimport {\n  enableIntlayerEditorConfig,\n  type RoutingMode,\n  setIntlayerConfigRoutingMode,\n} from './utils/configManipulation';\nimport { exists, readFileFromRoot, writeFileToRoot } from './utils/fileSystem';\n\n/**\n * Intlayer configuration file candidates, ordered by the precedence used when\n * resolving which file to mutate.\n */\nexport const INTLAYER_CONFIG_FILE_CANDIDATES = [\n  'intlayer.config.ts',\n  'intlayer.config.mjs',\n  'intlayer.config.js',\n  'intlayer.config.cjs',\n  'intlayer.config.json',\n] as const;\n\n/**\n * Environment files searched (most-preferred first) when persisting the CMS\n * credentials. The first existing match is reused; otherwise a `.env` file is\n * created at the project root.\n */\nconst ENV_FILE_CANDIDATES = ['.env', '.env.local', '.env.development'] as const;\n\n/** Credentials returned by the CMS login flow (access key pair). */\nexport type CmsCredentials = {\n  clientId: string;\n  clientSecret: string;\n};\n\n/**\n * Resolves the first existing Intlayer configuration file at the project root,\n * or `undefined` when none is present.\n */\nconst findIntlayerConfigFile = async (\n  rootDir: string\n): Promise<(typeof INTLAYER_CONFIG_FILE_CANDIDATES)[number] | undefined> => {\n  for (const candidate of INTLAYER_CONFIG_FILE_CANDIDATES) {\n    if (await exists(rootDir, candidate)) {\n      return candidate;\n    }\n  }\n\n  return undefined;\n};\n\n/**\n * Locates the environment file the CMS credentials should be written to. Uses\n * `fast-glob` to detect an existing dotenv file at the project root, preferring\n * a plain `.env`; falls back to `.env` (to be created) when none exist.\n */\nexport const findEnvFile = async (rootDir: string): Promise<string> => {\n  const matches = await fg([...ENV_FILE_CANDIDATES], {\n    cwd: rootDir,\n    dot: true,\n    deep: 1,\n    onlyFiles: true,\n  });\n\n  return (\n    ENV_FILE_CANDIDATES.find((candidate) => matches.includes(candidate)) ??\n    '.env'\n  );\n};\n\n/**\n * Inserts or updates a `KEY=value` line in dotenv file content. An existing\n * assignment of the same key is replaced in place; otherwise the line is\n * appended with a trailing newline.\n */\nconst upsertEnvVariable = (\n  content: string,\n  key: string,\n  value: string\n): string => {\n  const line = `${key}=${value}`;\n  const keyMatcher = new RegExp(`^${key}=.*$`, 'm');\n\n  if (keyMatcher.test(content)) {\n    return content.replace(keyMatcher, line);\n  }\n\n  const needsLeadingNewline = content.length > 0 && !content.endsWith('\\n');\n\n  return `${content}${needsLeadingNewline ? '\\n' : ''}${line}\\n`;\n};\n\n/**\n * Persists the CMS access-key credentials to the project's environment file as\n * `INTLAYER_CLIENT_ID` / `INTLAYER_CLIENT_SECRET`. The target file is detected\n * with {@link findEnvFile} and created when missing. Returns the relative path\n * of the file that was written.\n */\nexport const writeCmsCredentialsToEnv = async (\n  rootDir: string,\n  { clientId, clientSecret }: CmsCredentials\n): Promise<string> => {\n  const envFile = await findEnvFile(rootDir);\n\n  let content = '';\n  if (await exists(rootDir, envFile)) {\n    content = await readFileFromRoot(rootDir, envFile);\n  }\n\n  let updatedContent = content;\n  updatedContent = upsertEnvVariable(\n    updatedContent,\n    'INTLAYER_CLIENT_ID',\n    clientId\n  );\n  updatedContent = upsertEnvVariable(\n    updatedContent,\n    'INTLAYER_CLIENT_SECRET',\n    clientSecret\n  );\n\n  await writeFileToRoot(rootDir, envFile, updatedContent);\n  logger(\n    `${v} Saved Intlayer CMS credentials to ${colorizePath(envFile)} (${colorize('INTLAYER_CLIENT_ID', ANSIColors.GREY_LIGHT)}, ${colorize('INTLAYER_CLIENT_SECRET', ANSIColors.GREY_LIGHT)})`\n  );\n\n  return envFile;\n};\n\n/**\n * Enables the Intlayer visual editor in the project's configuration file:\n * flips `editor.enabled` to `true` and wires `clientId` / `clientSecret` to the\n * matching environment variables. JSON configs cannot reference `process.env`,\n * so they are skipped with a warning. Returns the config file that was updated,\n * or `undefined` when no editable config was found.\n */\nexport const enableEditorInConfig = async (\n  rootDir: string\n): Promise<string | undefined> => {\n  const configFile = await findIntlayerConfigFile(rootDir);\n\n  if (!configFile) {\n    logger(\n      `${x} Could not find an Intlayer configuration file to enable the editor.`,\n      { level: 'warn' }\n    );\n    return undefined;\n  }\n\n  const extension = configFile.split('.').pop()!;\n\n  if (extension === 'json') {\n    logger(\n      `${x} ${colorizePath(configFile)} is a JSON config and cannot reference environment variables. Enable the editor and set clientId/clientSecret manually.`,\n      { level: 'warn' }\n    );\n    return undefined;\n  }\n\n  const content = await readFileFromRoot(rootDir, configFile);\n  const updatedContent = enableIntlayerEditorConfig(content);\n\n  if (updatedContent !== content) {\n    await writeFileToRoot(rootDir, configFile, updatedContent);\n    logger(`${v} Enabled the Intlayer editor in ${colorizePath(configFile)}`);\n  } else {\n    logger(\n      `${v} ${colorizePath(configFile)} already has the Intlayer editor enabled`\n    );\n  }\n\n  return configFile;\n};\n\n/**\n * Sets `routing.mode` in the project's Intlayer configuration file. Returns the\n * config file that was updated, or `undefined` when none was found.\n */\nexport const setRoutingModeInConfig = async (\n  rootDir: string,\n  mode: RoutingMode\n): Promise<string | undefined> => {\n  const configFile = await findIntlayerConfigFile(rootDir);\n\n  if (!configFile) return undefined;\n\n  const extension = configFile.split('.').pop()!;\n  const content = await readFileFromRoot(rootDir, configFile);\n  const updatedContent = setIntlayerConfigRoutingMode(content, extension, mode);\n\n  if (updatedContent !== content) {\n    await writeFileToRoot(rootDir, configFile, updatedContent);\n    logger(\n      `${v} Set ${colorize(`routing.mode = '${mode}'`, ANSIColors.GREY_LIGHT)} in ${colorizePath(configFile)}`\n    );\n  }\n\n  return configFile;\n};\n\n/**\n * Completes the CMS setup once credentials are received from the login flow:\n * writes them to the environment file and enables the editor in the Intlayer\n * configuration file.\n */\nexport const setupCmsCredentials = async (\n  rootDir: string,\n  credentials: CmsCredentials\n): Promise<void> => {\n  await writeCmsCredentialsToEnv(rootDir, credentials);\n  await enableEditorInConfig(rootDir);\n};\n"],"mappings":";;;;;;;;;;;AAcA,MAAa,kCAAkC;CAC7C;CACA;CACA;CACA;CACA;CACD;;;;;;AAOD,MAAM,sBAAsB;CAAC;CAAQ;CAAc;CAAmB;;;;;AAYtE,MAAM,yBAAyB,OAC7B,YAC0E;AAC1E,MAAK,MAAM,aAAa,gCACtB,KAAI,MAAM,OAAO,SAAS,UAAU,CAClC,QAAO;;;;;;;AAYb,MAAa,cAAc,OAAO,YAAqC;CACrE,MAAM,UAAU,MAAM,GAAG,CAAC,GAAG,oBAAoB,EAAE;EACjD,KAAK;EACL,KAAK;EACL,MAAM;EACN,WAAW;EACZ,CAAC;AAEF,QACE,oBAAoB,MAAM,cAAc,QAAQ,SAAS,UAAU,CAAC,IACpE;;;;;;;AASJ,MAAM,qBACJ,SACA,KACA,UACW;CACX,MAAM,OAAO,GAAG,IAAI,GAAG;CACvB,MAAM,aAAa,IAAI,OAAO,IAAI,IAAI,OAAO,IAAI;AAEjD,KAAI,WAAW,KAAK,QAAQ,CAC1B,QAAO,QAAQ,QAAQ,YAAY,KAAK;AAK1C,QAAO,GAAG,UAFkB,QAAQ,SAAS,KAAK,CAAC,QAAQ,SAAS,KAAK,GAE/B,OAAO,KAAK,KAAK;;;;;;;;AAS7D,MAAa,2BAA2B,OACtC,SACA,EAAE,UAAU,mBACQ;CACpB,MAAM,UAAU,MAAM,YAAY,QAAQ;CAE1C,IAAI,UAAU;AACd,KAAI,MAAM,OAAO,SAAS,QAAQ,CAChC,WAAU,MAAM,iBAAiB,SAAS,QAAQ;CAGpD,IAAI,iBAAiB;AACrB,kBAAiB,kBACf,gBACA,sBACA,SACD;AACD,kBAAiB,kBACf,gBACA,0BACA,aACD;AAED,OAAM,gBAAgB,SAAS,SAAS,eAAe;AACvD,QACE,GAAG,EAAE,qCAAqC,aAAa,QAAQ,CAAC,IAAI,SAAS,sBAAsB,WAAW,WAAW,CAAC,IAAI,SAAS,0BAA0B,WAAW,WAAW,CAAC,GACzL;AAED,QAAO;;;;;;;;;AAUT,MAAa,uBAAuB,OAClC,YACgC;CAChC,MAAM,aAAa,MAAM,uBAAuB,QAAQ;AAExD,KAAI,CAAC,YAAY;AACf,SACE,GAAG,EAAE,uEACL,EAAE,OAAO,QAAQ,CAClB;AACD;;AAKF,KAFkB,WAAW,MAAM,IAAI,CAAC,KAE3B,KAAK,QAAQ;AACxB,SACE,GAAG,EAAE,GAAG,aAAa,WAAW,CAAC,0HACjC,EAAE,OAAO,QAAQ,CAClB;AACD;;CAGF,MAAM,UAAU,MAAM,iBAAiB,SAAS,WAAW;CAC3D,MAAM,iBAAiB,2BAA2B,QAAQ;AAE1D,KAAI,mBAAmB,SAAS;AAC9B,QAAM,gBAAgB,SAAS,YAAY,eAAe;AAC1D,SAAO,GAAG,EAAE,kCAAkC,aAAa,WAAW,GAAG;OAEzE,QACE,GAAG,EAAE,GAAG,aAAa,WAAW,CAAC,0CAClC;AAGH,QAAO;;;;;;AAOT,MAAa,yBAAyB,OACpC,SACA,SACgC;CAChC,MAAM,aAAa,MAAM,uBAAuB,QAAQ;AAExD,KAAI,CAAC,WAAY,QAAO;CAExB,MAAM,YAAY,WAAW,MAAM,IAAI,CAAC,KAAK;CAC7C,MAAM,UAAU,MAAM,iBAAiB,SAAS,WAAW;CAC3D,MAAM,iBAAiB,6BAA6B,SAAS,WAAW,KAAK;AAE7E,KAAI,mBAAmB,SAAS;AAC9B,QAAM,gBAAgB,SAAS,YAAY,eAAe;AAC1D,SACE,GAAG,EAAE,OAAO,SAAS,mBAAmB,KAAK,IAAI,WAAW,WAAW,CAAC,MAAM,aAAa,WAAW,GACvG;;AAGH,QAAO;;;;;;;AAQT,MAAa,sBAAsB,OACjC,SACA,gBACkB;AAClB,OAAM,yBAAyB,SAAS,YAAY;AACpD,OAAM,qBAAqB,QAAQ"}

package/dist/esm/init/frameworkSetup/index.mjs

@@ -0,0 +1,26 @@
+import { nextAppRouterAdapter } from "./nextAppRouter/index.mjs";
+import { tanStackStartAdapter } from "./tanstackStart/index.mjs";
+
+//#region src/init/frameworkSetup/index.ts
+/**
+* Registered framework adapters, tried in order. The first one whose `detect`
+* returns true handles the project. Add new adapters (Nuxt, Vite + React, …)
+* here as they are implemented.
+*/
+const adapters = [nextAppRouterAdapter, tanStackStartAdapter];
+/**
+* Runs framework-specific scaffolding (middleware/proxy, providers in
+* layout/page, example content) for the first adapter that matches the project.
+* No-ops when no adapter recognizes the project. Each adapter is idempotent and
+* non-destructive, so this is safe to run on existing applications.
+*/
+const setupFramework = async (context) => {
+	for (const adapter of adapters) if (await adapter.detect(context)) {
+		await adapter.setup(context);
+		return;
+	}
+};
+
+//#endregion
+export { setupFramework };
+//# sourceMappingURL=index.mjs.map

package/dist/esm/init/frameworkSetup/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../../src/init/frameworkSetup/index.ts"],"sourcesContent":["import { nextAppRouterAdapter } from './nextAppRouter';\nimport { tanStackStartAdapter } from './tanstackStart';\nimport type { FrameworkAdapter, FrameworkSetupContext } from './types';\n\nexport type { FrameworkAdapter, FrameworkSetupContext } from './types';\n\n/**\n * Registered framework adapters, tried in order. The first one whose `detect`\n * returns true handles the project. Add new adapters (Nuxt, Vite + React, …)\n * here as they are implemented.\n */\nconst adapters: FrameworkAdapter[] = [\n  nextAppRouterAdapter,\n  tanStackStartAdapter,\n];\n\n/**\n * Runs framework-specific scaffolding (middleware/proxy, providers in\n * layout/page, example content) for the first adapter that matches the project.\n * No-ops when no adapter recognizes the project. Each adapter is idempotent and\n * non-destructive, so this is safe to run on existing applications.\n */\nexport const setupFramework = async (\n  context: FrameworkSetupContext\n): Promise<void> => {\n  for (const adapter of adapters) {\n    if (await adapter.detect(context)) {\n      await adapter.setup(context);\n      return;\n    }\n  }\n};\n"],"mappings":";;;;;;;;;AAWA,MAAM,WAA+B,CACnC,sBACA,qBACD;;;;;;;AAQD,MAAa,iBAAiB,OAC5B,YACkB;AAClB,MAAK,MAAM,WAAW,SACpB,KAAI,MAAM,QAAQ,OAAO,QAAQ,EAAE;AACjC,QAAM,QAAQ,MAAM,QAAQ;AAC5B"}

package/dist/esm/init/frameworkSetup/nextAppRouter/detect.mjs

@@ -0,0 +1,52 @@
+import { exists } from "../../utils/fileSystem.mjs";
+import { join } from "node:path";
+
+//#region src/init/frameworkSetup/nextAppRouter/detect.ts
+/** Script extensions probed when locating an App Router convention file. */
+const SCRIPT_EXTENSIONS = [
+	"tsx",
+	"jsx",
+	"ts",
+	"js"
+];
+/**
+* Detects the Next.js App Router directory, preferring `src/app` over `app`.
+* Returns `null` when neither exists (e.g. a Pages Router project).
+*/
+const detectNextAppDir = async (rootDir) => {
+	if (await exists(rootDir, join("src", "app"))) return {
+		appDir: join("src", "app"),
+		srcDir: "src"
+	};
+	if (await exists(rootDir, "app")) return {
+		appDir: "app",
+		srcDir: ""
+	};
+	return null;
+};
+/**
+* Finds an existing App Router convention file (e.g. `layout`, `page`) within
+* `dir`, trying each known script extension. Returns the matching relative path
+* or `null`.
+*/
+const findAppFile = async (rootDir, dir, baseName) => {
+	for (const extension of SCRIPT_EXTENSIONS) {
+		const candidate = join(dir, `${baseName}.${extension}`);
+		if (await exists(rootDir, candidate)) return candidate;
+	}
+	return null;
+};
+/**
+* Returns true when the dependency `version` range targets a major >= `major`.
+* Tolerant of leading range characters, e.g. `^16.0.0`, `~16`, `16.1.0`.
+*/
+const isVersionAtLeast = (version, major) => {
+	if (!version || typeof version !== "string") return false;
+	const match = version.match(/(\d+)/);
+	if (!match?.[1]) return false;
+	return parseInt(match[1], 10) >= major;
+};
+
+//#endregion
+export { detectNextAppDir, findAppFile, isVersionAtLeast };
+//# sourceMappingURL=detect.mjs.map

package/dist/esm/init/frameworkSetup/nextAppRouter/detect.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.mjs","names":[],"sources":["../../../../../src/init/frameworkSetup/nextAppRouter/detect.ts"],"sourcesContent":["import { join } from 'node:path';\nimport { exists } from '../../utils/fileSystem';\n\n/** Script extensions probed when locating an App Router convention file. */\nconst SCRIPT_EXTENSIONS = ['tsx', 'jsx', 'ts', 'js'] as const;\n\n/** Location of the Next.js App Router directory within the project. */\nexport type NextAppDirInfo = {\n  /** App Router directory relative to the root, e.g. `src/app` or `app`. */\n  appDir: string;\n  /** `src` when the project uses a `src/` directory, otherwise `''`. */\n  srcDir: string;\n};\n\n/**\n * Detects the Next.js App Router directory, preferring `src/app` over `app`.\n * Returns `null` when neither exists (e.g. a Pages Router project).\n */\nexport const detectNextAppDir = async (\n  rootDir: string\n): Promise<NextAppDirInfo | null> => {\n  if (await exists(rootDir, join('src', 'app'))) {\n    return { appDir: join('src', 'app'), srcDir: 'src' };\n  }\n  if (await exists(rootDir, 'app')) {\n    return { appDir: 'app', srcDir: '' };\n  }\n  return null;\n};\n\n/**\n * Finds an existing App Router convention file (e.g. `layout`, `page`) within\n * `dir`, trying each known script extension. Returns the matching relative path\n * or `null`.\n */\nexport const findAppFile = async (\n  rootDir: string,\n  dir: string,\n  baseName: string\n): Promise<string | null> => {\n  for (const extension of SCRIPT_EXTENSIONS) {\n    const candidate = join(dir, `${baseName}.${extension}`);\n    if (await exists(rootDir, candidate)) {\n      return candidate;\n    }\n  }\n  return null;\n};\n\n/**\n * Returns true when the dependency `version` range targets a major >= `major`.\n * Tolerant of leading range characters, e.g. `^16.0.0`, `~16`, `16.1.0`.\n */\nexport const isVersionAtLeast = (\n  version: string | undefined,\n  major: number\n): boolean => {\n  if (!version || typeof version !== 'string') return false;\n  const match = version.match(/(\\d+)/);\n  if (!match?.[1]) return false;\n  return parseInt(match[1], 10) >= major;\n};\n"],"mappings":";;;;;AAIA,MAAM,oBAAoB;CAAC;CAAO;CAAO;CAAM;CAAK;;;;;AAcpD,MAAa,mBAAmB,OAC9B,YACmC;AACnC,KAAI,MAAM,OAAO,SAAS,KAAK,OAAO,MAAM,CAAC,CAC3C,QAAO;EAAE,QAAQ,KAAK,OAAO,MAAM;EAAE,QAAQ;EAAO;AAEtD,KAAI,MAAM,OAAO,SAAS,MAAM,CAC9B,QAAO;EAAE,QAAQ;EAAO,QAAQ;EAAI;AAEtC,QAAO;;;;;;;AAQT,MAAa,cAAc,OACzB,SACA,KACA,aAC2B;AAC3B,MAAK,MAAM,aAAa,mBAAmB;EACzC,MAAM,YAAY,KAAK,KAAK,GAAG,SAAS,GAAG,YAAY;AACvD,MAAI,MAAM,OAAO,SAAS,UAAU,CAClC,QAAO;;AAGX,QAAO;;;;;;AAOT,MAAa,oBACX,SACA,UACY;AACZ,KAAI,CAAC,WAAW,OAAO,YAAY,SAAU,QAAO;CACpD,MAAM,QAAQ,QAAQ,MAAM,QAAQ;AACpC,KAAI,CAAC,QAAQ,GAAI,QAAO;AACxB,QAAO,SAAS,MAAM,IAAI,GAAG,IAAI"}

package/dist/esm/init/frameworkSetup/nextAppRouter/index.mjs

@@ -0,0 +1,104 @@
+import { ensureDirectory, exists, readFileFromRoot, writeFileToRoot } from "../../utils/fileSystem.mjs";
+import { detectNextAppDir, findAppFile, isVersionAtLeast } from "./detect.mjs";
+import { restructureAppIntoLocale } from "./restructure.mjs";
+import { LOCALE_LAYOUT_TEMPLATE_JS, LOCALE_LAYOUT_TEMPLATE_TS, LOCALE_PAGE_TEMPLATE_JS, LOCALE_PAGE_TEMPLATE_TS, MIDDLEWARE_TEMPLATE, PROXY_TEMPLATE, ROOT_LAYOUT_TEMPLATE_JS, ROOT_LAYOUT_TEMPLATE_TS } from "./templates.mjs";
+import { wrapLayoutWithProvider, wrapPageWithProvider } from "./transforms.mjs";
+import { join } from "node:path";
+import { colorize, colorizePath, logger, v, x } from "@intlayer/config/logger";
+import * as ANSIColors from "@intlayer/config/colors";
+
+//#region src/init/frameworkSetup/nextAppRouter/index.ts
+/**
+* Creates the locale-detection proxy (Next >= 16) or middleware (Next < 16),
+* but only when neither already exists, so a user's custom file is never
+* touched. Placed next to the app directory's parent (`src/` when present).
+*/
+const ensureProxyOrMiddleware = async (rootDir, srcDir, isNext16) => {
+	const baseDir = srcDir || ".";
+	for (const candidate of [
+		"proxy.ts",
+		"proxy.js",
+		"middleware.ts",
+		"middleware.js"
+	]) if (await exists(rootDir, join(baseDir, candidate))) {
+		logger(`${v} ${colorizePath(join(baseDir, candidate))} already exists, leaving it untouched`);
+		return;
+	}
+	const fileName = isNext16 ? "proxy.ts" : "middleware.ts";
+	const content = isNext16 ? PROXY_TEMPLATE : MIDDLEWARE_TEMPLATE;
+	const targetPath = join(baseDir, fileName);
+	if (srcDir) await ensureDirectory(rootDir, srcDir);
+	await writeFileToRoot(rootDir, targetPath, content);
+	logger(`${v} Created ${colorizePath(targetPath)} for locale detection`);
+};
+/** Logs the outcome of a layout/page provider-wrap transform. */
+const logTransformOutcome = (filePath, result) => {
+	switch (result.status) {
+		case "wrapped":
+			logger(`${v} Added Intlayer provider to ${colorizePath(filePath)}`);
+			break;
+		case "already":
+			logger(`${v} ${colorizePath(filePath)} already wraps the Intlayer provider`);
+			break;
+		case "skipped-client":
+			logger(`${x} ${colorizePath(filePath)} is a client component — add the Intlayer provider manually.`, { level: "warn" });
+			break;
+		case "skipped":
+			logger(`${x} Could not safely add the Intlayer provider to ${colorizePath(filePath)} — please wire it manually.`, { level: "warn" });
+			break;
+	}
+};
+/** Transforms an existing file in place, writing it back only when changed. */
+const transformExistingFile = async (rootDir, filePath, transform) => {
+	const result = transform(await readFileFromRoot(rootDir, filePath));
+	if (result.status === "wrapped") await writeFileToRoot(rootDir, filePath, result.code);
+	logTransformOutcome(filePath, result);
+};
+/** Creates a file from a template only when it does not already exist. */
+const createIfMissing = async (rootDir, filePath, content, description) => {
+	if (await exists(rootDir, filePath)) return false;
+	await writeFileToRoot(rootDir, filePath, content);
+	logger(`${v} Created ${description} ${colorizePath(filePath)}`);
+	return true;
+};
+/**
+* Next.js App Router adapter. Scaffolds the locale proxy/middleware, restructures
+* the app into a `[locale]` segment, and wraps the layout/page with the Intlayer
+* providers — all idempotently and without overwriting recognizable user code.
+*/
+const nextAppRouterAdapter = {
+	name: "Next.js App Router",
+	detect: async ({ rootDir, allDeps }) => {
+		if (!allDeps.next) return false;
+		return await detectNextAppDir(rootDir) !== null;
+	},
+	setup: async ({ rootDir, allDeps, useTypeScript }) => {
+		const appDirInfo = await detectNextAppDir(rootDir);
+		if (!appDirInfo) return;
+		const { appDir, srcDir } = appDirInfo;
+		const isNext16 = isVersionAtLeast(allDeps.next, 16);
+		const scriptExtension = useTypeScript ? "tsx" : "jsx";
+		logger(colorize("Setting up Next.js App Router integration...", ANSIColors.CYAN));
+		await ensureProxyOrMiddleware(rootDir, srcDir, isNext16);
+		const restructureResult = await restructureAppIntoLocale(rootDir, appDir);
+		if (restructureResult.status === "moved") logger(`${v} Restructured app routes under ${colorizePath(join(appDir, "[locale]"))}: ${restructureResult.movedEntries.map((entry) => colorize(entry, ANSIColors.MAGENTA)).join(", ")}`);
+		else if (restructureResult.status === "already-structured") logger(`${v} ${colorizePath(join(appDir, restructureResult.localeSegment))} already exists, skipping restructure`);
+		if (restructureResult.status === "already-structured" && restructureResult.localeSegment !== "[locale]") {
+			logger(`${v} Detected existing locale routing (${colorize(restructureResult.localeSegment, ANSIColors.MAGENTA)}), skipping locale layout/page scaffold`);
+			return;
+		}
+		const localeDir = join(appDir, "[locale]");
+		await ensureDirectory(rootDir, localeDir);
+		await createIfMissing(rootDir, join(appDir, `layout.${scriptExtension}`), useTypeScript ? ROOT_LAYOUT_TEMPLATE_TS : ROOT_LAYOUT_TEMPLATE_JS, "root layout");
+		const existingLayout = await findAppFile(rootDir, localeDir, "layout");
+		if (existingLayout) await transformExistingFile(rootDir, existingLayout, wrapLayoutWithProvider);
+		else await createIfMissing(rootDir, join(localeDir, `layout.${scriptExtension}`), useTypeScript ? LOCALE_LAYOUT_TEMPLATE_TS : LOCALE_LAYOUT_TEMPLATE_JS, "locale layout");
+		const existingPage = await findAppFile(rootDir, localeDir, "page");
+		if (existingPage) await transformExistingFile(rootDir, existingPage, wrapPageWithProvider);
+		else await createIfMissing(rootDir, join(localeDir, `page.${scriptExtension}`), useTypeScript ? LOCALE_PAGE_TEMPLATE_TS : LOCALE_PAGE_TEMPLATE_JS, "locale page");
+	}
+};
+
+//#endregion
+export { nextAppRouterAdapter };
+//# sourceMappingURL=index.mjs.map

package/dist/esm/init/frameworkSetup/nextAppRouter/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../../../src/init/frameworkSetup/nextAppRouter/index.ts"],"sourcesContent":["import { join } from 'node:path';\nimport * as ANSIColors from '@intlayer/config/colors';\nimport { colorize, colorizePath, logger, v, x } from '@intlayer/config/logger';\nimport {\n  ensureDirectory,\n  exists,\n  readFileFromRoot,\n  writeFileToRoot,\n} from '../../utils/fileSystem';\nimport type { FrameworkAdapter, FrameworkSetupContext } from '../types';\nimport { detectNextAppDir, findAppFile, isVersionAtLeast } from './detect';\nimport { restructureAppIntoLocale } from './restructure';\nimport {\n  LOCALE_LAYOUT_TEMPLATE_JS,\n  LOCALE_LAYOUT_TEMPLATE_TS,\n  LOCALE_PAGE_TEMPLATE_JS,\n  LOCALE_PAGE_TEMPLATE_TS,\n  MIDDLEWARE_TEMPLATE,\n  PROXY_TEMPLATE,\n  ROOT_LAYOUT_TEMPLATE_JS,\n  ROOT_LAYOUT_TEMPLATE_TS,\n} from './templates';\nimport {\n  type TransformResult,\n  wrapLayoutWithProvider,\n  wrapPageWithProvider,\n} from './transforms';\n\n/**\n * Creates the locale-detection proxy (Next >= 16) or middleware (Next < 16),\n * but only when neither already exists, so a user's custom file is never\n * touched. Placed next to the app directory's parent (`src/` when present).\n */\nconst ensureProxyOrMiddleware = async (\n  rootDir: string,\n  srcDir: string,\n  isNext16: boolean\n): Promise<void> => {\n  const baseDir = srcDir || '.';\n  const proxyCandidates = [\n    'proxy.ts',\n    'proxy.js',\n    'middleware.ts',\n    'middleware.js',\n  ];\n\n  for (const candidate of proxyCandidates) {\n    if (await exists(rootDir, join(baseDir, candidate))) {\n      logger(\n        `${v} ${colorizePath(join(baseDir, candidate))} already exists, leaving it untouched`\n      );\n      return;\n    }\n  }\n\n  const fileName = isNext16 ? 'proxy.ts' : 'middleware.ts';\n  const content = isNext16 ? PROXY_TEMPLATE : MIDDLEWARE_TEMPLATE;\n  const targetPath = join(baseDir, fileName);\n\n  if (srcDir) await ensureDirectory(rootDir, srcDir);\n  await writeFileToRoot(rootDir, targetPath, content);\n  logger(`${v} Created ${colorizePath(targetPath)} for locale detection`);\n};\n\n/** Logs the outcome of a layout/page provider-wrap transform. */\nconst logTransformOutcome = (\n  filePath: string,\n  result: TransformResult\n): void => {\n  switch (result.status) {\n    case 'wrapped':\n      logger(`${v} Added Intlayer provider to ${colorizePath(filePath)}`);\n      break;\n    case 'already':\n      logger(\n        `${v} ${colorizePath(filePath)} already wraps the Intlayer provider`\n      );\n      break;\n    case 'skipped-client':\n      logger(\n        `${x} ${colorizePath(filePath)} is a client component — add the Intlayer provider manually.`,\n        { level: 'warn' }\n      );\n      break;\n    case 'skipped':\n      logger(\n        `${x} Could not safely add the Intlayer provider to ${colorizePath(filePath)} — please wire it manually.`,\n        { level: 'warn' }\n      );\n      break;\n  }\n};\n\n/** Transforms an existing file in place, writing it back only when changed. */\nconst transformExistingFile = async (\n  rootDir: string,\n  filePath: string,\n  transform: (code: string) => TransformResult\n): Promise<void> => {\n  const code = await readFileFromRoot(rootDir, filePath);\n  const result = transform(code);\n  if (result.status === 'wrapped') {\n    await writeFileToRoot(rootDir, filePath, result.code);\n  }\n  logTransformOutcome(filePath, result);\n};\n\n/** Creates a file from a template only when it does not already exist. */\nconst createIfMissing = async (\n  rootDir: string,\n  filePath: string,\n  content: string,\n  description: string\n): Promise<boolean> => {\n  if (await exists(rootDir, filePath)) return false;\n  await writeFileToRoot(rootDir, filePath, content);\n  logger(`${v} Created ${description} ${colorizePath(filePath)}`);\n  return true;\n};\n\n/**\n * Next.js App Router adapter. Scaffolds the locale proxy/middleware, restructures\n * the app into a `[locale]` segment, and wraps the layout/page with the Intlayer\n * providers — all idempotently and without overwriting recognizable user code.\n */\nexport const nextAppRouterAdapter: FrameworkAdapter = {\n  name: 'Next.js App Router',\n\n  detect: async ({ rootDir, allDeps }) => {\n    if (!allDeps.next) return false;\n    return (await detectNextAppDir(rootDir)) !== null;\n  },\n\n  setup: async ({ rootDir, allDeps, useTypeScript }: FrameworkSetupContext) => {\n    const appDirInfo = await detectNextAppDir(rootDir);\n    if (!appDirInfo) return;\n\n    const { appDir, srcDir } = appDirInfo;\n    const isNext16 = isVersionAtLeast(allDeps.next, 16);\n    const scriptExtension = useTypeScript ? 'tsx' : 'jsx';\n\n    logger(\n      colorize('Setting up Next.js App Router integration...', ANSIColors.CYAN)\n    );\n\n    // 1. Locale detection proxy / middleware (create only when absent).\n    await ensureProxyOrMiddleware(rootDir, srcDir, isNext16);\n\n    // 2. Move routable files under a `[locale]` segment (idempotent).\n    const restructureResult = await restructureAppIntoLocale(rootDir, appDir);\n    if (restructureResult.status === 'moved') {\n      logger(\n        `${v} Restructured app routes under ${colorizePath(join(appDir, '[locale]'))}: ${restructureResult.movedEntries\n          .map((entry) => colorize(entry, ANSIColors.MAGENTA))\n          .join(', ')}`\n      );\n    } else if (restructureResult.status === 'already-structured') {\n      logger(\n        `${v} ${colorizePath(join(appDir, restructureResult.localeSegment))} already exists, skipping restructure`\n      );\n    }\n\n    // When the app already uses a different locale-prefix scheme (e.g. an\n    // `[...locale]` / `[[...locale]]` catch-all), respect the user's routing:\n    // don't scaffold a second, conflicting `[locale]` segment.\n    if (\n      restructureResult.status === 'already-structured' &&\n      restructureResult.localeSegment !== '[locale]'\n    ) {\n      logger(\n        `${v} Detected existing locale routing (${colorize(restructureResult.localeSegment, ANSIColors.MAGENTA)}), skipping locale layout/page scaffold`\n      );\n      return;\n    }\n\n    const localeDir = join(appDir, '[locale]');\n    await ensureDirectory(rootDir, localeDir);\n\n    // 3. Minimal pass-through root layout (the `[locale]` layout owns `<html>`).\n    await createIfMissing(\n      rootDir,\n      join(appDir, `layout.${scriptExtension}`),\n      useTypeScript ? ROOT_LAYOUT_TEMPLATE_TS : ROOT_LAYOUT_TEMPLATE_JS,\n      'root layout'\n    );\n\n    // 4. Locale layout — transform an existing one, else scaffold from template.\n    const existingLayout = await findAppFile(rootDir, localeDir, 'layout');\n    if (existingLayout) {\n      await transformExistingFile(\n        rootDir,\n        existingLayout,\n        wrapLayoutWithProvider\n      );\n    } else {\n      await createIfMissing(\n        rootDir,\n        join(localeDir, `layout.${scriptExtension}`),\n        useTypeScript ? LOCALE_LAYOUT_TEMPLATE_TS : LOCALE_LAYOUT_TEMPLATE_JS,\n        'locale layout'\n      );\n    }\n\n    // 5. Locale page — transform an existing one, else scaffold from template.\n    const existingPage = await findAppFile(rootDir, localeDir, 'page');\n    if (existingPage) {\n      await transformExistingFile(rootDir, existingPage, wrapPageWithProvider);\n    } else {\n      await createIfMissing(\n        rootDir,\n        join(localeDir, `page.${scriptExtension}`),\n        useTypeScript ? LOCALE_PAGE_TEMPLATE_TS : LOCALE_PAGE_TEMPLATE_JS,\n        'locale page'\n      );\n    }\n  },\n};\n"],"mappings":";;;;;;;;;;;;;;;AAiCA,MAAM,0BAA0B,OAC9B,SACA,QACA,aACkB;CAClB,MAAM,UAAU,UAAU;AAQ1B,MAAK,MAAM,aAAa;EANtB;EACA;EACA;EACA;EAGqC,CACrC,KAAI,MAAM,OAAO,SAAS,KAAK,SAAS,UAAU,CAAC,EAAE;AACnD,SACE,GAAG,EAAE,GAAG,aAAa,KAAK,SAAS,UAAU,CAAC,CAAC,uCAChD;AACD;;CAIJ,MAAM,WAAW,WAAW,aAAa;CACzC,MAAM,UAAU,WAAW,iBAAiB;CAC5C,MAAM,aAAa,KAAK,SAAS,SAAS;AAE1C,KAAI,OAAQ,OAAM,gBAAgB,SAAS,OAAO;AAClD,OAAM,gBAAgB,SAAS,YAAY,QAAQ;AACnD,QAAO,GAAG,EAAE,WAAW,aAAa,WAAW,CAAC,uBAAuB;;;AAIzE,MAAM,uBACJ,UACA,WACS;AACT,SAAQ,OAAO,QAAf;EACE,KAAK;AACH,UAAO,GAAG,EAAE,8BAA8B,aAAa,SAAS,GAAG;AACnE;EACF,KAAK;AACH,UACE,GAAG,EAAE,GAAG,aAAa,SAAS,CAAC,sCAChC;AACD;EACF,KAAK;AACH,UACE,GAAG,EAAE,GAAG,aAAa,SAAS,CAAC,+DAC/B,EAAE,OAAO,QAAQ,CAClB;AACD;EACF,KAAK;AACH,UACE,GAAG,EAAE,iDAAiD,aAAa,SAAS,CAAC,8BAC7E,EAAE,OAAO,QAAQ,CAClB;AACD;;;;AAKN,MAAM,wBAAwB,OAC5B,SACA,UACA,cACkB;CAElB,MAAM,SAAS,UAAU,MADN,iBAAiB,SAAS,SAAS,CACxB;AAC9B,KAAI,OAAO,WAAW,UACpB,OAAM,gBAAgB,SAAS,UAAU,OAAO,KAAK;AAEvD,qBAAoB,UAAU,OAAO;;;AAIvC,MAAM,kBAAkB,OACtB,SACA,UACA,SACA,gBACqB;AACrB,KAAI,MAAM,OAAO,SAAS,SAAS,CAAE,QAAO;AAC5C,OAAM,gBAAgB,SAAS,UAAU,QAAQ;AACjD,QAAO,GAAG,EAAE,WAAW,YAAY,GAAG,aAAa,SAAS,GAAG;AAC/D,QAAO;;;;;;;AAQT,MAAa,uBAAyC;CACpD,MAAM;CAEN,QAAQ,OAAO,EAAE,SAAS,cAAc;AACtC,MAAI,CAAC,QAAQ,KAAM,QAAO;AAC1B,SAAQ,MAAM,iBAAiB,QAAQ,KAAM;;CAG/C,OAAO,OAAO,EAAE,SAAS,SAAS,oBAA2C;EAC3E,MAAM,aAAa,MAAM,iBAAiB,QAAQ;AAClD,MAAI,CAAC,WAAY;EAEjB,MAAM,EAAE,QAAQ,WAAW;EAC3B,MAAM,WAAW,iBAAiB,QAAQ,MAAM,GAAG;EACnD,MAAM,kBAAkB,gBAAgB,QAAQ;AAEhD,SACE,SAAS,gDAAgD,WAAW,KAAK,CAC1E;AAGD,QAAM,wBAAwB,SAAS,QAAQ,SAAS;EAGxD,MAAM,oBAAoB,MAAM,yBAAyB,SAAS,OAAO;AACzE,MAAI,kBAAkB,WAAW,QAC/B,QACE,GAAG,EAAE,iCAAiC,aAAa,KAAK,QAAQ,WAAW,CAAC,CAAC,IAAI,kBAAkB,aAChG,KAAK,UAAU,SAAS,OAAO,WAAW,QAAQ,CAAC,CACnD,KAAK,KAAK,GACd;WACQ,kBAAkB,WAAW,qBACtC,QACE,GAAG,EAAE,GAAG,aAAa,KAAK,QAAQ,kBAAkB,cAAc,CAAC,CAAC,uCACrE;AAMH,MACE,kBAAkB,WAAW,wBAC7B,kBAAkB,kBAAkB,YACpC;AACA,UACE,GAAG,EAAE,qCAAqC,SAAS,kBAAkB,eAAe,WAAW,QAAQ,CAAC,yCACzG;AACD;;EAGF,MAAM,YAAY,KAAK,QAAQ,WAAW;AAC1C,QAAM,gBAAgB,SAAS,UAAU;AAGzC,QAAM,gBACJ,SACA,KAAK,QAAQ,UAAU,kBAAkB,EACzC,gBAAgB,0BAA0B,yBAC1C,cACD;EAGD,MAAM,iBAAiB,MAAM,YAAY,SAAS,WAAW,SAAS;AACtE,MAAI,eACF,OAAM,sBACJ,SACA,gBACA,uBACD;MAED,OAAM,gBACJ,SACA,KAAK,WAAW,UAAU,kBAAkB,EAC5C,gBAAgB,4BAA4B,2BAC5C,gBACD;EAIH,MAAM,eAAe,MAAM,YAAY,SAAS,WAAW,OAAO;AAClE,MAAI,aACF,OAAM,sBAAsB,SAAS,cAAc,qBAAqB;MAExE,OAAM,gBACJ,SACA,KAAK,WAAW,QAAQ,kBAAkB,EAC1C,gBAAgB,0BAA0B,yBAC1C,cACD;;CAGN"}

package/dist/esm/init/frameworkSetup/nextAppRouter/restructure.mjs

@@ -0,0 +1,157 @@
+import { __require } from "../../../_virtual/_rolldown/runtime.mjs";
+import { mkdir, readFile, readdir, rename, writeFile } from "node:fs/promises";
+import { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
+import fg from "fast-glob";
+import * as recast from "recast";
+
+//#region src/init/frameworkSetup/nextAppRouter/restructure.ts
+const { namedTypes: n } = recast.types;
+/** Source file extensions whose relative imports must be rewritten after a move. */
+const SCRIPT_GLOB = "**/*.{ts,tsx,js,jsx,mjs,cjs}";
+/** Strips a known script extension from a file name, e.g. `page.tsx` -> `page`. */
+const stripScriptExtension = (fileName) => fileName.replace(/\.(tsx|ts|jsx|js|mjs|cjs)$/, "");
+/**
+* Detects whether a top-level App Router entry is already a locale segment, in
+* any of the Next.js dynamic-segment forms:
+* - `[locale]` — required segment (prefix every locale),
+* - `[...locale]` / `[[...locale]]` — catch-all / optional catch-all segments.
+*
+* Used to skip the restructure when the project is already locale-aware, so an
+* existing locale segment is never nested under a freshly created `[locale]`.
+*/
+const isLocaleSegment = (entryName) => /^\[\[?\.{0,3}locale\]\]?$/.test(entryName);
+/**
+* Top-level App Router entries that must stay at the app root and never be
+* moved under `[locale]`:
+* - `api/` route handlers (not locale-prefixed),
+* - global stylesheets,
+* - metadata/asset file conventions (favicon, icon, sitemap, robots, manifest…),
+* - `global-error` and `not-found` boundaries (kept as root fallbacks).
+*
+* Everything else (`page`, `loading`, `error`, `template`, `default`, the root
+* `layout`, and nested route folders) is moved so it becomes locale-aware.
+*/
+const shouldKeepAppEntryAtRoot = (entryName) => {
+	if (entryName === "api") return true;
+	if (entryName.toLowerCase().endsWith(".css")) return true;
+	if (entryName === "favicon.ico") return true;
+	const base = stripScriptExtension(entryName);
+	if (new Set([
+		"not-found",
+		"global-error",
+		"sitemap",
+		"robots",
+		"manifest"
+	]).has(base)) return true;
+	if ([
+		"favicon",
+		"icon",
+		"apple-icon",
+		"opengraph-image",
+		"twitter-image"
+	].some((prefix) => base.startsWith(prefix))) return true;
+	return false;
+};
+/**
+* Maps an import target's pre-move absolute path to its post-move absolute path.
+* Targets that live inside a moved top-level entry are relocated under
+* `[locale]`; targets that stayed at the app root or live outside the app
+* directory are returned unchanged.
+*/
+const mapTargetPath = (oldTargetAbs, { appDirAbs, localeDirAbs, movedTopLevelNames }) => {
+	const relFromApp = relative(appDirAbs, oldTargetAbs);
+	if (relFromApp.startsWith("..") || isAbsolute(relFromApp)) return oldTargetAbs;
+	const firstSegment = relFromApp.split(sep)[0] ?? "";
+	if (!movedTopLevelNames.some((name) => name === firstSegment || stripScriptExtension(name) === firstSegment)) return oldTargetAbs;
+	return join(localeDirAbs, relFromApp);
+};
+/**
+* Rewrites relative import/export/`import()`/`require()` specifiers in a file
+* that has moved from `oldAbs` to `newAbs`, so they keep resolving to the same
+* modules after the move. Non-relative specifiers (bare packages, `@/` aliases)
+* are left untouched. Returns the original code unchanged when nothing matched.
+*/
+const rewriteRelativeImports = (code, oldAbs, newAbs, context) => {
+	const ast = recast.parse(code, { parser: __require("recast/parsers/babel-ts") });
+	let changed = false;
+	const rewriteSource = (sourceNode) => {
+		if (!sourceNode || !n.StringLiteral.check(sourceNode)) return;
+		const specifier = sourceNode.value;
+		if (typeof specifier !== "string" || !specifier.startsWith(".")) return;
+		const newTargetAbs = mapTargetPath(resolve(dirname(oldAbs), specifier), context);
+		let newSpecifier = relative(dirname(newAbs), newTargetAbs).split(sep).join("/");
+		if (!newSpecifier.startsWith(".")) newSpecifier = `./${newSpecifier}`;
+		if (newSpecifier !== specifier) {
+			sourceNode.value = newSpecifier;
+			changed = true;
+		}
+	};
+	recast.visit(ast, {
+		visitImportDeclaration(path) {
+			rewriteSource(path.node.source);
+			return false;
+		},
+		visitExportAllDeclaration(path) {
+			rewriteSource(path.node.source);
+			return false;
+		},
+		visitExportNamedDeclaration(path) {
+			if (path.node.source) rewriteSource(path.node.source);
+			return false;
+		},
+		visitCallExpression(path) {
+			const { callee, arguments: args } = path.node;
+			const isDynamicImport = callee.type === "Import";
+			const isRequire = n.Identifier.check(callee) && callee.name === "require";
+			if ((isDynamicImport || isRequire) && args.length > 0) rewriteSource(args[0]);
+			this.traverse(path);
+		}
+	});
+	if (!changed) return code;
+	return recast.print(ast).code;
+};
+/**
+* Moves the routable App Router entries of `appDir` under a new `[locale]`
+* segment and rewrites relative imports in the moved files. Idempotent: it is a
+* no-op when the app is already locale-aware in any prefix mode (see
+* {@link isLocaleSegment}), which is reported via `localeSegment`. Root-only
+* files (see {@link shouldKeepAppEntryAtRoot}) are left in place.
+*/
+const restructureAppIntoLocale = async (rootDir, appDir) => {
+	const appDirAbs = join(rootDir, appDir);
+	const localeDirAbs = join(appDirAbs, "[locale]");
+	const entries = await readdir(appDirAbs, { withFileTypes: true });
+	const existingLocaleSegment = entries.find((entry) => isLocaleSegment(entry.name));
+	if (existingLocaleSegment) return {
+		status: "already-structured",
+		localeSegment: existingLocaleSegment.name
+	};
+	const movedTopLevelNames = entries.map((entry) => entry.name).filter((name) => !shouldKeepAppEntryAtRoot(name));
+	if (movedTopLevelNames.length === 0) return { status: "nothing-to-move" };
+	await mkdir(localeDirAbs, { recursive: true });
+	for (const name of movedTopLevelNames) await rename(join(appDirAbs, name), join(localeDirAbs, name));
+	const movedFiles = await fg(SCRIPT_GLOB, {
+		cwd: localeDirAbs,
+		absolute: true,
+		onlyFiles: true
+	});
+	const rewriteContext = {
+		appDirAbs,
+		localeDirAbs,
+		movedTopLevelNames
+	};
+	for (const newAbs of movedFiles) {
+		const oldAbs = join(appDirAbs, relative(localeDirAbs, newAbs));
+		const code = await readFile(newAbs, "utf8");
+		const rewritten = rewriteRelativeImports(code, oldAbs, newAbs, rewriteContext);
+		if (rewritten !== code) await writeFile(newAbs, rewritten, "utf8");
+	}
+	return {
+		status: "moved",
+		movedEntries: movedTopLevelNames
+	};
+};
+
+//#endregion
+export { isLocaleSegment, restructureAppIntoLocale, rewriteRelativeImports, shouldKeepAppEntryAtRoot };
+//# sourceMappingURL=restructure.mjs.map

package/dist/esm/init/frameworkSetup/nextAppRouter/restructure.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"restructure.mjs","names":[],"sources":["../../../../../src/init/frameworkSetup/nextAppRouter/restructure.ts"],"sourcesContent":["import { mkdir, readdir, readFile, rename, writeFile } from 'node:fs/promises';\nimport { dirname, isAbsolute, join, relative, resolve, sep } from 'node:path';\nimport fg from 'fast-glob';\nimport * as recast from 'recast';\n\nconst { namedTypes: n } = recast.types;\n\n/** Source file extensions whose relative imports must be rewritten after a move. */\nconst SCRIPT_GLOB = '**/*.{ts,tsx,js,jsx,mjs,cjs}';\n\n/** Strips a known script extension from a file name, e.g. `page.tsx` -> `page`. */\nconst stripScriptExtension = (fileName: string): string =>\n  fileName.replace(/\\.(tsx|ts|jsx|js|mjs|cjs)$/, '');\n\n/**\n * Detects whether a top-level App Router entry is already a locale segment, in\n * any of the Next.js dynamic-segment forms:\n * - `[locale]` — required segment (prefix every locale),\n * - `[...locale]` / `[[...locale]]` — catch-all / optional catch-all segments.\n *\n * Used to skip the restructure when the project is already locale-aware, so an\n * existing locale segment is never nested under a freshly created `[locale]`.\n */\nexport const isLocaleSegment = (entryName: string): boolean =>\n  /^\\[\\[?\\.{0,3}locale\\]\\]?$/.test(entryName);\n\n/**\n * Top-level App Router entries that must stay at the app root and never be\n * moved under `[locale]`:\n * - `api/` route handlers (not locale-prefixed),\n * - global stylesheets,\n * - metadata/asset file conventions (favicon, icon, sitemap, robots, manifest…),\n * - `global-error` and `not-found` boundaries (kept as root fallbacks).\n *\n * Everything else (`page`, `loading`, `error`, `template`, `default`, the root\n * `layout`, and nested route folders) is moved so it becomes locale-aware.\n */\nexport const shouldKeepAppEntryAtRoot = (entryName: string): boolean => {\n  if (entryName === 'api') return true;\n  if (entryName.toLowerCase().endsWith('.css')) return true;\n  if (entryName === 'favicon.ico') return true;\n\n  const base = stripScriptExtension(entryName);\n  const keepExactBases = new Set([\n    'not-found',\n    'global-error',\n    'sitemap',\n    'robots',\n    'manifest',\n  ]);\n  if (keepExactBases.has(base)) return true;\n\n  // Image metadata conventions: favicon, icon, apple-icon, opengraph-image,\n  // twitter-image — optionally suffixed (e.g. `icon1`, `opengraph-image-alt`).\n  const imageConventionPrefixes = [\n    'favicon',\n    'icon',\n    'apple-icon',\n    'opengraph-image',\n    'twitter-image',\n  ];\n  if (imageConventionPrefixes.some((prefix) => base.startsWith(prefix))) {\n    return true;\n  }\n\n  return false;\n};\n\ntype RewriteContext = {\n  appDirAbs: string;\n  localeDirAbs: string;\n  movedTopLevelNames: string[];\n};\n\n/**\n * Maps an import target's pre-move absolute path to its post-move absolute path.\n * Targets that live inside a moved top-level entry are relocated under\n * `[locale]`; targets that stayed at the app root or live outside the app\n * directory are returned unchanged.\n */\nconst mapTargetPath = (\n  oldTargetAbs: string,\n  { appDirAbs, localeDirAbs, movedTopLevelNames }: RewriteContext\n): string => {\n  const relFromApp = relative(appDirAbs, oldTargetAbs);\n\n  // Outside the app directory (e.g. `../components/...`) — never moved.\n  if (relFromApp.startsWith('..') || isAbsolute(relFromApp)) {\n    return oldTargetAbs;\n  }\n\n  const firstSegment = relFromApp.split(sep)[0] ?? '';\n  const isMoved = movedTopLevelNames.some(\n    (name) =>\n      name === firstSegment || stripScriptExtension(name) === firstSegment\n  );\n\n  if (!isMoved) return oldTargetAbs;\n\n  return join(localeDirAbs, relFromApp);\n};\n\n/**\n * Rewrites relative import/export/`import()`/`require()` specifiers in a file\n * that has moved from `oldAbs` to `newAbs`, so they keep resolving to the same\n * modules after the move. Non-relative specifiers (bare packages, `@/` aliases)\n * are left untouched. Returns the original code unchanged when nothing matched.\n */\nexport const rewriteRelativeImports = (\n  code: string,\n  oldAbs: string,\n  newAbs: string,\n  context: RewriteContext\n): string => {\n  // babel-ts handles TypeScript *and* JSX (App Router files are `.tsx`).\n  const ast = recast.parse(code, {\n    parser: require('recast/parsers/babel-ts'),\n  });\n\n  let changed = false;\n\n  const rewriteSource = (sourceNode: any): void => {\n    if (!sourceNode || !n.StringLiteral.check(sourceNode)) return;\n    const specifier = sourceNode.value;\n    if (typeof specifier !== 'string' || !specifier.startsWith('.')) return;\n\n    const oldTargetAbs = resolve(dirname(oldAbs), specifier);\n    const newTargetAbs = mapTargetPath(oldTargetAbs, context);\n\n    let newSpecifier = relative(dirname(newAbs), newTargetAbs)\n      .split(sep)\n      .join('/');\n    if (!newSpecifier.startsWith('.')) {\n      newSpecifier = `./${newSpecifier}`;\n    }\n\n    if (newSpecifier !== specifier) {\n      sourceNode.value = newSpecifier;\n      changed = true;\n    }\n  };\n\n  recast.visit(ast, {\n    visitImportDeclaration(path) {\n      rewriteSource(path.node.source);\n      return false;\n    },\n    visitExportAllDeclaration(path) {\n      rewriteSource(path.node.source);\n      return false;\n    },\n    visitExportNamedDeclaration(path) {\n      if (path.node.source) rewriteSource(path.node.source);\n      return false;\n    },\n    visitCallExpression(path) {\n      const { callee, arguments: args } = path.node;\n      const isDynamicImport = callee.type === 'Import';\n      const isRequire = n.Identifier.check(callee) && callee.name === 'require';\n      if ((isDynamicImport || isRequire) && args.length > 0) {\n        rewriteSource(args[0]);\n      }\n      this.traverse(path);\n    },\n  });\n\n  if (!changed) return code;\n  return recast.print(ast).code;\n};\n\n/** Outcome of an attempted `[locale]` restructure. */\nexport type RestructureResult =\n  | { status: 'already-structured'; localeSegment: string }\n  | { status: 'nothing-to-move' }\n  | { status: 'moved'; movedEntries: string[] };\n\n/**\n * Moves the routable App Router entries of `appDir` under a new `[locale]`\n * segment and rewrites relative imports in the moved files. Idempotent: it is a\n * no-op when the app is already locale-aware in any prefix mode (see\n * {@link isLocaleSegment}), which is reported via `localeSegment`. Root-only\n * files (see {@link shouldKeepAppEntryAtRoot}) are left in place.\n */\nexport const restructureAppIntoLocale = async (\n  rootDir: string,\n  appDir: string\n): Promise<RestructureResult> => {\n  const appDirAbs = join(rootDir, appDir);\n  const localeDirAbs = join(appDirAbs, '[locale]');\n\n  const entries = await readdir(appDirAbs, { withFileTypes: true });\n\n  // Skip when the app is already locale-aware in any prefix mode — a fresh\n  // `[locale]`, or an existing `[...locale]` / `[[...locale]]` catch-all segment.\n  const existingLocaleSegment = entries.find((entry) =>\n    isLocaleSegment(entry.name)\n  );\n  if (existingLocaleSegment) {\n    return {\n      status: 'already-structured',\n      localeSegment: existingLocaleSegment.name,\n    };\n  }\n\n  const movedTopLevelNames = entries\n    .map((entry) => entry.name)\n    .filter((name) => !shouldKeepAppEntryAtRoot(name));\n\n  if (movedTopLevelNames.length === 0) {\n    return { status: 'nothing-to-move' };\n  }\n\n  await mkdir(localeDirAbs, { recursive: true });\n\n  for (const name of movedTopLevelNames) {\n    await rename(join(appDirAbs, name), join(localeDirAbs, name));\n  }\n\n  const movedFiles = await fg(SCRIPT_GLOB, {\n    cwd: localeDirAbs,\n    absolute: true,\n    onlyFiles: true,\n  });\n\n  const rewriteContext: RewriteContext = {\n    appDirAbs,\n    localeDirAbs,\n    movedTopLevelNames,\n  };\n\n  for (const newAbs of movedFiles) {\n    const relFromLocale = relative(localeDirAbs, newAbs);\n    const oldAbs = join(appDirAbs, relFromLocale);\n    const code = await readFile(newAbs, 'utf8');\n    const rewritten = rewriteRelativeImports(\n      code,\n      oldAbs,\n      newAbs,\n      rewriteContext\n    );\n    if (rewritten !== code) {\n      await writeFile(newAbs, rewritten, 'utf8');\n    }\n  }\n\n  return { status: 'moved', movedEntries: movedTopLevelNames };\n};\n"],"mappings":";;;;;;;AAKA,MAAM,EAAE,YAAY,MAAM,OAAO;;AAGjC,MAAM,cAAc;;AAGpB,MAAM,wBAAwB,aAC5B,SAAS,QAAQ,8BAA8B,GAAG;;;;;;;;;;AAWpD,MAAa,mBAAmB,cAC9B,4BAA4B,KAAK,UAAU;;;;;;;;;;;;AAa7C,MAAa,4BAA4B,cAA+B;AACtE,KAAI,cAAc,MAAO,QAAO;AAChC,KAAI,UAAU,aAAa,CAAC,SAAS,OAAO,CAAE,QAAO;AACrD,KAAI,cAAc,cAAe,QAAO;CAExC,MAAM,OAAO,qBAAqB,UAAU;AAQ5C,KAAI,IAPuB,IAAI;EAC7B;EACA;EACA;EACA;EACA;EACD,CACiB,CAAC,IAAI,KAAK,CAAE,QAAO;AAWrC,KAAI;EANF;EACA;EACA;EACA;EACA;EAEyB,CAAC,MAAM,WAAW,KAAK,WAAW,OAAO,CAAC,CACnE,QAAO;AAGT,QAAO;;;;;;;;AAeT,MAAM,iBACJ,cACA,EAAE,WAAW,cAAc,yBAChB;CACX,MAAM,aAAa,SAAS,WAAW,aAAa;AAGpD,KAAI,WAAW,WAAW,KAAK,IAAI,WAAW,WAAW,CACvD,QAAO;CAGT,MAAM,eAAe,WAAW,MAAM,IAAI,CAAC,MAAM;AAMjD,KAAI,CALY,mBAAmB,MAChC,SACC,SAAS,gBAAgB,qBAAqB,KAAK,KAAK,aAGhD,CAAE,QAAO;AAErB,QAAO,KAAK,cAAc,WAAW;;;;;;;;AASvC,MAAa,0BACX,MACA,QACA,QACA,YACW;CAEX,MAAM,MAAM,OAAO,MAAM,MAAM,EAC7B,kBAAgB,0BAA0B,EAC3C,CAAC;CAEF,IAAI,UAAU;CAEd,MAAM,iBAAiB,eAA0B;AAC/C,MAAI,CAAC,cAAc,CAAC,EAAE,cAAc,MAAM,WAAW,CAAE;EACvD,MAAM,YAAY,WAAW;AAC7B,MAAI,OAAO,cAAc,YAAY,CAAC,UAAU,WAAW,IAAI,CAAE;EAGjE,MAAM,eAAe,cADA,QAAQ,QAAQ,OAAO,EAAE,UACC,EAAE,QAAQ;EAEzD,IAAI,eAAe,SAAS,QAAQ,OAAO,EAAE,aAAa,CACvD,MAAM,IAAI,CACV,KAAK,IAAI;AACZ,MAAI,CAAC,aAAa,WAAW,IAAI,CAC/B,gBAAe,KAAK;AAGtB,MAAI,iBAAiB,WAAW;AAC9B,cAAW,QAAQ;AACnB,aAAU;;;AAId,QAAO,MAAM,KAAK;EAChB,uBAAuB,MAAM;AAC3B,iBAAc,KAAK,KAAK,OAAO;AAC/B,UAAO;;EAET,0BAA0B,MAAM;AAC9B,iBAAc,KAAK,KAAK,OAAO;AAC/B,UAAO;;EAET,4BAA4B,MAAM;AAChC,OAAI,KAAK,KAAK,OAAQ,eAAc,KAAK,KAAK,OAAO;AACrD,UAAO;;EAET,oBAAoB,MAAM;GACxB,MAAM,EAAE,QAAQ,WAAW,SAAS,KAAK;GACzC,MAAM,kBAAkB,OAAO,SAAS;GACxC,MAAM,YAAY,EAAE,WAAW,MAAM,OAAO,IAAI,OAAO,SAAS;AAChE,QAAK,mBAAmB,cAAc,KAAK,SAAS,EAClD,eAAc,KAAK,GAAG;AAExB,QAAK,SAAS,KAAK;;EAEtB,CAAC;AAEF,KAAI,CAAC,QAAS,QAAO;AACrB,QAAO,OAAO,MAAM,IAAI,CAAC;;;;;;;;;AAgB3B,MAAa,2BAA2B,OACtC,SACA,WAC+B;CAC/B,MAAM,YAAY,KAAK,SAAS,OAAO;CACvC,MAAM,eAAe,KAAK,WAAW,WAAW;CAEhD,MAAM,UAAU,MAAM,QAAQ,WAAW,EAAE,eAAe,MAAM,CAAC;CAIjE,MAAM,wBAAwB,QAAQ,MAAM,UAC1C,gBAAgB,MAAM,KAAK,CAC5B;AACD,KAAI,sBACF,QAAO;EACL,QAAQ;EACR,eAAe,sBAAsB;EACtC;CAGH,MAAM,qBAAqB,QACxB,KAAK,UAAU,MAAM,KAAK,CAC1B,QAAQ,SAAS,CAAC,yBAAyB,KAAK,CAAC;AAEpD,KAAI,mBAAmB,WAAW,EAChC,QAAO,EAAE,QAAQ,mBAAmB;AAGtC,OAAM,MAAM,cAAc,EAAE,WAAW,MAAM,CAAC;AAE9C,MAAK,MAAM,QAAQ,mBACjB,OAAM,OAAO,KAAK,WAAW,KAAK,EAAE,KAAK,cAAc,KAAK,CAAC;CAG/D,MAAM,aAAa,MAAM,GAAG,aAAa;EACvC,KAAK;EACL,UAAU;EACV,WAAW;EACZ,CAAC;CAEF,MAAM,iBAAiC;EACrC;EACA;EACA;EACD;AAED,MAAK,MAAM,UAAU,YAAY;EAE/B,MAAM,SAAS,KAAK,WADE,SAAS,cAAc,OACD,CAAC;EAC7C,MAAM,OAAO,MAAM,SAAS,QAAQ,OAAO;EAC3C,MAAM,YAAY,uBAChB,MACA,QACA,QACA,eACD;AACD,MAAI,cAAc,KAChB,OAAM,UAAU,QAAQ,WAAW,OAAO;;AAI9C,QAAO;EAAE,QAAQ;EAAS,cAAc;EAAoB"}