@intlayer/docs 8.4.10 → 8.5.1

package/docs/de/intlayer_with_vite+vue.md

@@ -455,14 +455,14 @@ Um die Internationalisierungsfunktionen von Intlayer in Ihrer gesamten Vue-Anwen
 
 ```javascript fileName=main.js
 import { createApp } from "vue";
-import { installIntlayer } from "vue-intlayer";
+import { intlayer } from "vue-intlayer";
 import App from "./App.vue";
 import "./style.css";
 
 const app = createApp(App);
 
 // Den Provider auf der obersten Ebene einfügen
-installIntlayer(app);
+app.use(intlayer);
 
 // Die App mounten
 app.mount("#app");
@@ -643,7 +643,7 @@ import {
   localeFlatMap,
   type Locale,
 } from 'intlayer';
-import { createIntlayerClient } from 'vue-intlayer';
+import { createIntlayerClient } from "vue-intlayer";
 import { createRouter, createWebHistory } from 'vue-router';
 import HomeView from './views/home/HomeView.vue';
 import RootView from './views/root/Root.vue';
@@ -731,7 +731,11 @@ import { intlayer, intlayerProxy } from "vite-intlayer";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -742,7 +746,11 @@ import { intlayer, intlayerProxy } from "vite-intlayer";
 
 // https://vitejs.dev/config/
 export default defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -753,7 +761,11 @@ const { intlayer, intlayerProxy } = require("vite-intlayer");
 
 // https://vitejs.dev/config/
 module.exports = defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 const { defineConfig } = require("vite");
 const vue = require("@vitejs/plugin-vue");
@@ -761,7 +773,11 @@ const { intlayer, intlayerProxy } = require("vite-intlayer");
 
 // https://vitejs.dev/config/
 module.exports = defineConfig({
-  plugins: [vue(), intlayer(), intlayerProxy()],
+  plugins: [
+    intlayerProxy(), // should be placed first
+    vue(),
+    intlayer(),
+  ],
 });
 ```
 
@@ -1031,7 +1047,7 @@ import { installIntlayer, installIntlayerMarkdown } from "vue-intlayer";
 
 const app = createApp(App);
 
-installIntlayer(app);
+app.use(intlayer);
 
 const md = new MarkdownIt({
   html: true, // HTML-Tags erlauben

package/docs/de/packages/react-intlayer/MarkdownRenderer.md

@@ -28,7 +28,7 @@ Die `MarkdownRenderer`-Komponente rendert Markdown-Inhalte mit benutzerdefiniert
 ## Verwendung
 
 ```tsx
-import { MarkdownRenderer } from "react-intlayer";
+import { MarkdownRenderer } from "react-intlayer/markdown";
 
 const MyComponent = () => (
   <MarkdownRenderer># My Title My content</MarkdownRenderer>

package/docs/de/packages/svelte-intlayer/useRewriteURL.md

@@ -29,7 +29,7 @@ Rufe den Hook innerhalb einer Svelte-Komponente auf.
 
 ```svelte
 <script>
-  import { useRewriteURL } from 'svelte-intlayer';
+  import { useRewriteURL } from "svelte-intlayer";
 
   // Korrigiert automatisch /fr/tests zu /fr/essais in der Adressleiste, falls eine Rewrite-Regel existiert
   useRewriteURL();

package/docs/de/releases/v8.md

@@ -69,7 +69,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { MarkdownRenderer } from "react-intlayer";
+    import { MarkdownRenderer } from "react-intlayer/markdown";
 
     <MarkdownRenderer
       forceBlock={true}
@@ -84,7 +84,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useMarkdownRenderer } from "react-intlayer";
+    import { useMarkdownRenderer } from "react-intlayer/markdown";
 
     const renderMarkdown = useMarkdownRenderer({
       components: {
@@ -98,7 +98,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderMarkdown } from "react-intlayer";
+    import { renderMarkdown } from "react-intlayer/markdown";
 
     const html = renderMarkdown("# Mein Titel", {
       forceBlock: true
@@ -112,7 +112,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```vue
     <script setup>
-    import { MarkdownRenderer } from "vue-intlayer";
+    import { MarkdownRenderer } from "vue-intlayer/markdown";
     </script>
 
     <template>
@@ -127,7 +127,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { MarkdownRenderer } from "svelte-intlayer";
+      import { MarkdownRenderer } from "svelte-intlayer/markdown";
     </script>
 
     <MarkdownRenderer forceBlock={true} value="# Mein Titel" />
@@ -137,7 +137,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { useMarkdownRenderer } from "svelte-intlayer";
+      import { useMarkdownRenderer } from "svelte-intlayer/markdown";
       const render = useMarkdownRenderer();
     </script>
 
@@ -148,7 +148,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { renderMarkdown } from "svelte-intlayer";
+      import { renderMarkdown } from "svelte-intlayer/markdown";
     </script>
 
     {@html renderMarkdown("# Mein Titel")}
@@ -179,7 +179,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { MarkdownRenderer } from "solid-intlayer";
+    import { MarkdownRenderer } from "solid-intlayer/markdown";
 
     <MarkdownRenderer forceBlock={true}>
       {"# Mein Titel"}
@@ -189,7 +189,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useMarkdownRenderer } from "solid-intlayer";
+    import { useMarkdownRenderer } from "solid-intlayer/markdown";
 
     const render = useMarkdownRenderer();
 
@@ -199,7 +199,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderMarkdown } from "solid-intlayer";
+    import { renderMarkdown } from "solid-intlayer/markdown";
 
     return <div>{renderMarkdown("# Mein Titel")}</div>;
     ```
@@ -210,7 +210,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { MarkdownRenderer } from "preact-intlayer";
+    import { MarkdownRenderer } from "preact-intlayer/markdown";
 
     <MarkdownRenderer forceBlock={true}>
       {"# Mein Titel"}
@@ -220,7 +220,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useMarkdownRenderer } from "preact-intlayer";
+    import { useMarkdownRenderer } from "preact-intlayer/markdown";
 
     const render = useMarkdownRenderer();
 
@@ -230,7 +230,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderMarkdown } from "preact-intlayer";
+    import { renderMarkdown } from "preact-intlayer/markdown";
 
     return <div>{renderMarkdown("# Mein Titel")}</div>;
     ```
@@ -246,7 +246,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { HTMLRenderer } from "react-intlayer";
+    import { HTMLRenderer } from "react-intlayer/html";
 
     <HTMLRenderer
       components={{
@@ -260,7 +260,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useHTMLRenderer } from "react-intlayer";
+    import { useHTMLRenderer } from "react-intlayer/html";
 
     const renderHTML = useHTMLRenderer({
       components: {
@@ -274,7 +274,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderHTML } from "react-intlayer";
+    import { renderHTML } from "react-intlayer/html";
 
     const html = renderHTML("<p>Hallo Welt</p>");
     ```
@@ -286,7 +286,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```vue
     <script setup>
-    import { HTMLRenderer } from "vue-intlayer";
+    import { HTMLRenderer } from "vue-intlayer/html";
     </script>
 
     <template>
@@ -301,7 +301,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { HTMLRenderer } from "svelte-intlayer";
+      import { HTMLRenderer } from "svelte-intlayer/html";
     </script>
 
     <HTMLRenderer value="<p>Hallo Welt</p>" />
@@ -311,7 +311,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { useHTMLRenderer } from "svelte-intlayer";
+      import { useHTMLRenderer } from "svelte-intlayer/html";
       const render = useHTMLRenderer();
     </script>
 
@@ -322,7 +322,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
 
     ```svelte
     <script>
-      import { renderHTML } from "svelte-intlayer";
+      import { renderHTML } from "svelte-intlayer/html";
     </script>
 
     {@html renderHTML("<p>Hallo Welt</p>")}
@@ -345,7 +345,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { HTMLRenderer } from "solid-intlayer";
+    import { HTMLRenderer } from "solid-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hallo Welt</p>"}
@@ -355,7 +355,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useHTMLRenderer } from "solid-intlayer";
+    import { useHTMLRenderer } from "solid-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -365,7 +365,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderHTML } from "solid-intlayer";
+    import { renderHTML } from "solid-intlayer/html";
 
     return <div>{renderHTML("<p>Hallo Welt</p>")}</div>;
     ```
@@ -376,7 +376,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **1. Verwendung der Komponente:**
 
     ```tsx
-    import { HTMLRenderer } from "preact-intlayer";
+    import { HTMLRenderer } from "preact-intlayer/html";
 
     <HTMLRenderer>
       {"<p>Hallo Welt</p>"}
@@ -386,7 +386,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **2. Verwendung des Hooks:**
 
     ```tsx
-    import { useHTMLRenderer } from "preact-intlayer";
+    import { useHTMLRenderer } from "preact-intlayer/html";
 
     const render = useHTMLRenderer();
 
@@ -396,7 +396,7 @@ Wir haben neue eigenständige Renderer-Funktionen und Komponenten eingeführt, u
     **3. Verwendung der Utility-Funktion:**
 
     ```tsx
-    import { renderHTML } from "preact-intlayer";
+    import { renderHTML } from "preact-intlayer/html";
 
     return <div>{renderHTML("<p>Hallo Welt</p>")}</div>;
     ```
@@ -1033,7 +1033,7 @@ Intlayer v8 enthält eine neue Caching-Schicht für den Markdown- und HTML-Compi
    
     ```typescript fileName="vite.config.js"
     import { defineConfig } from 'vite';
-    import {intlayer, intlayerCompiler} from 'vite-intlayer';
+    import { intlayer, intlayerCompiler } from "vite-intlayer";
 
     export default defineConfig({
       plugins: [intlayer(), intlayerCompiler()],

package/docs/en/compiler.md

@@ -214,7 +214,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed.
+     *
+     * - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
      */
     saveComponents: false,
 
@@ -293,6 +296,8 @@ The following properties can be configured in the `compiler` block of your `intl
   - _Type_: `boolean`
   - _Default_: `false`
   - _Description_: Indicates if the components should be saved after being transformed.
+    - If `true`, the compiler will rewrite the component file in the disk. The transformation will be permanent, and the compiler can then be removed.
+    - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
 
 ### Fill missing translation
 

package/docs/en/configuration.md

@@ -518,7 +518,10 @@ const config: IntlayerConfig = {
 
     /**
      * Indicates if the components should be saved after being transformed.
-     * That way, the compiler can be run only once to transform the app, and then it can be removed.
+     *
+     * - If `true`, the compiler will rewrite the component file in the disk. So the transformation will be permanent, and the compiler will skip the transformation for the next process. That way, the compiler can transform the app, and then it can be removed.
+     *
+     * - If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. The transformation will be done only in memory.
      */
     saveComponents: false,
 
@@ -933,14 +936,14 @@ Build options apply to the `@intlayer/babel` and `@intlayer/swc` plugins.
 
 Settings that control the Intlayer compiler, which extracts dictionaries straight from your components.
 
-| Field                 | Description                                                                                                                                                                                                                                                                                                | Type                                                                                                            | Default     | Example                                                                                                                                                  | Note                                                                                                                                                                                                                                                           |
-| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `enabled`             | Indicates if the compiler should be enabled to extract dictionaries.                                                                                                                                                                                                                                       | `boolean` &#124; <br/> `'build-only'`                                                                           | `true`      | `'build-only'`                                                                                                                                           | `'build-only'` skips the compiler during development to speed up builds; only runs on build commands.                                                                                                                                                          |
-| `dictionaryKeyPrefix` | Prefix for the extracted dictionary keys.                                                                                                                                                                                                                                                                  | `string`                                                                                                        | `''`        | `'my-key-'`                                                                                                                                              | Added to the generated key (based on file name) to prevent conflicts.                                                                                                                                                                                          |
-| `saveComponents`      | Indicates if components should be saved after being transformed.                                                                                                                                                                                                                                           | `boolean`                                                                                                       | `false`     |                                                                                                                                                          | • If `true`, replaces original files with transformed files.<br/>• The compiler can then be removed after one run.                                                                                                                                             |
-| `output`              | Defines the output file path. Replaces `outputDir`. Supports template variables: `{{fileName}}`, <br/> `{{key}}`, <br/> `{{locale}}`, <br/> `{{extension}}`, <br/> `{{componentFileName}}`, <br/> `{{componentExtension}}`, <br/> `{{format}}`, <br/> `{{componentFormat}}`, <br/> `{{componentDirPath}}`. | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `undefined` | `'./{{fileName}}{{extension}}'` <br/> `'/locales/{{locale}}/{{key}}.json'` <br/> `{ en: ({ key }) => './locales/en/${key}.json', fr: '...', es: false }` | • `./` paths resolve relative to the component directory.<br/>• `/` paths resolve relative to the project root.<br/>• Including `{{locale}}` generates separate per-locale dictionaries.<br/>• Supports per-locale object notation; `false` skips that locale. |
-| `noMetadata`          | If `true`, the compiler omits dictionary metadata (key, content wrapper) from the output.                                                                                                                                                                                                                  | `boolean`                                                                                                       | `false`     | `false` → `{"key":"my-key","content":{"key":"value"}}` <br/> `true` → `{"key":"value"}`                                                                  | • Useful for i18next or ICU MessageFormat JSON outputs.<br/>• Works well with `loadJSON` plugin.                                                                                                                                                               |
-| `dictionaryKeyPrefix` | Dictionary key prefix                                                                                                                                                                                                                                                                                      | `string`                                                                                                        | `''`        |                                                                                                                                                          | Add an optional prefix for the extracted dictionary keys                                                                                                                                                                                                       |
+| Field                 | Description                                                                                                                                                                                                                                                                                                | Type                                                                                                            | Default     | Example                                                                                                                                                  | Note                                                                                                                                                                                                                                                                                                       |
+| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `enabled`             | Indicates if the compiler should be enabled to extract dictionaries.                                                                                                                                                                                                                                       | `boolean` &#124; <br/> `'build-only'`                                                                           | `true`      | `'build-only'`                                                                                                                                           | `'build-only'` skips the compiler during development to speed up builds; only runs on build commands.                                                                                                                                                                                                      |
+| `dictionaryKeyPrefix` | Prefix for the extracted dictionary keys.                                                                                                                                                                                                                                                                  | `string`                                                                                                        | `''`        | `'my-key-'`                                                                                                                                              | Added to the generated key (based on file name) to prevent conflicts.                                                                                                                                                                                                                                      |
+| `saveComponents`      | Indicates if the components should be saved after being transformed.                                                                                                                                                                                                                                       | `boolean`                                                                                                       | `false`     |                                                                                                                                                          | • If `true`, the compiler will rewrite the component file in the disk. The transformation will be permanent, and the compiler can then be removed.<br/>• If `false`, the compiler will inject the `useIntlayer()` function call into the code in the build output only, and keep the base codebase intact. |
+| `output`              | Defines the output file path. Replaces `outputDir`. Supports template variables: `{{fileName}}`, <br/> `{{key}}`, <br/> `{{locale}}`, <br/> `{{extension}}`, <br/> `{{componentFileName}}`, <br/> `{{componentExtension}}`, <br/> `{{format}}`, <br/> `{{componentFormat}}`, <br/> `{{componentDirPath}}`. | `boolean` &#124; <br/> `FilePathPattern` &#124; <br/> `Partial<Record<Locale, boolean &#124; FilePathPattern>>` | `undefined` | `'./{{fileName}}{{extension}}'` <br/> `'/locales/{{locale}}/{{key}}.json'` <br/> `{ en: ({ key }) => './locales/en/${key}.json', fr: '...', es: false }` | • `./` paths resolve relative to the component directory.<br/>• `/` paths resolve relative to the project root.<br/>• Including `{{locale}}` generates separate per-locale dictionaries.<br/>• Supports per-locale object notation; `false` skips that locale.                                             |
+| `noMetadata`          | If `true`, the compiler omits dictionary metadata (key, content wrapper) from the output.                                                                                                                                                                                                                  | `boolean`                                                                                                       | `false`     | `false` → `{"key":"my-key","content":{"key":"value"}}` <br/> `true` → `{"key":"value"}`                                                                  | • Useful for i18next or ICU MessageFormat JSON outputs.<br/>• Works well with `loadJSON` plugin.                                                                                                                                                                                                           |
+| `dictionaryKeyPrefix` | Dictionary key prefix                                                                                                                                                                                                                                                                                      | `string`                                                                                                        | `''`        |                                                                                                                                                          | Add an optional prefix for the extracted dictionary keys                                                                                                                                                                                                                                                   |
 
 ### Custom Schemas