Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/s00d/nuxt-i18n-micro
Nuxt I18n Micro is a fast, simple, and lightweight internationalization (i18n) module for Nuxt
https://github.com/s00d/nuxt-i18n-micro
i18n internationalization localization multi-language nuxt nuxt-module nuxt3 performance seo translation
Last synced: 4 days ago
JSON representation
Nuxt I18n Micro is a fast, simple, and lightweight internationalization (i18n) module for Nuxt
- Host: GitHub
- URL: https://github.com/s00d/nuxt-i18n-micro
- Owner: s00d
- License: mit
- Created: 2024-08-15T14:43:40.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-12-17T11:54:09.000Z (5 days ago)
- Last Synced: 2024-12-17T12:31:17.917Z (5 days ago)
- Topics: i18n, internationalization, localization, multi-language, nuxt, nuxt-module, nuxt3, performance, seo, translation
- Language: TypeScript
- Homepage: https://s00d.github.io/nuxt-i18n-micro/
- Size: 12.6 MB
- Stars: 104
- Watchers: 2
- Forks: 16
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/nuxt-i18n-micro)
[](https://www.npmjs.com/package/nuxt-i18n-micro)
[](https://www.npmjs.com/package/nuxt-i18n-micro)
[](https://nuxt.com)
[](https://www.donationalerts.com/r/s00d88)
# Nuxt I18n Micro
`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.31 MB gzip)
- **Max CPU Usage**: 391.4%
- **Max Memory Usage**: 8305 MB
- **Elapsed Time**: 0h 1m 31s
**Nuxt I18n Micro**:
- **Total size**: 1.93 MB (473 kB gzip) — **96% smaller**
- **Max CPU Usage**: 220.1% — **44% lower**
- **Max Memory Usage**: 655 MB — **92% less memory**
- **Elapsed Time**: 0h 0m 5s — **94% 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.
[Docs](https://s00d.github.io/nuxt-i18n-micro/)
[Plugin Methods](https://s00d.github.io/nuxt-i18n-micro/api/methods)
[Performanc](https://s00d.github.io/nuxt-i18n-micro/guide/performance)
[Performance Test Results](https://s00d.github.io/nuxt-i18n-micro/guide/performance-results)
[Components](https://s00d.github.io/nuxt-i18n-micro/components/i18n-t)
[Layers](https://s00d.github.io/nuxt-i18n-micro/guide/layers)
[Seo](https://s00d.github.io/nuxt-i18n-micro/guide/seo)
[Migration](https://s00d.github.io/nuxt-i18n-micro/guide/migration)
[Contribution](https://s00d.github.io/nuxt-i18n-micro/guide/contribution)