@intlayer/engine 9.5.9-canary.0 → 9.5.10

package/dist/esm/init/index.mjs

@@ -1,146 +1,27 @@
 import { getMetroConfigTemplate, hasIntlayerVitePlugin, replaceViteConfigPluginImportSource, updateAstroConfig, updateIntlayerConfigWithSyncPlugin, updateMetroConfig, updateNextConfig, updateNextConfigForNextI18next, updateNextConfigForNextIntl, updateNextConfigForNextTranslate, updateNuxtConfig, updateNuxtConfigForNuxtjsI18n, updateViteConfig, updateViteConfigForCompatPlugin } from "./utils/configManipulation.mjs";
 import { detectJsonLocalePattern, detectLinguiCatalogPattern, detectNextIntlMessagesPattern, ensureDirectory, exists, readFileFromRoot, writeFileToRoot } from "./utils/fileSystem.mjs";
-import { setCompilerOutputInConfig, setRoutingModeInConfig } from "./cms.mjs";
+import { setCompilerOutputInConfig, setEnableProxyInConfig, setRoutingModeInConfig, setRoutingStorageOnlyInConfig } from "./cms.mjs";
 import { initConfig } from "../initConfig/index.mjs";
+import { DocumentationRouter, getDocumentationUrl } from "./documentationRouter.mjs";
 import { setupFramework } from "./frameworkSetup/index.mjs";
 import { BACKEND_INTLAYER_PACKAGES, resolveDevScript } from "./utils/devScript.mjs";
-import { detectMissingIntlayerPackages, detectPackageManager, hasLintTooling, installPackages, isIntlayerPackageName, moveCompatPackagesToDevDependencies } from "./utils/packageManager.mjs";
+import { MINIMUM_ESLINT_MAJOR, detectCompatI18nLibraries, detectMissingIntlayerPackages, detectPackageManager, hasLegacyEslint, hasLintTooling, installPackages, isIntlayerPackageName, moveCompatPackagesToDevDependencies } from "./utils/packageManager.mjs";
 import { getGithubWorkflows, resolveGithubWorkflowsContext } from "./utils/githubActions.mjs";
 import { parseJSONWithComments } from "./utils/jsonParser.mjs";
+import { LINT_PLUGIN_PACKAGE_NAME, addIntlayerRulesToOxlintConfig } from "./utils/lintConfig.mjs";
 import { setupNextCompilerBabelConfig } from "./utils/nextCompilerBabel.mjs";
 import { findTsConfigFiles } from "./utils/tsConfig.mjs";
+import { hasUrlRoutingFramework } from "./utils/urlRoutingFramework.mjs";
 import { upgradeIntlayerPackages } from "./upgradeIntlayerPackages.mjs";
 import { join } from "node:path";
 import * as ANSIColors from "@intlayer/config/colors";
 import { colorize, colorizePath, logger, v, x } from "@intlayer/config/logger";
 import { getConfiguration } from "@intlayer/config/node";
+import { ROUTING_MODE } from "@intlayer/config/defaultValues";
 import { getAlias } from "@intlayer/config/utils";
 
 //#region src/init/index.ts
 /**
-* Documentation URL Constants
-*/
-const DocumentationRouter = {
-	NextJS: "https://intlayer.org/doc/environment/nextjs.md",
-	NextJS_15: "https://intlayer.org/doc/environment/nextjs/15.md",
-	NextJS_14: "https://intlayer.org/doc/environment/nextjs/14.md",
-	CRA: "https://intlayer.org/doc/environment/create-react-app.md",
-	Astro: "https://intlayer.org/doc/environment/astro.md",
-	ViteAndReact: "https://intlayer.org/doc/environment/vite-and-react.md",
-	ViteAndReact_ReactRouterV7: "https://intlayer.org/doc/environment/vite-and-react/react-router-v7.md",
-	ViteAndVue: "https://intlayer.org/doc/environment/vite-and-vue.md",
-	ViteAndSolid: "https://intlayer.org/doc/environment/vite-and-solid.md",
-	ViteAndSvelte: "https://intlayer.org/doc/environment/vite-and-svelte.md",
-	ViteAndPreact: "https://intlayer.org/doc/environment/vite-and-preact.md",
-	ViteAndLit: "https://intlayer.org/doc/environment/vite-and-lit.md",
-	ViteAndVanilla: "https://intlayer.org/doc/environment/vite-and-vanilla.md",
-	Vanilla: "https://intlayer.org/doc/environment/vanilla.md",
-	TanStackRouter: "https://intlayer.org/doc/environment/tanstack-start.md",
-	TanStackRouterAndSolid: "https://intlayer.org/doc/environment/tanstack-start/solid.md",
-	SolidStart: "https://intlayer.org/doc/environment/solid-start.md",
-	Analog: "https://intlayer.org/doc/environment/analog.md",
-	Remix: "https://intlayer.org/doc/environment/remix-3.md",
-	NuxtAndVue: "https://intlayer.org/doc/environment/nuxt-and-vue.md",
-	Angular: "https://intlayer.org/doc/environment/angular.md",
-	SvelteKit: "https://intlayer.org/doc/environment/sveltekit.md",
-	ReactNativeAndExpo: "https://intlayer.org/doc/environment/react-native-and-expo.md",
-	Lynx: "https://intlayer.org/doc/environment/lynx-and-react.md",
-	Express: "https://intlayer.org/doc/environment/express.md",
-	NestJS: "https://intlayer.org/doc/environment/nest.md",
-	Fastify: "https://intlayer.org/doc/environment/fastify.md",
-	Hono: "https://intlayer.org/doc/environment/hono.md",
-	AdonisJS: "https://intlayer.org/doc/environment/adonisjs.md",
-	Elysia: "https://intlayer.org/doc/environment/elysia.md",
-	Default: "https://intlayer.org/doc/get-started",
-	LSP: "https://intlayer.org/doc/lsp.md",
-	ESLint: "https://intlayer.org/doc/eslint.md",
-	NextIntl: "https://intlayer.org/blog/intlayer-with-next-intl.md",
-	ReactI18Next: "https://intlayer.org/blog/intlayer-with-react-i18next.md",
-	ReactIntl: "https://intlayer.org/blog/intlayer-with-react-intl.md",
-	NextI18Next: "https://intlayer.org/blog/intlayer-with-next-i18next.md",
-	VueI18n: "https://intlayer.org/blog/intlayer-with-vue-i18n.md"
-};
-/**
-* The Intlayer lint setup, as `intlayer init` writes it into `.oxlintrc.json`.
-*
-* Declared locally on purpose: `@intlayer/engine` is installed by every Intlayer
-* user, so it must not depend on a lint plugin to write a handful of strings
-* into a JSON file. oxlint resolves a plugin's *rules* but not its shipped
-* *configs*, so the preset cannot be referenced by name there either.
-*
-* Mirrors the `recommended` preset of `eslint-plugin-intlayer`; keep in sync
-* when a rule is enabled by default there.
-*/
-const LINT_PLUGIN_PACKAGE_NAME = "eslint-plugin-intlayer";
-/** Intlayer's generated output — never source, never worth linting. */
-const GENERATED_OUTPUT_GLOBS = ["**/.intlayer/**"];
-/** Rules of the `recommended` preset, prefixed by the plugin namespace. */
-const getRecommendedRules = () => ({
-	"intlayer/no-raw-text": "warn",
-	"intlayer/static-dictionary-key": "error",
-	"intlayer/no-dynamic-field-access": "error"
-});
-/**
-* Helper: Detects the environment and returns the doc URL
-*/
-const getDocumentationUrl = (packageJson) => {
-	const deps = {
-		...packageJson.dependencies,
-		...packageJson.devDependencies
-	};
-	/**
-	* Helper to check if a version string matches a specific major version
-	* Matches: "15", "^15.0.0", "~15.2", "15.0.0-beta"
-	*/
-	const isVersion = (versionString, major) => {
-		if (!versionString || typeof versionString !== "string") return false;
-		return new RegExp(`^[\\^~]?${major}(?:\\.|$)`).test(versionString);
-	};
-	if (deps["@lynx-js/react"] || deps["@lynx-js/core"]) return DocumentationRouter.Lynx;
-	if (deps["react-native"] || deps.expo) return DocumentationRouter.ReactNativeAndExpo;
-	if (deps.next) {
-		const version = deps.next;
-		if (isVersion(version, 14)) return DocumentationRouter.NextJS_14;
-		if (isVersion(version, 15)) return DocumentationRouter.NextJS_15;
-		return DocumentationRouter.NextJS;
-	}
-	if (deps.nuxt) return DocumentationRouter.NuxtAndVue;
-	if (deps.astro) return DocumentationRouter.Astro;
-	if (deps["@sveltejs/kit"]) return DocumentationRouter.SvelteKit;
-	if (deps["@analogjs/platform"]) return DocumentationRouter.Analog;
-	if (deps["@solidjs/start"]) return DocumentationRouter.SolidStart;
-	if (deps.remix || deps["remix-intlayer"]) return DocumentationRouter.Remix;
-	if (deps["@tanstack/react-router"]) return DocumentationRouter.TanStackRouter;
-	if (deps["@tanstack/solid-router"]) return DocumentationRouter.TanStackRouterAndSolid;
-	const reactRouterVersion = deps["react-router"];
-	if (typeof reactRouterVersion === "string" && (deps["@react-router/fs-routes"] || isVersion(reactRouterVersion, 7))) return DocumentationRouter.ViteAndReact_ReactRouterV7;
-	if (deps.vite) {
-		if (deps.vue) return DocumentationRouter.ViteAndVue;
-		if (deps["solid-js"]) return DocumentationRouter.ViteAndSolid;
-		if (deps.svelte) return DocumentationRouter.ViteAndSvelte;
-		if (deps.preact) return DocumentationRouter.ViteAndPreact;
-		if (deps.lit) return DocumentationRouter.ViteAndLit;
-		if (deps["vanilla-intlayer"]) return DocumentationRouter.ViteAndVanilla;
-		return DocumentationRouter.ViteAndReact;
-	}
-	if (deps["react-scripts"]) return DocumentationRouter.CRA;
-	if (deps["@angular/core"]) return DocumentationRouter.Angular;
-	if (deps.lit) return DocumentationRouter.ViteAndLit;
-	if (deps["vanilla-intlayer"]) return DocumentationRouter.Vanilla;
-	if (deps["@nestjs/core"]) return DocumentationRouter.NestJS;
-	if (deps["@adonisjs/core"]) return DocumentationRouter.AdonisJS;
-	if (deps.elysia) return DocumentationRouter.Elysia;
-	if (deps.hono) return DocumentationRouter.Hono;
-	if (deps.express) return DocumentationRouter.Express;
-	if (deps.fastify) return DocumentationRouter.Fastify;
-	if (deps["next-intl"]) return DocumentationRouter.NextIntl;
-	if (deps["react-i18next"] || deps.i18next) return DocumentationRouter.ReactI18Next;
-	if (deps["react-intl"]) return DocumentationRouter.ReactIntl;
-	if (deps["next-i18next"]) return DocumentationRouter.NextI18Next;
-	if (deps["vue-i18n"]) return DocumentationRouter.VueI18n;
-	return DocumentationRouter.Default;
-};
-/**
 * Resolves the default dev-server URL of the detected framework, used as the
 * `editor.applicationURL` of the generated configuration file. Frameworks that
 * embed Vite (Astro, SvelteKit, …) are checked before the bare Vite fallback so
@@ -190,11 +71,14 @@ const initIntlayer = async (rootDir, options) => {
 	const linguiPresent = Boolean(allDeps["@lingui/core"] || allDeps["@lingui/react"] || allDeps["@intlayer/lingui"]);
 	const linguiCatalog = linguiPresent ? await detectLinguiCatalogPattern(rootDir) : null;
 	const linguiCatalogFormat = linguiCatalog?.format ?? (linguiPresent ? "po" : null);
-	const { packagesToInstall, devPackagesToInstall, compatSyncConfig, compatVitePluginConfig } = detectMissingIntlayerPackages(allDeps, {
+	const { packagesToInstall, devPackagesToInstall, compatSyncConfig, compatVitePluginConfig, pendingCompatAdapters } = detectMissingIntlayerPackages(allDeps, {
 		linguiCatalogFormat,
 		dependencies: packageJson.dependencies,
 		devDependencies: packageJson.devDependencies
 	});
+	/** Whether the compat adapter for a library is not released yet. */
+	const isCompatAdapterPending = (adapterPackage) => pendingCompatAdapters.includes(adapterPackage);
+	if (pendingCompatAdapters.length > 0) logger(`${x} No released Intlayer adapter yet for ${pendingCompatAdapters.map((adapterPackage) => colorize(adapterPackage, ANSIColors.MAGENTA)).join(", ")} — keeping your current i18n library and only syncing its catalogs with Intlayer.`, { level: "warn" });
 	const wantsJsonNamespaces = options?.contentStrategy === "json-namespaces" && !compatSyncConfig;
 	if (wantsJsonNamespaces && !allDeps["@intlayer/sync-json-plugin"] && !devPackagesToInstall.includes("@intlayer/sync-json-plugin")) devPackagesToInstall.push("@intlayer/sync-json-plugin");
 	if (!options?.noInstallPackages) {
@@ -220,7 +104,7 @@ const initIntlayer = async (rootDir, options) => {
 		await upgradeIntlayerPackages(rootDir);
 	}
 	const gitignorePath = ".gitignore";
-	if (!options?.noGitignore && await exists(rootDir, gitignorePath)) {
+	if (!options?.noGitignore && !options?.noFrameworkSetup && await exists(rootDir, gitignorePath)) {
 		const gitignoreContent = await readFileFromRoot(rootDir, gitignorePath);
 		if (!gitignoreContent.includes("intlayer")) {
 			const newContent = `${gitignoreContent}\n# Intlayer\n.intlayer\n`;
@@ -286,38 +170,24 @@ const initIntlayer = async (rootDir, options) => {
 	} catch {
 		logger(`${x} Could not update ${colorizePath(settingsJsonPath)}. You may need to add the LSP settings manually.`, { level: "warn" });
 	}
+	if (!options?.noEslint && hasLegacyEslint(allDeps)) logger(`${x} ${colorize(LINT_PLUGIN_PACKAGE_NAME, ANSIColors.MAGENTA)} needs ESLint ${9}+ (flat config) — skipped the Intlayer lint rules. Upgrade ESLint to enable them: ${colorizePath(DocumentationRouter.ESLint)}`, { level: "warn" });
 	if (!options?.noEslint && hasLintTooling(allDeps)) {
 		const oxlintConfigPath = ".oxlintrc.json";
-		if (await exists(rootDir, oxlintConfigPath)) try {
-			const content = await readFileFromRoot(rootDir, oxlintConfigPath);
-			const oxlintConfig = parseJSONWithComments(content);
-			oxlintConfig.jsPlugins ??= [];
-			oxlintConfig.rules ??= {};
-			oxlintConfig.ignorePatterns ??= [];
-			let oxlintUpdated = false;
-			for (const glob of GENERATED_OUTPUT_GLOBS) if (!oxlintConfig.ignorePatterns.includes(glob)) {
-				oxlintConfig.ignorePatterns.push(glob);
-				oxlintUpdated = true;
-			}
-			if (!oxlintConfig.jsPlugins.includes(LINT_PLUGIN_PACKAGE_NAME)) {
-				oxlintConfig.jsPlugins.push(LINT_PLUGIN_PACKAGE_NAME);
-				oxlintUpdated = true;
-			}
-			for (const [ruleName, severity] of Object.entries(getRecommendedRules())) if (!oxlintConfig.rules[ruleName]) {
-				oxlintConfig.rules[ruleName] = severity;
-				oxlintUpdated = true;
-			}
-			if (oxlintUpdated) {
+		const hasOxlintConfig = await exists(rootDir, oxlintConfigPath);
+		const shouldCreateOxlintConfig = !hasOxlintConfig && Boolean(allDeps.oxlint) && !allDeps.eslint;
+		if (hasOxlintConfig || shouldCreateOxlintConfig) try {
+			const oxlintConfig = hasOxlintConfig ? parseJSONWithComments(await readFileFromRoot(rootDir, oxlintConfigPath)) : {};
+			if (addIntlayerRulesToOxlintConfig(oxlintConfig)) {
 				await writeFileToRoot(rootDir, oxlintConfigPath, JSON.stringify(oxlintConfig, null, 2));
-				logger(`${v} Added the Intlayer lint rules to ${colorizePath(oxlintConfigPath)}`);
+				logger(`${v} ${hasOxlintConfig ? "Added the Intlayer lint rules to" : "Created"} ${colorizePath(oxlintConfigPath)}`);
 			} else logger(`${v} ${colorizePath(oxlintConfigPath)} already includes the Intlayer lint rules`);
 		} catch {
 			logger(`${x} Could not update ${colorizePath(oxlintConfigPath)}. You may need to add ${colorize(LINT_PLUGIN_PACKAGE_NAME, ANSIColors.MAGENTA)} manually.`, { level: "warn" });
 		}
 		else logger([
 			colorize("Intlayer lint rules →", ANSIColors.MAGENTA),
-			colorize(`Add ${LINT_PLUGIN_PACKAGE_NAME} to your ESLint flat config to catch hardcoded text and dynamic calls the compiler cannot optimize:`, ANSIColors.GREY_LIGHT),
-			colorize(`  import intlayer from '${LINT_PLUGIN_PACKAGE_NAME}';\n  export default [...intlayer.configs.recommended];`, ANSIColors.GREY_LIGHT),
+			colorize(`Add the ${LINT_PLUGIN_PACKAGE_NAME} preset to the array your ESLint flat config exports, to catch hardcoded text and dynamic calls the compiler cannot optimize:`, ANSIColors.GREY_LIGHT),
+			colorize(`  import intlayer from '${LINT_PLUGIN_PACKAGE_NAME}';\n\n  export default [\n    // ...your existing config\n    ...intlayer.configs.recommended,\n  ];`, ANSIColors.GREY_LIGHT),
 			colorizePath(DocumentationRouter.ESLint)
 		]);
 	}
@@ -345,7 +215,7 @@ const initIntlayer = async (rootDir, options) => {
 		}
 		const format = hasTsConfig ? "intlayer.config.ts" : "intlayer.config.mjs";
 		const detectedPattern = await detectJsonLocalePattern(rootDir);
-		await initConfig(format, rootDir, {
+		const isConfigCreated = await initConfig(format, rootDir, {
 			locales: detectedPattern?.locales,
 			applicationURL: getDefaultApplicationURL(allDeps)
 		});
@@ -380,7 +250,14 @@ const initIntlayer = async (rootDir, options) => {
 				break;
 			}
 		}
-		if (options?.routingMode) await setRoutingModeInConfig(rootDir, options.routingMode);
+		const hasUrlRouting = hasUrlRoutingFramework(allDeps);
+		const hasCompatI18nLibrary = detectCompatI18nLibraries(allDeps).length > 0;
+		const shouldApplyDefaultRouting = isConfigCreated && options?.routingMode === void 0 && !hasCompatI18nLibrary;
+		if (shouldApplyDefaultRouting && !hasUrlRouting) await setRoutingStorageOnlyInConfig(rootDir);
+		const routingMode = options?.routingMode ?? (shouldApplyDefaultRouting && hasUrlRouting ? ROUTING_MODE : void 0);
+		const enableProxy = options?.enableProxy ?? (shouldApplyDefaultRouting && hasUrlRouting ? true : void 0);
+		if (routingMode) await setRoutingModeInConfig(rootDir, routingMode);
+		if (enableProxy !== void 0) await setEnableProxyInConfig(rootDir, enableProxy);
 		let hasAliasConfiguration = false;
 		for (const file of [
 			"vite.config.ts",
@@ -433,7 +310,8 @@ const initIntlayer = async (rootDir, options) => {
 					await writeFileToRoot(rootDir, file, updatedContent);
 					logger(`${v} Updated ${colorizePath(file)} to include Intlayer next-intl compat plugin`);
 				} else logger(`${v} ${colorizePath(file)} already includes @intlayer/next-intl/plugin`);
-			} else if (allDeps["next-translate"] || allDeps["@intlayer/next-translate"]) {
+			} else if (isCompatAdapterPending("@intlayer/next-translate")) logger(`${v} Kept ${colorizePath(file)} untouched (next-translate stays in charge)`);
+			else if (allDeps["next-translate"] || allDeps["@intlayer/next-translate"]) {
 				if (!content.includes("@intlayer/next-translate")) {
 					const updatedContent = updateNextConfigForNextTranslate(content, extension);
 					await writeFileToRoot(rootDir, file, updatedContent);
@@ -473,7 +351,8 @@ const initIntlayer = async (rootDir, options) => {
 		for (const file of ["nuxt.config.js", "nuxt.config.ts"]) if (await exists(rootDir, file)) {
 			hasAliasConfiguration = true;
 			const content = await readFileFromRoot(rootDir, file);
-			if (allDeps["@nuxtjs/i18n"]) {
+			if (isCompatAdapterPending("@intlayer/nuxtjs-i18n")) logger(`${v} Kept ${colorizePath(file)} untouched (@nuxtjs/i18n stays in charge)`);
+			else if (allDeps["@nuxtjs/i18n"]) {
 				if (!content.includes("@intlayer/nuxtjs-i18n")) {
 					const updatedContent = updateNuxtConfigForNuxtjsI18n(content);
 					await writeFileToRoot(rootDir, file, updatedContent);
@@ -607,26 +486,31 @@ const initIntlayer = async (rootDir, options) => {
 		const hasCompatLibrary = Boolean(compatSyncConfig || compatVitePluginConfig);
 		if (hasCompatLibrary) logger(`${v} Compat i18n library detected — keeping the app structure untouched (no route restructure, no provider injection)`);
 		if (!hasCompatLibrary) try {
-			const routingMode = options?.routingMode ?? getConfiguration({ baseDir: rootDir }).routing.mode;
+			const { routing } = getConfiguration({ baseDir: rootDir });
 			await setupFramework({
 				rootDir,
 				allDeps,
 				packageManager,
 				useTypeScript: hasTsConfig,
-				routingMode
+				routingMode: routingMode ?? routing.mode,
+				enableProxy: enableProxy ?? routing.enableProxy !== false
 			});
 		} catch {
 			logger(`${x} Framework-specific scaffolding failed. Your existing files were left untouched; follow the documentation to finish the setup.`, { level: "warn" });
 		}
 	}
+	if (!options?.skipFinalMessage) logInitSuccessMessage(guideUrl);
+	return { guideUrl };
+};
+const logInitSuccessMessage = (guideUrl) => {
 	logger(`${v} ${colorize("Intlayer init setup complete.", ANSIColors.GREEN)}`);
 	logger([
 		colorize("Next →", ANSIColors.MAGENTA),
-		colorize(`Follow the instructions in the documentation to complete the setup:`, ANSIColors.GREY_LIGHT),
+		colorize("Follow the instructions in the documentation to complete the setup:", ANSIColors.GREY_LIGHT),
 		colorizePath(guideUrl)
 	]);
 };
 
 //#endregion
-export { getDefaultApplicationURL, initIntlayer };
+export { DocumentationRouter, getDefaultApplicationURL, getDocumentationUrl, initIntlayer, logInitSuccessMessage };
 //# sourceMappingURL=index.mjs.map