@intlayer/config 6.0.2-canary.0 → 6.1.0

package/README.md

@@ -1,178 +1,276 @@
-<div align="center">
-  <a href="https://intlayer.org">
-    <img src="https://raw.githubusercontent.com/aymericzip/intlayer/572ae9c9acafb74307b81530c1931a8e98990aef/docs/assets/logo.png" width="500" alt="intlayer" />
+<p align="center">
+  <a href="https://intlayer.org" rel="">
+    <img src="https://raw.githubusercontent.com/aymericzip/intlayer/main/docs/assets/cover.png" width="60%" alt="Intlayer Logo" />
   </a>
-</div>
+</p>
+
+<h1 align="center">
+  <strong> Intlayer : an Open-source, per-component i18n toolkit with AI-powered translation & CMS.</strong>
+</h1>
+
+<br />
+
+<p align="center">
+  <a href="https://intlayer.org/doc/concept/content" rel="">Docs</a> •
+  <a href="https://intlayer.org/doc/environment/nextjs" rel="">Next.js</a> •
+  <a href="https://intlayer.org/doc/environment/vite-and-react" rel="">React + Vite</a> •
+  <a href="https://intlayer.org/doc/concept/cms" rel="">CMS</a> •
+  <a href="https://discord.gg/7uxamYVeCk" rel="noopener noreferrer nofollow">Discord</a>
+</p>
+<p align="center" style="margin-top:15px;">
+  <a href="https://www.npmjs.com/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/intlayer?style=for-the-badge&labelColor=FFFFFF&color=000000&logoColor=FFFFFF" alt="npm version" height="24"/></a>
+  <a href="https://github.com/aymericzip/intlayer/stargazers" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/stars/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logo=github&logoColor=FFD700" alt="GitHub Stars" height="24"/></a>
+  <a href="https://www.npmjs.org/package/intlayer" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="monthly downloads" height="24"/></a>
+  <a href="https://github.com/aymericzip/intlayer/blob/main/LICENSE" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/license/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="license"/></a>
+  <a href="https://github.com/aymericzip/intlayer/commits/main" target="_blank" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/github/last-commit/aymericzip/intlayer?style=for-the-badge&labelColor=000000&color=FFFFFF&logoColor=000000" alt="last commit"/>
+  </a>
+</p>
 
-<div align="center">
-  <a href="https://www.npmjs.com/package/intlayer" target="blank"><img
-    align="center"
-    alt="npm"
-    src="https://img.shields.io/npm/v/intlayer.svg?labelColor=49516F&color=8994BC&style=for-the-badge"
-    height="30" /></a>
-  <a href="https://npmjs.org/package/intlayer" target="blank"><img
-      align="center"
-      src="https://img.shields.io/npm/dm/intlayer?labelColor=49516F&color=8994BC&style=for-the-badge"
-      alt="monthly downloads"
-      height="30"
-    /></a>
-  <a href="https://npmjs.org/package/intlayer" target="blank"><img
-      align="center"
-      src="https://img.shields.io/npm/types/intlayer?label=types%20included&labelColor=49516F&color=8994BC&style=for-the-badge"
-      alt="types included"
-      height="30"
-    /></a>
-</div>
+![Watch the video](https://github.com/aymericzip/intlayer/blob/main/docs/assets/demo_video.gif)
 
-<div>
-    <br/>
-    <p align="center">
-      <a href="https://discord.gg/528mBV4N" target="blank"><img align="center"
-         src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
-         alt="Intlayer Discord" height="30"/></a>
-      <a href="https://www.linkedin.com/company/intlayerorg" target="blank"><img align="center"
-         src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
-         alt="Intlayer LinkedIn" height="30"/></a>
-      <a href="https://www.facebook.com/intlayer" target="blank"><img align="center"
-         src="https://img.shields.io/badge/facebook-4267B2.svg?style=for-the-badge&logo=facebook&logoColor=white"
-         alt="Intlayer Facebook" height="30"/></a>
-      <a href="https://www.instagram.com/intlayer/" target="blank"><img align="center"
-         src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
-         alt="Intlayer Instagram" height="30"/></a>
-      <a href="https://x.com/Intlayer183096" target="blank"><img align="center"
-         src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
-         alt="Intlayer X" height="30"/></a>
-      <a href="https://www.youtube.com/@intlayer" target="blank"><img align="center"
-         src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
-         alt="Intlayer YouTube" height="30"/></a>
-      <a href="https://www.tiktok.com/@intlayer" target="blank"><img align="center"
-         src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
-         alt="Intlayer TikTok" height="30"/></a>
-      <br>
-    </p>
-</div>
-
-# @intlayer/config: Retrieve Intlayer configuration
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
 
-**Intlayer** is a suite of packages designed specifically for JavaScript developers. It is compatible with frameworks like React, React, and Express.js.
+## What is Intlayer?
 
-The **`@intlayer/config`** package is a NPM package that allows you to retrieve the configuration of Intlayer and define the environment variables related to the current environment.
+Most i18n libraries are either too complex, too rigid, or not built for modern frameworks.
 
-## Installation
+Intlayer is a **modern i18n solution** for web and mobile apps.  
+It’s framework-agnostic, **AI-powered**, and includes a free **CMS & visual editor**.
 
-Install the necessary package using your preferred package manager:
+With **per-locale content files**, **TypeScript autocompletion**, **tree-shakable dictionaries**, and **CI/CD integration**, Intlayer makes internationalization **faster, cleaner, and smarter**.
 
-```bash packageManager="npm"
-npm install @intlayer/config
-```
+## Keys benefits of Intlayer:
 
-```bash packageManager="pnpm"
-pnpm add @intlayer/config
-```
+| Feature                                                                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                    |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/frameworks.png?raw=true" alt="Feature" width="700">                          | **Cross-Frameworks Support**<br><br>Intlayer is compatible with all major frameworks and libraries, including Next.js, React, Vite, Vue.js, Nuxt, Preact, Express, and more.                                                                                                                                                                                                                   |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/javascript_content_management.png?raw=true" alt="Feature" width="700">       | **JavaScript-Powered Content Management**<br><br>Harness the flexibility of JavaScript to define and manage your content efficiently. <br><br> - [Content declaration](https://intlayer.org/doc/concept/content)                                                                                                                                                                               |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/per_locale_content_declaration_file.png?raw=true" alt="Feature" width="700"> | **Per-Locale Content Declaration File**<br><br>Speed up your development by declaring your content once, before auto generation.<br><br> - [Per-Locale Content Declaration File](https://intlayer.org/doc/concept/per-locale-file)                                                                                                                                                             |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/autocompletion.png?raw=true" alt="Feature" width="700">                      | **Type-Safe Environment**<br><br>Leverage TypeScript to ensure your content definitions and code are error-free, while also benefiting from IDE autocompletion.<br><br> - [TypeScript configuration](https://intlayer.org/doc/environment/vite-and-react#configure-typescript)                                                                                                                 |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/config_file.png?raw=true" alt="Feature" width="700">                         | **Simplified Setup**<br><br>Get up and running quickly with minimal configuration. Adjust settings for internationalization, routing, AI, build, and content handling with ease. <br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                         |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/content_retrieval.png?raw=true" alt="Feature" width="700">                   | **Simplified Content Retrieval**<br><br>No need to call your `t` function for each piece of content. Retrieve all your content directly using a single hook.<br><br> - [React integration](https://intlayer.org/doc/environment/create-react-app)                                                                                                                                              |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/server_component.png?raw=true" alt="Feature" width="700">                    | **Consistent Server Component Implementation**<br><br>Perfectly suited for Next.js server components, use the same implementation for both client and server components, no need to pass your `t` function across each server component. <br><br> - [Server Components](https://intlayer.org/doc/environment/nextjs#step-7-utilize-content-in-your-code)                                       |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/file_tree.png?raw=true" alt="Feature" width="700">                           | **Organized Codebase**<br><br>Keep your codebase more organized: 1 component = 1 dictionary in the same folder. Translations close to their respective components, enhance maintainability and clarity. <br><br> - [How Intlayer works](https://intlayer.org/doc/concept/how-works-intlayer)                                                                                                   |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/url_routing.png?raw=true" alt="Feature" width="700">                         | **Enhanced Routing**<br><br>Full support of app routing, adapting seamlessly to complex application structures, for Next.js, React, Vite, Vue.js, etc.<br><br> - [Explore Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                                                    |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/markdown.png?raw=true" alt="Feature" width="700">                            | **Markdown Support**<br><br>Import and interpret, locale files and remote Markdown for multilingual content like privacy policies, documentation, etc. Interpret and make Markdown metadata accessible in your code.<br><br> - [Content files](https://intlayer.org/doc/concept/content/file)                                                                                                  |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/visual_editor.png?raw=true" alt="Feature" width="700">                       | **Free Visual Editor & CMS**<br><br>A free visual editor and CMS are available for content writers, removing the need for a localization platform. Keep your content synchronized using Git, or externalize it totally or partially with the CMS.<br><br> - [Intlayer Editor](https://intlayer.org/doc/concept/editor) <br> - [Intlayer CMS](https://intlayer.org/doc/concept/cms)             |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/bundle.png?raw=true" alt="Feature" width="700">                              | **Tree-shakable Content**<br><br>Tree-shakable content, reducing the size of the final bundle. Loads content per component, excluding any unused content from your bundle. Supports lazy loading to enhance app loading efficiency. <br><br> - [App build optimization](https://intlayer.org/doc/concept/how-works-intlayer#app-build-optimization)                                            |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/static_rendering.png?raw=true" alt="Feature" width="700">                    | **Static Rendering**<br><br>Doesn't block Static Rendering. <br><br> - [Next.js integration](https://intlayer.org/doc/environment/nextjs)                                                                                                                                                                                                                                                      |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/AI_translation.png?raw=true" alt="Feature" width="700">                      | **AI-Powered Translation**<br><br>Transform your website into 231 languages with just one click using Intlayer's advanced AI-powered translation tools using your own AI provider / API key. <br><br> - [CI/CD integration](https://intlayer.org/doc/concept/ci-cd) <br> - [Intlayer CLI](https://intlayer.org/doc/concept/cli) <br> - [Auto fill](https://intlayer.org/doc/concept/auto-fill) |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/mcp.png?raw=true" alt="Feature" width="700">                                 | **MCP Server Integration**<br><br>Provides an MCP (Model Context Protocol) server for IDE automation, enabling seamless content management and i18n workflows directly within your development environment. <br><br> - [MCP Server](https://github.com/aymericzip/intlayer/blob/main/docs/docs/en/mcp_server.md)                                                                               |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/vscode_extension.png?raw=true" alt="Feature" width="700">                    | **VSCode Extension**<br><br>Intlayer provides a VSCode extension to help you manage your content and translations, builting your dictionaries, translating your content, and more. <br><br> - [VSCode Extension](https://intlayer.org/doc/vs-code-extension)                                                                                                                                   |
+| <img src="https://github.com/aymericzip/intlayer/blob/main/docs/assets/interoperability.png?raw=true" alt="Feature" width="700">                    | **Interoperability**<br><br>Allow interoperability with react-i18next, next-i18next, next-intl, and react-intl. <br><br> - [Intlayer and react-intl](https://intlayer.org/blog/intlayer-with-react-intl) <br> - [Intlayer and next-intl](https://intlayer.org/blog/intlayer-with-next-intl) <br> - [Intlayer and next-i18next](https://intlayer.org/blog/intlayer-with-next-i18next)           |
 
-```bash packageManager="yarn"
-yarn add @intlayer/config
-```
+---
 
-## Usage
+## 📦 Installation
 
-### Read the configuration of Intlayer using file system
+Start your journey with Intlayer today and experience a smoother, more powerful approach to internationalization.
 
-Example:
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
 
-```ts
-import { getConfiguration, type IntlayerConfig } from "@intlayer/config";
-
-const config: IntlayerConfig = getConfiguration();
-
-console.log(config);
-// Output:
-// {
-//   internationalization: { ... },
-//   middleware: { ... },
-//   content: { ... },
-//   editor: { ... }
-// }
+```bash
+npm install intlayer react-intlayer
 ```
 
-> This function use `fs` packages and will only work on the server side.
-
-### Read the configuration of Intlayer using environment variables
-
-Example:
+⚡ Quick Start (Next.js)
 
 ```ts
-import { getConfiguration, type IntlayerConfig } from "@intlayer/config/client";
-
-const config: IntlayerConfig = getConfiguration({
-  env: "production",
-});
-
-console.log(config);
-// Output:
-// {
-//   internationalization: { ... },
-//   middleware: { ... },
-//   content: { ... },
-//   editor: { ... }
-// }
-```
-
-> This function will not return anything if the environment variables are not defined.
-
-### Define the environment variables
-
-1. Create a configuration file.
-
-```ts fileName="intlayer.config.ts"
-import { type IntlayerConfig } from "intlayer";
+// intlayer.config.ts
+import { Locales, type IntlayerConfig } from "intlayer";
 
 const config: IntlayerConfig = {
   internationalization: {
-    /* ... */
-  },
-  middleware: {
-    /* ... */
-  },
-  content: {
-    /* ... */
-  },
-  editor: {
-    /* ... */
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
   },
 };
 
 export default config;
 ```
 
-> See [Intlayer configuration documentation](https://intlayer.org/doc/concept/configuration) for more details.
+```ts
+// app/home.content.ts
+import { t, type Dictionary } from "intlayer";
 
-2. Define the environment variables.
+const content = {
+  key: "home",
+  content: {
+    title: t({
+      en: "Home",
+      fr: "Accueil",
+      es: "Inicio",
+    }),
+  },
+} satisfies Dictionary;
 
-```ts
-import { getConfiguration } from "@intlayer/config";
+export default content;
+```
 
-const intlayerConfig = getConfiguration();
+```tsx
+// app/page.tsx
+import { useIntlayer } from "react-intlayer";
 
-// Format all configuration values as environment variables
-const env = formatEnvVariable();
+const HomePage = () => {
+  const { title } = useIntlayer("home");
 
-// Set each formatted environment variable in process.env
-Object.assign(process.env, env);
+  return <h1>{title}</h1>;
+};
 ```
 
-3. Import the configuration file.
+<a href="https://intlayer.org/doc/environment/nextjs"> Get the full guide → </a>
+
+## 🎥 Live tutorial on YouTube
+
+[![How to Internationalize your application using Intlayer](https://i.ytimg.com/vi/e_PPG7PTqGU/hqdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==&rs=AOn4CLDtyJ4uYotEjl12nZ_gZKZ_kjEgOQ)](https://youtu.be/e_PPG7PTqGU?si=GyU_KpVhr61razRw)
+
+<a href="https://intlayer.org/doc/concept/content" rel="">
+  <img src="https://img.shields.io/badge/Get_Started-FFFFFF?style=for-the-badge&logo=rocket&logoColor=black" />
+</a>
+
+## Table of Contents
+
+Explore our comprehensive documentation to get started with Intlayer and learn how to integrate it into your projects.
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">📘 Get Started</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/why" rel=''>Why Intlayer?</a></li>
+  <li><a href="https://intlayer.org/doc" rel=''>Introduction</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">⚙️ Concept</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/concept/how-works-intlayer" rel=''>How Intlayer Works</a></li>
+  <li><a href="https://intlayer.org/doc/concept/configuration" rel=''>Configuration</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cli" rel=''>Intlayer CLI</a></li>
+  <li><a href="https://intlayer.org/doc/concept/editor" rel=''>Intlayer Editor</a></li>
+  <li><a href="https://intlayer.org/doc/concept/cms" rel=''>Intlayer CMS</a></li>
+  <li><a href="https://intlayer.org/doc/concept/content" rel=''>Dictionary</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/concept/content/per-locale-file" rel=''>Per-Locale Content Declaration File</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/translation" rel=''>Translation</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/enumeration" rel=''>Enumeration</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/condition" rel=''>Condition</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/nesting" rel=''>Nesting</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/markdown" rel=''>Markdown</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/function-fetching" rel=''>Function Fetching</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/insertion" rel=''>Insertion</a></li>
+      <li><a href="https://intlayer.org/doc/concept/content/file" rel=''>File</a></li>
+    </ul>
+  </li>
+</ul>
+</details>
+
+<details open>
+<summary style="font-size:16px; font-weight:bold;">🌐 Environment</summary>
+<ul>
+  <li><a href="https://intlayer.org/doc/environment/nextjs" rel=''>Intlayer with Next.js 15</a>
+    <ul>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/14" rel=''>Next.js 14 (App Router)</a></li>
+      <li><a href="https://intlayer.org/doc/environment/nextjs/next-with-Page-Router" rel=''>Next.js Page Router</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/create-react-app" rel=''>React CRA</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-react" rel=''>Vite + React</a>
+     <ul>
+      <li><a href="https://intlayer.org/doc/environment/vite-and-react/react-router-v7" rel=''>React-router-v7</a></li>
+      <li><a href="https://intlayer.org/doc/environment/vite-and-react/tanstack-start" rel=''>Tanstack start</a></li>
+    </ul>
+  </li>
+  <li><a href="https://intlayer.org/doc/environment/react-native-and-expo" rel=''>React Native</a></li>
+  <li><a href="https://intlayer.org/doc/environment/lynx-and-react" rel=''>Lynx + React</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-svelte" rel=''>Vite + Svelte</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-preact" rel=''>Vite + Preact</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-vue" rel=''>Vite + Vue</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-nuxt" rel=''>Vite + Nuxt</a></li>
+  <li><a href="https://intlayer.org/doc/environment/vite-and-solid" rel=''>Vite + Solid</a></li>
+  <li><a href="https://intlayer.org/doc/environment/angular" rel=''>Angular</a></li>
+  <li><a href="https://intlayer.org/doc/environment/express" rel=''>Express</a></li>
+  <li><a href="https://intlayer.org/doc/environment/nest" rel=''>NestJS</a></li>
+</ul>
+</details>
+
+<details>
+<summary style="font-size:16px; font-weight:bold;">📰 Blog</summary>
+<ul>
+  <li><a href="https://github.com/aymericzip/intlayer/blob/main/docs/blog/en/what_is_internationalization.md" rel=''>What is i18n</a></li>
+  <li><a href="https://intlayer.org/blog/SEO-and-i18n" rel=''>i18n and SEO</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-i18next" rel=''>Intlayer and i18next</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-react-i18next" rel=''>Intlayer and react-intl</a></li>
+  <li><a href="https://intlayer.org/blog/intlayer-with-next-intl" rel=''>Intlayer and next-intl</a></li>
+</ul>
+</details>
+
+## 🌐 Readme in other languages
+
+<p align="center">
+  <a href="https://github.com/aymericzip/intlayer/blob/main/readme.md">English</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/readme.md">简体中文</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ru/readme.md">Русский</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ja/readme.md">日本語</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/readme.md">Français</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ko/readme.md">한국어</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/readme.md">Español</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/de/readme.md">Deutsch</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/ar/readme.md">العربية</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/it/readme.md">Italiano</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/en-GB/readme.md">English (UK)</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/pt/readme.md">Português</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/hi/readme.md">हिन्दी</a> •
+  <a href="https://github.com/aymericzip/intlayer/blob/main/docs/docs/tr/readme.md">Türkçe</a>
+</p>
+
+## 🤝 Community
+
+Intlayer is built with and for the community and we’d love your input!
+
+- Have a suggestion? [Open an issue](https://github.com/aymericzip/intlayer/issues)
+- Found a bug or improvement? [Submit a PR](https://github.com/aymericzip/intlayer/pulls)
+- Need help or want to connect? [Join our Discord](https://discord.gg/7uxamYVeCk)
+
+You can also follow us on :
+
+  <div>
+    <br/>
+    <p align="center">
+      <a href="https://discord.gg/528mBV4N" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/discord-5865F2.svg?style=for-the-badge&logo=discord&logoColor=white"
+         alt="Intlayer Discord" height="30"/></a>
+      <a href="https://www.linkedin.com/company/intlayerorg" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/linkedin-%231DA1F2.svg?style=for-the-badge&logo=linkedin&logoColor=white"
+         alt="Intlayer LinkedIn" height="30"/></a>
+      <a href="https://www.facebook.com/intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/facebook-4267B2.svg?style=for-the-badge&logo=facebook&logoColor=white"
+         alt="Intlayer Facebook" height="30"/></a>
+      <a href="https://www.instagram.com/intlayer/" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/instagram-%23E4405F.svg?style=for-the-badge&logo=Instagram&logoColor=white"
+         alt="Intlayer Instagram" height="30"/></a>
+      <a href="https://x.com/Intlayer183096" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/x-1DA1F2.svg?style=for-the-badge&logo=x&logoColor=white"
+         alt="Intlayer X" height="30"/></a>
+      <a href="https://www.youtube.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/youtube-FF0000.svg?style=for-the-badge&logo=youtube&logoColor=white"
+         alt="Intlayer YouTube" height="30"/></a>
+      <a href="https://www.tiktok.com/@intlayer" target="blank" rel='noopener noreferrer nofollow'><img align="center"
+         src="https://img.shields.io/badge/tiktok-000000.svg?style=for-the-badge&logo=tiktok&logoColor=white"
+         alt="Intlayer TikTok" height="30"/></a>
+      <br>
+    </p>
+</div>
 
-```ts
-import { getConfiguration } from "@intlayer/config/client";
+### Contribution
 
-const intlayerConfig = getConfiguration();
-```
+For more detailed guidelines on contributing to this project, please refer to the [`CONTRIBUTING.md`](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md) file. It contains essential information on our development process, commit message conventions, and release procedures. Your contributions are valuable to us, and we appreciate your efforts in making this project better!
 
-## Read about Intlayer
+### Thank You for the Support
 
-- [Intlayer Website](https://intlayer.org)
-- [Intlayer Documentation](https://intlayer.org/doc)
-- [Intlayer GitHub](https://github.com/aymericzip/intlayer)
+If you like Intlayer, give us a ⭐ on GitHub. It helps others discover the project! [See why GitHub Stars matter](https://github.com/aymericzip/intlayer/blob/main/CONTRIBUTING.md#why-github-stars-matter-).
 
-- [Ask your questions to our smart documentation](https://intlayer.org/docchat)
+[![Star History Chart](https://api.star-history.com/svg?repos=aymericzip/intlayer&type=Date)](https://star-history.com/#aymericzip/intlayer&Date)

package/dist/cjs/alias.cjs

@@ -27,7 +27,7 @@ var import_getExtension = require('./utils/getExtension.cjs');
 var import_normalizePath = require('./utils/normalizePath.cjs');
 const getAlias = ({
   configuration = (0, import_getConfiguration.getConfiguration)(),
-  format,
+  format = "esm",
   formatter = (value) => value
 } = {}) => {
   const extension = (0, import_getExtension.getExtension)(configuration, format);

package/dist/cjs/alias.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/alias.ts"],"sourcesContent":["import { join, relative } from 'path';\nimport { getConfiguration } from './configFile/getConfiguration';\nimport { IntlayerConfig } from './types/config';\nimport { getExtension } from './utils/getExtension';\nimport { normalizePath } from './utils/normalizePath';\n\nexport type GetAliasOptions = {\n  configuration?: IntlayerConfig;\n  format?: 'esm' | 'cjs';\n  formatter?: (value: string) => string;\n};\n\nexport const getAlias = ({\n  configuration = getConfiguration(),\n  format,\n  formatter = (value: string) => value,\n}: GetAliasOptions = {}) => {\n  const extension = getExtension(configuration, format);\n\n  const { mainDir, configDir, baseDir } = configuration.content;\n\n  /**\n   * Dictionaries\n   */\n  const dictionariesPath = join(mainDir, `dictionaries.${extension}`);\n  const relativeDictionariesPath = relative(baseDir, dictionariesPath);\n  const normalizedDictionariesPath = formatter(\n    normalizePath(relativeDictionariesPath)\n  );\n\n  /**\n   * Unmerged dictionaries\n   */\n  const unmergedDictionariesPath = join(\n    mainDir,\n    `unmerged_dictionaries.${extension}`\n  );\n  const relativeUnmergedDictionariesPath = relative(\n    baseDir,\n    unmergedDictionariesPath\n  );\n  const normalizedUnmergedDictionariesPath = formatter(\n    normalizePath(relativeUnmergedDictionariesPath)\n  );\n\n  /**\n   * Remote dictionaries\n   */\n  const remoteDictionariesPath = join(\n    mainDir,\n    `remote_dictionaries.${extension}`\n  );\n  const relativeRemoteDictionariesPath = relative(\n    baseDir,\n    remoteDictionariesPath\n  );\n  const normalizedRemoteDictionariesPath = formatter(\n    normalizePath(relativeRemoteDictionariesPath)\n  );\n\n  /**\n   * Dynamic dictionaries\n   */\n  const dynamicDictionariesPath = join(\n    mainDir,\n    `dynamic_dictionaries.${extension}`\n  );\n  const relativeDynamicDictionariesPath = relative(\n    baseDir,\n    dynamicDictionariesPath\n  );\n  const normalizedDynamicDictionariesPath = formatter(\n    normalizePath(relativeDynamicDictionariesPath)\n  );\n\n  /**\n   * Fetch dictionaries\n   */\n  const fetchDictionariesPath = join(\n    mainDir,\n    `fetch_dictionaries.${extension}`\n  );\n  const relativeFetchDictionariesPath = relative(\n    baseDir,\n    fetchDictionariesPath\n  );\n  const normalizedFetchDictionariesPath = formatter(\n    normalizePath(relativeFetchDictionariesPath)\n  );\n\n  /**\n   * Configuration\n   */\n  const configurationPath = join(configDir, `configuration.json`);\n  const relativeConfigurationPath = relative(baseDir, configurationPath);\n  const normalizedConfigurationPath = formatter(\n    normalizePath(relativeConfigurationPath)\n  );\n\n  return {\n    '@intlayer/dictionaries-entry': normalizedDictionariesPath,\n    '@intlayer/unmerged-dictionaries-entry': normalizedUnmergedDictionariesPath,\n    '@intlayer/remote-dictionaries-entry': normalizedRemoteDictionariesPath,\n    '@intlayer/dynamic-dictionaries-entry': normalizedDynamicDictionariesPath,\n    '@intlayer/fetch-dictionaries-entry': normalizedFetchDictionariesPath,\n    '@intlayer/config/built': normalizedConfigurationPath,\n  };\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA+B;AAC/B,8BAAiC;AAEjC,0BAA6B;AAC7B,2BAA8B;AAQvB,MAAM,WAAW,CAAC;AAAA,EACvB,oBAAgB,0CAAiB;AAAA,EACjC;AAAA,EACA,YAAY,CAAC,UAAkB;AACjC,IAAqB,CAAC,MAAM;AAC1B,QAAM,gBAAY,kCAAa,eAAe,MAAM;AAEpD,QAAM,EAAE,SAAS,WAAW,QAAQ,IAAI,cAAc;AAKtD,QAAM,uBAAmB,kBAAK,SAAS,gBAAgB,SAAS,EAAE;AAClE,QAAM,+BAA2B,sBAAS,SAAS,gBAAgB;AACnE,QAAM,6BAA6B;AAAA,QACjC,oCAAc,wBAAwB;AAAA,EACxC;AAKA,QAAM,+BAA2B;AAAA,IAC/B;AAAA,IACA,yBAAyB,SAAS;AAAA,EACpC;AACA,QAAM,uCAAmC;AAAA,IACvC;AAAA,IACA;AAAA,EACF;AACA,QAAM,qCAAqC;AAAA,QACzC,oCAAc,gCAAgC;AAAA,EAChD;AAKA,QAAM,6BAAyB;AAAA,IAC7B;AAAA,IACA,uBAAuB,SAAS;AAAA,EAClC;AACA,QAAM,qCAAiC;AAAA,IACrC;AAAA,IACA;AAAA,EACF;AACA,QAAM,mCAAmC;AAAA,QACvC,oCAAc,8BAA8B;AAAA,EAC9C;AAKA,QAAM,8BAA0B;AAAA,IAC9B;AAAA,IACA,wBAAwB,SAAS;AAAA,EACnC;AACA,QAAM,sCAAkC;AAAA,IACtC;AAAA,IACA;AAAA,EACF;AACA,QAAM,oCAAoC;AAAA,QACxC,oCAAc,+BAA+B;AAAA,EAC/C;AAKA,QAAM,4BAAwB;AAAA,IAC5B;AAAA,IACA,sBAAsB,SAAS;AAAA,EACjC;AACA,QAAM,oCAAgC;AAAA,IACpC;AAAA,IACA;AAAA,EACF;AACA,QAAM,kCAAkC;AAAA,QACtC,oCAAc,6BAA6B;AAAA,EAC7C;AAKA,QAAM,wBAAoB,kBAAK,WAAW,oBAAoB;AAC9D,QAAM,gCAA4B,sBAAS,SAAS,iBAAiB;AACrE,QAAM,8BAA8B;AAAA,QAClC,oCAAc,yBAAyB;AAAA,EACzC;AAEA,SAAO;AAAA,IACL,gCAAgC;AAAA,IAChC,yCAAyC;AAAA,IACzC,uCAAuC;AAAA,IACvC,wCAAwC;AAAA,IACxC,sCAAsC;AAAA,IACtC,0BAA0B;AAAA,EAC5B;AACF;","names":[]}
+{"version":3,"sources":["../../src/alias.ts"],"sourcesContent":["import { join, relative } from 'path';\nimport { getConfiguration } from './configFile/getConfiguration';\nimport { IntlayerConfig } from './types/config';\nimport { getExtension } from './utils/getExtension';\nimport { normalizePath } from './utils/normalizePath';\n\nexport type GetAliasOptions = {\n  configuration?: IntlayerConfig;\n  format?: 'esm' | 'cjs';\n  formatter?: (value: string) => string;\n};\n\nexport const getAlias = ({\n  configuration = getConfiguration(),\n  format = 'esm',\n  formatter = (value: string) => value,\n}: GetAliasOptions = {}) => {\n  const extension = getExtension(configuration, format);\n\n  const { mainDir, configDir, baseDir } = configuration.content;\n\n  /**\n   * Dictionaries\n   */\n  const dictionariesPath = join(mainDir, `dictionaries.${extension}`);\n  const relativeDictionariesPath = relative(baseDir, dictionariesPath);\n  const normalizedDictionariesPath = formatter(\n    normalizePath(relativeDictionariesPath)\n  );\n\n  /**\n   * Unmerged dictionaries\n   */\n  const unmergedDictionariesPath = join(\n    mainDir,\n    `unmerged_dictionaries.${extension}`\n  );\n  const relativeUnmergedDictionariesPath = relative(\n    baseDir,\n    unmergedDictionariesPath\n  );\n  const normalizedUnmergedDictionariesPath = formatter(\n    normalizePath(relativeUnmergedDictionariesPath)\n  );\n\n  /**\n   * Remote dictionaries\n   */\n  const remoteDictionariesPath = join(\n    mainDir,\n    `remote_dictionaries.${extension}`\n  );\n  const relativeRemoteDictionariesPath = relative(\n    baseDir,\n    remoteDictionariesPath\n  );\n  const normalizedRemoteDictionariesPath = formatter(\n    normalizePath(relativeRemoteDictionariesPath)\n  );\n\n  /**\n   * Dynamic dictionaries\n   */\n  const dynamicDictionariesPath = join(\n    mainDir,\n    `dynamic_dictionaries.${extension}`\n  );\n  const relativeDynamicDictionariesPath = relative(\n    baseDir,\n    dynamicDictionariesPath\n  );\n  const normalizedDynamicDictionariesPath = formatter(\n    normalizePath(relativeDynamicDictionariesPath)\n  );\n\n  /**\n   * Fetch dictionaries\n   */\n  const fetchDictionariesPath = join(\n    mainDir,\n    `fetch_dictionaries.${extension}`\n  );\n  const relativeFetchDictionariesPath = relative(\n    baseDir,\n    fetchDictionariesPath\n  );\n  const normalizedFetchDictionariesPath = formatter(\n    normalizePath(relativeFetchDictionariesPath)\n  );\n\n  /**\n   * Configuration\n   */\n  const configurationPath = join(configDir, `configuration.json`);\n  const relativeConfigurationPath = relative(baseDir, configurationPath);\n  const normalizedConfigurationPath = formatter(\n    normalizePath(relativeConfigurationPath)\n  );\n\n  return {\n    '@intlayer/dictionaries-entry': normalizedDictionariesPath,\n    '@intlayer/unmerged-dictionaries-entry': normalizedUnmergedDictionariesPath,\n    '@intlayer/remote-dictionaries-entry': normalizedRemoteDictionariesPath,\n    '@intlayer/dynamic-dictionaries-entry': normalizedDynamicDictionariesPath,\n    '@intlayer/fetch-dictionaries-entry': normalizedFetchDictionariesPath,\n    '@intlayer/config/built': normalizedConfigurationPath,\n  };\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA+B;AAC/B,8BAAiC;AAEjC,0BAA6B;AAC7B,2BAA8B;AAQvB,MAAM,WAAW,CAAC;AAAA,EACvB,oBAAgB,0CAAiB;AAAA,EACjC,SAAS;AAAA,EACT,YAAY,CAAC,UAAkB;AACjC,IAAqB,CAAC,MAAM;AAC1B,QAAM,gBAAY,kCAAa,eAAe,MAAM;AAEpD,QAAM,EAAE,SAAS,WAAW,QAAQ,IAAI,cAAc;AAKtD,QAAM,uBAAmB,kBAAK,SAAS,gBAAgB,SAAS,EAAE;AAClE,QAAM,+BAA2B,sBAAS,SAAS,gBAAgB;AACnE,QAAM,6BAA6B;AAAA,QACjC,oCAAc,wBAAwB;AAAA,EACxC;AAKA,QAAM,+BAA2B;AAAA,IAC/B;AAAA,IACA,yBAAyB,SAAS;AAAA,EACpC;AACA,QAAM,uCAAmC;AAAA,IACvC;AAAA,IACA;AAAA,EACF;AACA,QAAM,qCAAqC;AAAA,QACzC,oCAAc,gCAAgC;AAAA,EAChD;AAKA,QAAM,6BAAyB;AAAA,IAC7B;AAAA,IACA,uBAAuB,SAAS;AAAA,EAClC;AACA,QAAM,qCAAiC;AAAA,IACrC;AAAA,IACA;AAAA,EACF;AACA,QAAM,mCAAmC;AAAA,QACvC,oCAAc,8BAA8B;AAAA,EAC9C;AAKA,QAAM,8BAA0B;AAAA,IAC9B;AAAA,IACA,wBAAwB,SAAS;AAAA,EACnC;AACA,QAAM,sCAAkC;AAAA,IACtC;AAAA,IACA;AAAA,EACF;AACA,QAAM,oCAAoC;AAAA,QACxC,oCAAc,+BAA+B;AAAA,EAC/C;AAKA,QAAM,4BAAwB;AAAA,IAC5B;AAAA,IACA,sBAAsB,SAAS;AAAA,EACjC;AACA,QAAM,oCAAgC;AAAA,IACpC;AAAA,IACA;AAAA,EACF;AACA,QAAM,kCAAkC;AAAA,QACtC,oCAAc,6BAA6B;AAAA,EAC7C;AAKA,QAAM,wBAAoB,kBAAK,WAAW,oBAAoB;AAC9D,QAAM,gCAA4B,sBAAS,SAAS,iBAAiB;AACrE,QAAM,8BAA8B;AAAA,QAClC,oCAAc,yBAAyB;AAAA,EACzC;AAEA,SAAO;AAAA,IACL,gCAAgC;AAAA,IAChC,yCAAyC;AAAA,IACzC,uCAAuC;AAAA,IACvC,wCAAwC;AAAA,IACxC,sCAAsC;AAAA,IACtC,0BAA0B;AAAA,EAC5B;AACF;","names":[]}

package/dist/cjs/configFile/buildConfigurationFields.cjs

@@ -517,7 +517,7 @@ const buildEditorFields = (customConfiguration) => ({
    */
   liveSyncURL: customConfiguration?.liveSyncURL ?? `http://localhost:${customConfiguration?.liveSyncPort ?? import_editor.LIVE_SYNC_PORT}`
 });
-const buildLogFields = (customConfiguration) => ({
+const buildLogFields = (customConfiguration, logFunctions) => ({
   /**
    * Indicates if the logger is enabled
    *
@@ -535,7 +535,14 @@ const buildLogFields = (customConfiguration) => ({
    *
    * The prefix of the logger.
    */
-  prefix: customConfiguration?.prefix ?? import_log.PREFIX
+  prefix: customConfiguration?.prefix ?? import_log.PREFIX,
+  /**
+   * Functions to log
+   */
+  error: logFunctions?.error,
+  log: logFunctions?.log,
+  info: logFunctions?.info,
+  warn: logFunctions?.warn
 });
 const buildAiFields = (customConfiguration) => ({
   /**
@@ -633,7 +640,7 @@ const buildBuildFields = (customConfiguration) => ({
    */
   outputFormat: customConfiguration?.outputFormat ?? import_build.OUTPUT_FORMAT
 });
-const buildConfigurationFields = (customConfiguration, baseDir) => {
+const buildConfigurationFields = (customConfiguration, baseDir, logFunctions) => {
   const internationalizationConfig = buildInternationalizationFields(
     customConfiguration?.internationalization
   );
@@ -645,7 +652,7 @@ const buildConfigurationFields = (customConfiguration, baseDir) => {
     baseDir
   );
   const editorConfig = buildEditorFields(customConfiguration?.editor);
-  const logConfig = buildLogFields(customConfiguration?.log);
+  const logConfig = buildLogFields(customConfiguration?.log, logFunctions);
   const aiConfig = buildAiFields(customConfiguration?.ai);
   const buildConfig = buildBuildFields(customConfiguration?.build);
   storedConfiguration = {