@yiiamee/multilinguist 1.6.0 → 1.6.1

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.6.0",
+  "version": "1.6.1",
   "compatibility": {
     "nuxt": "^3.0.0 || ^4.0.0"
   },

package/dist/module.mjs

@@ -49,10 +49,9 @@ declare module 'vue' {
 }
 `;
 };
-function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, localesPath, outPath, logging = true) {
+function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, absoluteLocalesPath, outPath, logging = true) {
   async function generateTypes() {
-    const defaultLocalePath = path.join(localesPath, `${defaultLocaleFromConfig}.json`);
-    console.log(defaultLocalePath);
+    const defaultLocalePath = path.join(absoluteLocalesPath, `${defaultLocaleFromConfig}.json`);
     if (!fs.existsSync(defaultLocalePath)) {
       console?.error(`\u274C Default locale file not found: ${defaultLocalePath}`);
       return;
@@ -72,7 +71,7 @@ function GenerateLocaleKeysPlugin(defaultLocaleFromConfig, localesPath, outPath,
       await generateTypes();
     },
     async handleHotUpdate(ctx) {
-      if (ctx.file.endsWith(".json") && ctx.file.includes(localesPath)) {
+      if (ctx.file.endsWith(".json") && ctx.file.includes(absoluteLocalesPath)) {
         await generateTypes();
       }
     }
@@ -83,7 +82,7 @@ const module = defineNuxtModule({
   meta: {
     name: "@yiiamee/multilinguist",
     configKey: "multilinguist",
-    version: "1.6.0",
+    version: "1.6.1",
     compatibility: {
       nuxt: "^3.0.0 || ^4.0.0"
     },

package/dist/runtime/composables/useLocalization.d.ts

@@ -1,4 +1,4 @@
-import { type Ref, type ComputedRef } from "vue";
+import { type ComputedRef, type Ref } from "vue";
 import type { LocaleKey } from "../types/generated-locales.js";
 export type TranslationMap = readonly string[];
 export type Locale<T extends TranslationMap> = T[number];

package/dist/runtime/composables/useLocalization.js

@@ -27,7 +27,7 @@ export default function useLocalization(supportedLanguages, defaultLocale, setBr
   const userPrefferableLocale = computed(() => {
     return userSelectedLocale.value ? userSelectedLocale.value : userBrowserLocale.value;
   });
-  const locale = useState(() => {
+  const locale = useState("current-locale-multilinguist", () => {
     return userPrefferableLocale.value || defaultLocale;
   });
   const t = (key, variables) => {

package/dist/runtime/types/locale-imports.d.ts

@@ -1,8 +1,30 @@
 export declare const localeFiles: {
     "/locales/en.json": {
-        default: any;
+        default: {
+            "Hello, World": string;
+            "Switch Locale": string;
+            "Paste your variable here": string;
+            nested: {
+                "Nested key": string;
+                Language: string;
+                "nested second level": {
+                    "nested second level language": string;
+                };
+            };
+        };
     };
     "/locales/es.json": {
-        default: any;
+        default: {
+            "Hello, World": string;
+            "Switch Locale": string;
+            "Paste your variable here": string;
+            nested: {
+                "Nested key": string;
+                Language: string;
+                "nested second level": {
+                    "nested second level language": string;
+                };
+            };
+        };
     };
 };

package/package.json

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