@yiiamee/multilinguist 1.5.0 → 1.5.2

package/README.md

@@ -31,7 +31,7 @@ export default defineNuxtConfig({
 })
 ```
 
-Then, create a "locales" directory in /public directory. This is necessary for module to access your languages.
+Then, create a "locales" directory in root directory of your project.
 
 ![directory_structure.png](directory_structure.png)
 
@@ -82,6 +82,24 @@ export default defineNuxtConfig({
 })
 ```
 
+Also, if you want to use a different folder name for your locales' files, or you want to specify other path to the directory, you can set the `localesPath` option in your nuxt.config:
+
+```nuxt.config.ts
+export default defineNuxtConfig({
+    modules: [
+        "@yiiamee/multilinguist",
+    ],
+    multilinguist: {
+        defaultLocale: "en",
+        supportedLanguages: ["en", "es"],
+        logging: false,
+        setBrowserLanguage: false, // by default: true
+        localesPath: "./languages", // by default: "./locales"
+    },
+})
+```
+
+### Important! Keep in mind, that it is not recommended to use "public" folder for your locales' files, as it may lead to rendering, security and other issues.
 
 # Usage
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@yiiamee/multilinguist",
   "configKey": "multilinguist",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "compatibility": {
     "nuxt": "^3.0.0 || ^4.0.0"
   },
@@ -10,7 +10,7 @@
     "defaultLocale": "",
     "supportedLanguages": [],
     "setBrowserLanguage": true,
-    "localesPath": "./public/locales"
+    "localesPath": "./locales"
   },
   "builder": {
     "@nuxt/module-builder": "1.0.1",

package/dist/module.mjs

@@ -49,24 +49,7 @@ declare module 'vue' {
 }
 `;
 };
-const generateLocaleImports = (absoluteLocalesPath, relativeLocalesPath, supportedLanguages, generatedFilePath, projectRoot) => {
-  const generatedFileDir = path.dirname(generatedFilePath);
-  const relativeTo = path.relative(generatedFileDir, projectRoot);
-  const cleanLocalesPath = relativeLocalesPath.startsWith("./") ? relativeLocalesPath.slice(2) : relativeLocalesPath.startsWith("/") ? relativeLocalesPath.slice(1) : relativeLocalesPath;
-  const importBasePath = path.join(relativeTo, cleanLocalesPath).replace(/\\/g, "/");
-  const normalizedKeyPath = relativeLocalesPath.startsWith("./") ? relativeLocalesPath.slice(1) : relativeLocalesPath.startsWith("/") ? relativeLocalesPath : `/${relativeLocalesPath}`;
-  const imports = supportedLanguages.map((lang, index) => `import locale_${index} from "${importBasePath}/${lang}.json";`).join("\n");
-  const localeMap = supportedLanguages.map((lang, index) => `  "${normalizedKeyPath}/${lang}.json": { default: locale_${index} }`).join(",\n");
-  return `
-// AUTO-GENERATED LOCALE IMPORTS
-${imports}
-
-export const localeFiles = {
-${localeMap}
-};
-`;
-};
-function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath, outPath, logging = true, relativeLocalesPath = "./public/locales", supportedLanguages = [], projectRoot = process.cwd()) {
+function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath, outPath, logging = true) {
   async function generateTypes() {
     const defaultLocalePath = path.join(absoluteLocalesPath, `${defaultLocaleFromConfig}.json`);
     if (!fs.existsSync(defaultLocalePath)) {
@@ -82,40 +65,14 @@ function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath,
       console?.warn(`\u2705 Generated types to ${outPath} from ${defaultLocalePath}`);
     }
   }
-  async function generateLocaleImportsFile() {
-    const importsPath = path.dirname(outPath) + "/locale-imports.ts";
-    const imports = generateLocaleImports(
-      absoluteLocalesPath,
-      relativeLocalesPath,
-      supportedLanguages,
-      importsPath,
-      projectRoot
-    );
-    fs.mkdirSync(path.dirname(importsPath), { recursive: true });
-    fs.writeFileSync(importsPath, imports, "utf-8");
-    if (logging) {
-      console?.warn(`\u2705 Generated locale imports to ${importsPath}`);
-      const generatedFileDir = path.dirname(importsPath);
-      const relativeTo = path.relative(generatedFileDir, projectRoot);
-      const cleanLocalesPath = relativeLocalesPath.startsWith("./") ? relativeLocalesPath.slice(2) : relativeLocalesPath.startsWith("/") ? relativeLocalesPath.slice(1) : relativeLocalesPath;
-      const finalPath = path.join(relativeTo, cleanLocalesPath).replace(/\\/g, "/");
-      console?.warn(`\u2705 Import path calculated: ${finalPath}`);
-    }
-  }
   return {
     name: "vite-plugin-generate-locales-types",
     async buildStart() {
       await generateTypes();
-      if (supportedLanguages.length > 0) {
-        await generateLocaleImportsFile();
-      }
     },
     async handleHotUpdate(ctx) {
       if (ctx.file.endsWith(".json") && ctx.file.includes(absoluteLocalesPath)) {
         await generateTypes();
-        if (supportedLanguages.length > 0) {
-          await generateLocaleImportsFile();
-        }
       }
     }
   };
@@ -125,7 +82,7 @@ const module = defineNuxtModule({
   meta: {
     name: "@yiiamee/multilinguist",
     configKey: "multilinguist",
-    version: "1.5.0",
+    version: "1.5.2",
     compatibility: {
       nuxt: "^3.0.0 || ^4.0.0"
     },
@@ -134,12 +91,12 @@ const module = defineNuxtModule({
       defaultLocale: "",
       supportedLanguages: [],
       setBrowserLanguage: true,
-      localesPath: "./public/locales"
+      localesPath: "./locales"
     }
   },
   setup(moduleOptions, nuxtApp) {
     const resolver = createResolver(import.meta.url);
-    const localesPath = moduleOptions.localesPath || "./public/locales";
+    const localesPath = moduleOptions.localesPath || "./locales";
     const resolvedLocalesPath = resolve(nuxtApp.options.rootDir, localesPath);
     addPlugin(resolver.resolve("runtime/plugin"));
     addImportsDir(resolver.resolve("runtime/composables"));
@@ -150,6 +107,9 @@ const module = defineNuxtModule({
       setBrowserLanguage: typeof moduleOptions.setBrowserLanguage === "boolean" ? moduleOptions.setBrowserLanguage : true,
       localesPath
     };
+    nuxtApp.options.runtimeConfig.multilinguist = {
+      resolvedLocalesPath
+    };
     nuxtApp.hook("vite:extendConfig", (viteConfig) => {
       viteConfig.plugins = viteConfig.plugins || [];
       viteConfig.plugins.push(
@@ -157,11 +117,7 @@ const module = defineNuxtModule({
           moduleOptions.defaultLocale,
           resolvedLocalesPath,
           resolver.resolve("./runtime/types/generated-locales.d.ts"),
-          moduleOptions.logging,
-          localesPath,
-          moduleOptions.supportedLanguages,
-          nuxtApp.options.rootDir
-          // Pass the project root
+          moduleOptions.logging
         )
       );
     });
@@ -169,10 +125,18 @@ const module = defineNuxtModule({
       references.push({
         path: resolver.resolve("./runtime/types/generated-locales.d.ts")
       });
-      references.push({
-        path: resolver.resolve("./runtime/types/locale-imports.ts")
-      });
     });
+    if (!localesPath.includes("public")) {
+      nuxtApp.hook("nitro:config", async (nitroConfig) => {
+        nitroConfig.publicAssets = nitroConfig.publicAssets || [];
+        nitroConfig.publicAssets.push({
+          dir: resolvedLocalesPath,
+          maxAge: 60 * 60 * 24 * 7,
+          // 1 week
+          baseURL: `/${localesPath.replace(/^\.\//, "").replace(/^public\//, "")}`
+        });
+      });
+    }
   }
 });
 

package/dist/runtime/composables/useLocalization.js

@@ -1,7 +1,6 @@
 import useLocale from "../composables/useLocale.js";
 import { useCookie, useState, useRuntimeConfig } from "nuxt/app";
 import { computed, watch } from "vue";
-import { localeFiles } from "../types/locale-imports.js";
 export default function useLocalization(supportedLanguages, defaultLocale, setBrowserLanguage = true) {
   const { locale: userBrowserLocale } = useLocale(supportedLanguages, defaultLocale);
   const config = useRuntimeConfig();
@@ -11,15 +10,29 @@ export default function useLocalization(supportedLanguages, defaultLocale, setBr
   const loadedLanguages = useState("loaded-languages", () => ({}));
   const loadLocaleMessages = async (locale2) => {
     if (!loadedLanguages.value[locale2]) {
-      const localesPath = config.public.multilinguist.localesPath || "./public/locales";
-      const normalizedPath = localesPath.startsWith("./") ? localesPath.slice(1) : localesPath.startsWith("/") ? localesPath : `/${localesPath}`;
-      const fileKey = `${normalizedPath}/${locale2}.json`;
-      const messages = localeFiles[fileKey];
-      if (messages) {
-        loadedLanguages.value[locale2] = messages.default;
-      } else {
-        console.error(`Available locale files:`, Object.keys(localeFiles));
-        throw new Error(`Locale file ${fileKey} not found`);
+      try {
+        const localesPath = config.public.multilinguist.localesPath || "./locales";
+        const normalizedPath = localesPath.startsWith("./") ? localesPath.slice(2) : localesPath.startsWith("/") ? localesPath.slice(1) : localesPath;
+        let messages;
+        if (import.meta.server) {
+          const { readFileSync, existsSync } = await import("fs");
+          const { join } = await import("path");
+          const resolvedPath = config.multilinguist?.resolvedLocalesPath;
+          const filePath = join(resolvedPath, `${locale2}.json`);
+          if (!existsSync(filePath)) {
+            throw new Error(`Locale file not found: ${filePath}`);
+          }
+          const fileContent = readFileSync(filePath, "utf-8");
+          messages = JSON.parse(fileContent);
+        } else {
+          const url = `/${normalizedPath}/${locale2}.json`;
+          const response = await $fetch(url);
+          messages = response;
+        }
+        loadedLanguages.value[locale2] = messages;
+      } catch (error) {
+        console.error(`Failed to load locale '${locale2}':`, error);
+        throw new Error(`Locale file for '${locale2}' not found at configured path`);
       }
     }
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yiiamee/multilinguist",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "Nuxt Multilinguist module for localizations",
   "repository": "yiiameeMich/multilinguist",
   "license": "MIT",