nuxt-i18n-micro 1.3.0 → 1.4.0

package/README.md

@@ -276,17 +276,31 @@ const i18n = useI18n()
 </script>
 
 ```
+Вот обновленный раздел `README.md` с описанием работы параметра `routesLocaleLinks` и улучшенным оформлением параметров модуля.
 
 ## Module Options
 
 The module accepts the following options in the Nuxt configuration:
 
-**locales**: An array of locale objects. Each locale should have the following properties:
+### **locales**: `Locale[]`
 
-- **code**: *(string, required)* A unique identifier for the locale, such as `'en'` for English or `'fr'` for French.
-- **iso**: *(string, optional)* The ISO code for the locale, which is typically used for setting the `lang` attribute in HTML or for other internationalization purposes (e.g., `'en-US'`, `'fr-FR'`).
-- **dir**: *(string, optional)* The text direction for the locale. It can be either `'rtl'` for right-to-left languages (like Arabic or Hebrew) or `'ltr'` for left-to-right languages (like English or French). This is useful for ensuring that text is displayed correctly depending on the language's writing system.
-- **disabled**: *(boolean, optional)* A flag indicating whether this locale should be disabled or excluded from certain layers or operations. When `disabled` is set to `true`, this locale will be ignored in situations where only active or enabled locales are considered. This can be particularly useful when working with different layers of content or features in a multi-locale application, allowing developers to temporarily or permanently exclude specific locales from being processed, displayed, or made available to users without removing them entirely from the configuration.
+```typescript
+interface Locale {
+  code: string
+  disabled?: boolean
+  iso?: string
+  dir?: 'rtl' | 'ltr'
+}
+```
+
+An array of locale objects. Each locale should have the following properties:
+
+- **`code`**: *(string, required)* A unique identifier for the locale, such as `'en'` for English or `'fr'` for French.
+- **`iso`**: *(string, optional)* The ISO code for the locale, which is typically used for setting the `lang` attribute in HTML or for other internationalization purposes (e.g., `'en-US'`, `'fr-FR'`).
+- **`dir`**: *(string, optional)* The text direction for the locale. It can be either `'rtl'` for right-to-left languages (like Arabic or Hebrew) or `'ltr'` for left-to-right languages (like English or French).
+- **`disabled`**: *(boolean, optional)* A flag indicating whether this locale should be disabled or excluded from certain layers or operations.
+
+Example:
 
 ```typescript
 locales: [
@@ -296,13 +310,61 @@ locales: [
 ]
 ```
 
-**meta**: A boolean indicating whether to automatically generate SEO-related meta tags (like `alternate` links).
-**defaultLocale**: The default locale code (e.g., `'en'`).
-**translationDir**: The directory where translation files are stored (e.g., `'locales'`).
-**autoDetectLanguage**: If `true`, automatically detects the user's preferred language and redirects accordingly.
-**plural**: A custom function for handling pluralization.
-**includeDefaultLocaleRoute**: A boolean. If enabled, all routes without a locale prefix will redirect to the default locale route.
-**cache**: (In development) A boolean option designed to optimize performance when working with large JSON translation files. When enabled, it caches translations specific to the current page, reducing search times and minimizing client-side load. This cached data is then sent to the client, resulting in faster page loads and improved user experience.
+### **meta**: `boolean`
+
+Indicates whether to automatically generate SEO-related meta tags (like `alternate` links).
+
+### **defaultLocale**: `string`
+
+The default locale code. For example, `'en'`.
+
+### **translationDir**: `string`
+
+The directory where translation files are stored. Default value is `'locales'`.
+
+### **autoDetectLanguage**: `boolean`
+
+If `true`, the module automatically detects the user's preferred language and redirects accordingly.
+
+### **plural**: `function`
+
+A custom function for handling pluralization logic.
+
+### **includeDefaultLocaleRoute**: `boolean`
+
+If `true`, all routes without a locale prefix will redirect to the default locale route.
+
+### **routesLocaleLinks**: `Record<string, string>`
+
+This parameter allows you to create links between different pages' locale files. It is particularly useful in cases where you have similar pages (e.g., a main page and a page with a slug) and want them to share the same translation file.
+
+For example, if you have a page with a slug (`dir1-slug`) and a main page (`index`), you can set up `routesLocaleLinks` so that `dir1-slug` will use the locale file of `index`, avoiding the need to maintain duplicate translation files.
+
+Example:
+
+```typescript
+import MyModule from '../../../src/module'
+
+export default defineNuxtConfig({
+  modules: [
+    MyModule,
+  ],
+
+  i18n: {
+    routesLocaleLinks: {
+      'dir1-slug': 'index',
+    },
+  },
+
+  compatibilityDate: '2024-08-16',
+})
+```
+
+In this example, the page `dir1-slug` will load its translations from the `index` page's locale file.
+
+### **cache**: `boolean`
+
+(In development) This option is designed to optimize performance when working with large JSON translation files. When enabled, it caches translations specific to the current page, reducing search times and minimizing client-side load.
 
 ## Locale Loading in Nuxt I18n Micro
 

package/dist/client/200.html

@@ -9,4 +9,4 @@
 <link rel="prefetch" as="style" href="/__nuxt-i18n-micro/_nuxt/error-500.B4KzowuE.css">
 <link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/DrEIrqkc.js">
 <script type="module" src="/__nuxt-i18n-micro/_nuxt/Cnou2wpD.js" crossorigin></script></head><body><div id="__nuxt"></div><div id="teleports"></div><script type="application/json" id="__NUXT_DATA__" data-ssr="false">[{"serverRendered":1},false]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"617ee22e-7535-4912-9e45-dba61630c34c",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>
+<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"5245b3c8-e6ec-4fa5-8716-ff1782822160",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/client/404.html

@@ -9,4 +9,4 @@
 <link rel="prefetch" as="style" href="/__nuxt-i18n-micro/_nuxt/error-500.B4KzowuE.css">
 <link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/DrEIrqkc.js">
 <script type="module" src="/__nuxt-i18n-micro/_nuxt/Cnou2wpD.js" crossorigin></script></head><body><div id="__nuxt"></div><div id="teleports"></div><script type="application/json" id="__NUXT_DATA__" data-ssr="false">[{"serverRendered":1},false]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"617ee22e-7535-4912-9e45-dba61630c34c",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>
+<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"5245b3c8-e6ec-4fa5-8716-ff1782822160",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/client/_nuxt/builds/latest.json

@@ -1 +1 @@
-{"id":"617ee22e-7535-4912-9e45-dba61630c34c","timestamp":1724148267155}
+{"id":"5245b3c8-e6ec-4fa5-8716-ff1782822160","timestamp":1724176624595}

package/dist/client/_nuxt/builds/meta/5245b3c8-e6ec-4fa5-8716-ff1782822160.json

@@ -0,0 +1 @@
+{"id":"5245b3c8-e6ec-4fa5-8716-ff1782822160","timestamp":1724176624595,"matcher":{"static":{},"wildcard":{},"dynamic":{}},"prerendered":[]}

package/dist/client/index.html

@@ -9,4 +9,4 @@
 <link rel="prefetch" as="style" href="/__nuxt-i18n-micro/_nuxt/error-500.B4KzowuE.css">
 <link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/DrEIrqkc.js">
 <script type="module" src="/__nuxt-i18n-micro/_nuxt/Cnou2wpD.js" crossorigin></script></head><body><div id="__nuxt"></div><div id="teleports"></div><script type="application/json" id="__NUXT_DATA__" data-ssr="false">[{"serverRendered":1},false]</script>
-<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"617ee22e-7535-4912-9e45-dba61630c34c",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>
+<script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-i18n-micro",buildId:"5245b3c8-e6ec-4fa5-8716-ff1782822160",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/module.d.mts

@@ -14,6 +14,7 @@ interface ModuleOptions {
     translationDir?: string;
     autoDetectLanguage?: boolean;
     includeDefaultLocaleRoute?: boolean;
+    routesLocaleLinks?: Record<string, string>;
     cache?: boolean;
     plural?: string;
 }
@@ -21,6 +22,8 @@ interface ModuleOptionsExtend extends ModuleOptions {
     rootDir: string;
     pluralString: string;
     rootDirs: string[];
+    dateBuild: number;
+    baseURL: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.d.ts

@@ -14,6 +14,7 @@ interface ModuleOptions {
     translationDir?: string;
     autoDetectLanguage?: boolean;
     includeDefaultLocaleRoute?: boolean;
+    routesLocaleLinks?: Record<string, string>;
     cache?: boolean;
     plural?: string;
 }
@@ -21,6 +22,8 @@ interface ModuleOptionsExtend extends ModuleOptions {
     rootDir: string;
     pluralString: string;
     rootDirs: string[];
+    dateBuild: number;
+    baseURL: string;
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-i18n-micro",
   "configKey": "i18n",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "builder": {
     "@nuxt/module-builder": "0.8.3",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -101,6 +101,7 @@ const module = defineNuxtModule({
     translationDir: "locales",
     autoDetectLanguage: true,
     includeDefaultLocaleRoute: false,
+    routesLocaleLinks: {},
     cache: false,
     plural: `function (translation, count, _locale) {
       const forms = translation.toString().split('|')
@@ -135,7 +136,10 @@ const module = defineNuxtModule({
       translationDir: options.translationDir ?? "locales",
       autoDetectLanguage: options.autoDetectLanguage ?? true,
       includeDefaultLocaleRoute: options.includeDefaultLocaleRoute ?? false,
-      cache: options.cache ?? false
+      routesLocaleLinks: options.routesLocaleLinks ?? {},
+      cache: options.cache ?? false,
+      dateBuild: Date.now(),
+      baseURL: nuxt.options.app.baseURL
     };
     addPlugin({
       src: resolver.resolve("./runtime/plugins/01.plugin"),
@@ -177,7 +181,7 @@ const module = defineNuxtModule({
     const localeRegex = locales.filter((locale) => locale.code !== options.defaultLocale || options.includeDefaultLocaleRoute).map((locale) => locale.code).join("|");
     const pagesDir = path.resolve(nuxt.options.rootDir, options.translationDir, "pages");
     extendPages((pages) => {
-      const pagesNames = pages.map((page) => page.name);
+      const pagesNames = pages.map((page) => page.name).filter((name) => name && (!options.routesLocaleLinks || !options.routesLocaleLinks[name]));
       function ensureFileExists(filePath) {
         const fileDir = path.dirname(filePath);
         if (!existsSync(fileDir)) {
@@ -190,21 +194,19 @@ const module = defineNuxtModule({
       locales.forEach((locale) => {
         const globalFilePath = path.join(nuxt.options.rootDir, options.translationDir, `${locale.code}.json`);
         ensureFileExists(globalFilePath);
-        pages.forEach((page) => {
-          const pageFilePath = path.join(pagesDir, `${page.name}/${locale.code}.json`);
+        pagesNames.forEach((name) => {
+          const pageFilePath = path.join(pagesDir, `${name}/${locale.code}.json`);
           ensureFileExists(pageFilePath);
         });
       });
-      const newRoutes = pages.map((page) => {
-        return {
-          ...page,
-          path: `/:locale(${localeRegex})${page.path}`,
-          name: `localized-${page.name}`,
-          meta: {
-            ...page.meta
-          }
-        };
-      });
+      const newRoutes = pages.map((page) => ({
+        ...page,
+        path: `/:locale(${localeRegex})${page.path}`,
+        name: `localized-${page.name}`,
+        meta: {
+          ...page.meta
+        }
+      }));
       pages.push(...newRoutes);
       nuxt.options.generate.routes = Array.isArray(nuxt.options.generate.routes) ? nuxt.options.generate.routes : [];
       locales.forEach((locale) => {

package/dist/runtime/plugins/01.plugin.js

@@ -66,26 +66,33 @@ export default defineNuxtPlugin(async (nuxtApp) => {
   const route = useRoute();
   const config = useRuntimeConfig();
   const i18nConfig = config.public.i18nConfig;
-  const initialLocale = (route.params?.locale ?? i18nConfig.defaultLocale).toString();
-  const initialRouteName = route.name.replace(`localized-`, "");
   const plural = new Function("return " + i18nConfig.plural)();
   router.beforeEach(async (to, from, next) => {
     if (import.meta.client) {
       const locale = (to.params?.locale ?? i18nConfig.defaultLocale).toString();
-      const routeName = to.name.replace(`localized-`, "");
-      if (!i18nHelper.hasPageTranslation(locale, routeName)) {
-        const data2 = await $fetch(`/_locales/${routeName}/${locale}/data.json`);
-        await i18nHelper.loadPageTranslations(locale, routeName, data2 ?? {});
+      const initialRouteName2 = to.name.replace(`localized-`, "");
+      let routeName = initialRouteName2;
+      if (i18nConfig.routesLocaleLinks && i18nConfig.routesLocaleLinks[routeName]) {
+        routeName = i18nConfig.routesLocaleLinks[routeName];
+      }
+      if (!i18nHelper.hasPageTranslation(locale, initialRouteName2)) {
+        const data2 = await $fetch(`/_locales/${routeName}/${locale}/data.json?v=${i18nConfig.dateBuild}`, { baseURL: i18nConfig.baseURL });
+        await i18nHelper.loadPageTranslations(locale, initialRouteName2, data2 ?? {});
       }
     }
     next();
   });
-  const data = await $fetch(`/_locales/general/${initialLocale}/data.json`);
+  const initialLocale = (route.params?.locale ?? i18nConfig.defaultLocale).toString();
+  const initialRouteName = route.name.replace(`localized-`, "");
+  const data = await $fetch(`/_locales/general/${initialLocale}/data.json?v=${i18nConfig.dateBuild}`, { baseURL: i18nConfig.baseURL });
   await i18nHelper.loadTranslations(initialLocale, initialRouteName, data ?? {});
   if (import.meta.server) {
     const locale = (route.params?.locale ?? i18nConfig.defaultLocale).toString();
-    const routeName = route.name.replace(`localized-`, "");
-    const data2 = await $fetch(`/_locales/${routeName}/${locale}/data.json`);
+    let routeName = initialRouteName;
+    if (i18nConfig.routesLocaleLinks && i18nConfig.routesLocaleLinks[routeName]) {
+      routeName = i18nConfig.routesLocaleLinks[routeName];
+    }
+    const data2 = await $fetch(`/_locales/${routeName}/${locale}/data.json?v=${i18nConfig.dateBuild}`, { baseURL: i18nConfig.baseURL });
     await i18nHelper.loadPageTranslations(initialLocale, initialRouteName, data2 ?? {});
   }
   return {

package/dist/runtime/plugins/03.define.js

@@ -32,6 +32,7 @@ export default defineNuxtPlugin((_nuxtApp) => {
       if (i18nConfig.includeDefaultLocaleRoute) {
         defaultRouteName = `localized-${defaultRouteName}`;
         newParams.locale = i18nConfig.defaultLocale;
+        newParams.name = defaultRouteName;
       }
       return router.push(resolvedRoute);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-i18n-micro",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Nuxt I18n Micro is a lightweight, high-performance internationalization module for Nuxt, designed to handle multi-language support with minimal overhead, fast build times, and efficient runtime performance.",
   "repository": "s00d/nuxt-i18n-micro",
   "license": "MIT",

package/dist/client/_nuxt/builds/meta/617ee22e-7535-4912-9e45-dba61630c34c.json

@@ -1 +0,0 @@
-{"id":"617ee22e-7535-4912-9e45-dba61630c34c","timestamp":1724148267155,"matcher":{"static":{},"wildcard":{},"dynamic":{}},"prerendered":[]}