nuxt-i18n-micro 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+ 
+ Copyright (c) 2016 
+ 
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+ 
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+ 
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.

package/README.md

@@ -0,0 +1,198 @@
+# Nuxt I18n Micro
+
+<div class="links">
+    <a href="https://www.npmjs.com/package/nuxt-i18n-micro" target="_blank">
+        <img src="https://img.shields.io/npm/v/nuxt-i18n-micro/latest?style=for-the-badge" alt="npm version">
+    </a>
+    <a href="https://www.npmjs.com/package/nuxt-i18n-micro" target="_blank">
+        <img src="https://img.shields.io/npm/dw/nuxt-i18n-micro?style=for-the-badge" alt="npm downloads">
+    </a>
+    <a href="https://www.npmjs.com/package/nuxt-i18n-micro" target="_blank">
+        <img src="https://img.shields.io/npm/l/nuxt-i18n-micro?style=for-the-badge" alt="License">
+    </a>
+    <a href="https://nuxt.com" target="_blank">
+        <img src="https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js&style=for-the-badge" alt="Nuxt">
+    </a>
+</div>
+
+`Nuxt I18n Micro` is a fast, simple, and lightweight internationalization (i18n) module for Nuxt. Despite its compact size, it's designed with large projects in mind, offering significant performance improvements over traditional i18n solutions like `nuxt-i18n`. The module was built from the ground up to be highly efficient, focusing on minimizing build times, reducing server load, and shrinking bundle sizes.
+
+## Why Nuxt I18n Micro?
+
+The `Nuxt I18n Micro` module was created to address critical performance issues found in the original `nuxt-i18n` module, particularly in high-traffic environments and projects with large translation files. Key issues with `nuxt-i18n` include:
+
+- **High Memory Consumption**: Consumes significant memory during both build and runtime, leading to performance bottlenecks.
+- **Slow Performance**: Especially with large translation files, it causes noticeable slowdowns in build times and server response.
+- **Large Bundle Size**: Generates a large bundle, negatively impacting application performance.
+- **Memory Leaks and Bugs**: Known for memory leaks and unpredictable behavior under heavy load.
+
+### Performance Comparison
+
+To showcase the efficiency of `Nuxt I18n Micro`, we conducted tests under identical conditions. Both modules were tested with a 10MB translation file on the same hardware.
+
+#### Build Time and Resource Consumption
+
+**Nuxt I18n**:
+- **Total size**: 54.7 MB (3.29 MB gzip)
+- **Max CPU Usage**: 394.0%
+- **Max Memory Usage**: 8746 MB
+- **Elapsed Time**: 0h 1m 30s
+
+**Nuxt I18n Micro**:
+- **Total size**: 22.4 MB (2.9 MB gzip) — **59% smaller**
+- **Max CPU Usage**: 305.3% — **23% lower**
+- **Max Memory Usage**: 3247 MB — **63% less memory**
+- **Elapsed Time**: 0h 0m 17s — **81% faster**
+
+#### Server Performance (10k Requests)
+
+**Nuxt I18n**:
+- **Requests per second**: 49.05 [#/sec] (mean)
+- **Time per request**: 611.599 ms (mean)
+- **Max Memory Usage**: 703.73 MB
+
+**Nuxt I18n Micro**:
+- **Requests per second**: 61.18 [#/sec] (mean) — **25% more requests per second**
+- **Time per request**: 490.379 ms (mean) — **20% faster**
+- **Max Memory Usage**: 323.00 MB — **54% less memory usage**
+
+These results clearly demonstrate that `Nuxt I18n Micro` significantly outperforms the original module in every critical area.
+
+## Key Features
+
+- 🌐 **Compact Yet Powerful**: Despite its small size, `Nuxt I18n Micro` is designed for large-scale projects, focusing on performance and efficiency.
+- ⚡ **Optimized Build and Runtime**: Reduces build times, memory usage, and server load, making it ideal for high-traffic applications.
+- 🛠 **Minimalist Design**: The module is structured around just 5 components (1 module and 4 plugins), making it easy to understand, extend, and maintain.
+- 📏 **Efficient Routing**: Generates only 2 routes regardless of the number of locales, thanks to dynamic regex-based routing, unlike other i18n modules that generate separate routes for each locale.
+- 🗂 **Streamlined Translation Loading**: Only JSON files are supported, with translations split between a global file for common texts (e.g., menus) and page-specific files, which are auto-generated in the `dev` mode if not present.
+
+## Quick Setup
+
+Install the module in your Nuxt application with:
+
+```bash
+npm install nuxt-i18n-micro
+```
+
+Then, add it to your `nuxt.config.ts`:
+
+```typescript
+export default defineNuxtConfig({
+  modules: [
+    'nuxt-i18n-micro',
+  ],
+  i18n: {
+    locales: [
+      { code: 'en', iso: 'en-US', dir: 'ltr' },
+      { code: 'fr', iso: 'fr-FR', dir: 'ltr' },
+      { code: 'ar', iso: 'ar-SA', dir: 'rtl' },
+    ],
+    defaultLocale: 'en',
+    translationDir: 'locales',
+    meta: true,
+  },
+})
+```
+
+That's it! You're now ready to use Nuxt I18n Micro in your Nuxt app.
+
+## Folder Structure
+
+Translations are organized into global and page-specific files:
+
+```
+/locales
+  /pages
+    /index
+      en.json
+      fr.json
+      ar.json
+    /about
+      en.json
+      fr.json
+      ar.json
+  en.json
+  fr.json
+  ar.json
+```
+
+- **Global File**: Located at `locales/{locale}.json` (e.g., `locales/en.json`). Used for common texts shared across multiple pages, such as menus.
+- **Page-Specific Files**: Located at `locales/pages/{routeName}/{locale}.json` (e.g., `locales/pages/index/en.json`). These are used for translations specific to individual pages.
+
+## Plugin Methods
+
+### `$getLocale()`
+Returns the current locale code.
+
+```typescript
+const locale = $getLocale()
+```
+
+### `$getLocales()`
+Returns an array of all available locales configured in the module.
+
+```typescript
+const locales = $getLocales()
+```
+
+### `$t(key: string, params?: Record<string, any>, defaultValue?: string)`
+Fetches a translation for the given key. Optionally interpolates parameters into the translation.
+
+```typescript
+const welcomeMessage = $t('welcome', { username: 'Alice', unreadCount: 5 })
+```
+
+### `$tc(key: string, count: number, defaultValue?: string)`
+Fetches a pluralized translation for the given key based on the count.
+
+```typescript
+const appleCountMessage = $tc('apples', 10)
+```
+
+### `$switchLocale(locale: string)`
+Switches to the given locale and redirects the user to the appropriate localized route.
+
+```typescript
+$switchLocale('fr')
+```
+
+### `$localeRoute(to: RouteLocationRaw): RouteLocationRaw`
+Generates a localized route object based on the target route.
+
+```typescript
+const localizedRoute = $localeRoute({ name: 'index' })
+```
+
+### `$mergeTranslations(newTranslations: Translations)`
+Merges new translations into the existing translation cache for the current route and locale.
+
+```typescript
+$mergeTranslations({
+  welcome: 'Bienvenue, {username}!'
+})
+```
+
+## Module Options
+
+The module accepts the following options in the Nuxt configuration:
+
+- **locales**: An array of locale objects. Each locale should have a `code`, and optionally, `iso` and `dir` (for RTL/LTR).
+  - Example:
+    ```typescript
+    locales: [
+      { code: 'en', iso: 'en-US', dir: 'ltr' },
+      { code: 'fr', iso: 'fr-FR', dir: 'ltr' },
+      { code: 'ar', iso: 'ar-SA', dir: 'rtl' }
+    ]
+    ```
+- **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.
+
+## Conclusion
+
+`Nuxt I18n Micro` offers a highly efficient, minimalist approach to internationalization in Nuxt applications. By focusing on performance and simplicity, it provides a powerful alternative to heavier, more complex i18n solutions. Whether you're building a small website or a large-scale application, `Nuxt I18n Micro` helps you manage multilingual content with ease.
+
+For more details and updates, visit the [Nuxt I18n Micro GitHub repository](https://github.com/s00d/nuxt-i18n-micro).

package/dist/client/200.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html><html  data-capo=""><head><meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link rel="stylesheet" href="/__nuxt-i18n-micro/_nuxt/entry.BkbVpYOg.css">
+<link rel="modulepreload" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/6EJ4fAZ2.js">
+<link rel="prefetch" as="style" href="/__nuxt-i18n-micro/_nuxt/error-404.CjTTbIxB.css">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/BdbjBFjr.js">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/DdqCv46g.js">
+<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/HZLiFEh-.js">
+<script type="module" src="/__nuxt-i18n-micro/_nuxt/6EJ4fAZ2.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:"3cd90d35-1876-4439-af68-a6e627aa85e6",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>

package/dist/client/404.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html><html  data-capo=""><head><meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<link rel="stylesheet" href="/__nuxt-i18n-micro/_nuxt/entry.BkbVpYOg.css">
+<link rel="modulepreload" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/6EJ4fAZ2.js">
+<link rel="prefetch" as="style" href="/__nuxt-i18n-micro/_nuxt/error-404.CjTTbIxB.css">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/BdbjBFjr.js">
+<link rel="prefetch" as="script" crossorigin href="/__nuxt-i18n-micro/_nuxt/DdqCv46g.js">
+<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/HZLiFEh-.js">
+<script type="module" src="/__nuxt-i18n-micro/_nuxt/6EJ4fAZ2.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:"3cd90d35-1876-4439-af68-a6e627aa85e6",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script></body></html>