@intlayer/docs 8.2.3 → 8.3.0-canary.0

package/docs/en-GB/compiler.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-09-09
-updatedAt: 2026-02-25
+updatedAt: 2026-03-10
 title: Intlayer Compiler | Automated Content Extraction for i18n
 description: Automate your internationalisation process with the Intlayer Compiler. Extract content directly from your components for faster, more efficient i18n in Vite, Next.js, and more.
 keywords:
@@ -20,6 +20,9 @@ slugs:
   - doc
   - compiler
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.7
     date: 2026-02-25
     changes: Update compiler options
@@ -157,13 +160,12 @@ import { type IntlayerConfig, Locales } from "intlayer";
 const config: IntlayerConfig = {
   compiler: {
     /**
-     * Indicates if the compiler should be enabled.
      * Set to 'build-only' to skip the compiler during development and speed up start times.
      */
     enabled: true,
 
     /**
-     * Pattern to traverse the code to optimise.
+     * Pattern to traverse the code to optimize.
      */
     transformPattern: [
       "**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}",
@@ -171,14 +173,19 @@ const config: IntlayerConfig = {
     ],
 
     /**
-     * Pattern to exclude from the optimisation.
+     * Pattern to exclude from the optimization.
      */
     excludePattern: ["**/node_modules/**"],
 
     /**
-     * Output directory for the optimised dictionaries.
+     * Output directory for the optimized dictionaries.
      */
-    outputDir: "i18n",
+    output: ({ key }) => `compiler/${key}.content.json`,
+
+    /**
+     * Inset only content in generated file, without key.
+     */
+    noMetadata: false,
 
     /**
      * Dictionary key prefix
@@ -196,6 +203,65 @@ const config: IntlayerConfig = {
 export default config;
 ```
 
+### Compiler Configuration Reference
+
+The following properties can be configured in the `compiler` block of your `intlayer.config.ts` file:
+
+- **enabled**:
+  - _Type_: `boolean | 'build-only'`
+  - _Default_: `true`
+  - _Description_: Indicates if the compiler should be enabled.
+- **dictionaryKeyPrefix**:
+  - _Type_: `string`
+  - _Default_: `'comp-'`
+  - _Description_: Prefix for the extracted dictionary keys.
+- **transformPattern**:
+  - _Type_: `string | string[]`
+  - _Default_: `['**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}', '!**/node_modules/**']`
+  - _Description_: Patterns to traverse the code to optimize.
+- **excludePattern**:
+  - _Type_: `string | string[]`
+  - _Default_: `['**/node_modules/**']`
+  - _Description_: Patterns to exclude from the optimization.
+- **outputDir** (Deprecated):
+  - _Type_: `string`
+  - _Default_: `'compiler'`
+  - _Description_: The directory where the extracted dictionaries will be stored.
+
+- **output**:
+  - _Type_: `FilePathPattern`
+  - _Default_: `({ key }) => 'compiler/${key}.content.json'`
+  - _Description_: Defines the output files path. Replaces `outputDir`. Handles dynamic variables like `{{locale}}`, `{{key}}`, `{{fileName}}`, `{{extension}}`, `{{format}}`, `{{dirPath}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{componentFormat}}`. Can be set as a string using `'my/{{var}}/path'` format, or as a function.
+  - _Note_: `./**/*` Path are resolved relatively to the component. `/**/*` path are resolved relatively to the Intlayer `baseDir`.
+  - _Example_: `output: ({ locale, key }) => 'compiler/${locale}/${key}.json'`
+
+- **noMetadata**:
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Indicates if the metadata should be saved in the file. If true, the compiler will not save the metadata of the dictionaries (key, content wrapper).
+  - _Note_: Useful if used with `loadJSON` plugin.
+  - _Example_:
+    If `true`:
+    ```json
+    {
+      "key": "value"
+    }
+    ```
+    If `false`:
+    ```json
+    {
+      "key": "value",
+      "content": {
+        "key": "value"
+      }
+    }
+    ```
+
+- **saveComponents**:
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Indicates if the components should be saved after being transformed.
+
 ### Fill missing translation
 
 Intlayer provide a CLI tool to help you fill missing translations. You can use the `intlayer` command to test and fill missing translations from your code.

package/docs/en-GB/configuration.md

@@ -14,6 +14,9 @@ slugs:
   - concept
   - configuration
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add 'output' and 'noMetadata' support
   - version: 8.1.7
     date: 2026-02-25
     changes: Update compiler options
@@ -439,7 +442,12 @@ const config: IntlayerConfig = {
     /**
      * Output directory for the optimized dictionaries.
      */
-    outputDir: "compiler",
+    output: ({ key }) => `compiler/${key}.content.json`,
+
+    /**
+     * Inset only content in generated file, without key.
+     */
+    noMetadata: false,
 
     /**
      * Dictionary key prefix
@@ -704,7 +712,7 @@ Settings related to content handling within the application, including directory
 #### Properties
 
 - **autoFill**:
-  - _Type_: `boolean | string | { [key in Locales]?: string }`
+  - _Type_: `boolean | string | FilePathPattern | { [key in Locales]?: string }`
   - _Default_: `undefined`
   - _Description_: Indicates how the content should be automatically filled using AI. Can be declared globally in the `intlayer.config.ts` file.
   - _Example_: true
@@ -1063,3 +1071,32 @@ Settings that control the Intlayer compiler, which extracts dictionaries straigh
   - _Type_: `string`
   - _Default_: `'compiler'`
   - _Description_: The directory where the extracted dictionaries will be stored, relative to your project base path.
+
+- **output**:
+  - _Type_: `FilePathPattern`
+  - _Default_: `({ key }) => 'compiler/${key}.content.json'`
+  - _Description_: Defines the output files path. Replaces `outputDir`. Handles dynamic variables like `{{locale}}`, `{{key}}`, `{{fileName}}`, `{{extension}}`, `{{format}}`, `{{dirPath}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{componentFormat}}`. Can be set as a string using `'my/{{var}}/path'` format, or as a function.
+  - _Note_: `./**/*` Path are resolved relatively to the component. `/**/*` path are resolved relatively to the Intlayer `baseDir`.
+  - _Example_: `output: ({ locale, key }) => 'compiler/${locale}/${key}.json'`
+
+- **noMetadata**:
+  - _Type_: `boolean`
+  - _Default_: `false`
+  - _Description_: Indicates if the metadata should be saved in the file. If true, the compiler will not save the metadata of the dictionaries (key, content wrapper).
+  - _Note_: Useful if used with `loadJSON` plugin.
+  - _Example_:
+    If `true`:
+    ```json
+    {
+      "key": "value"
+    }
+    ```
+    If `false`:
+    ```json
+    {
+      "key": "value",
+      "content": {
+        "key": "value"
+      }
+    }
+    ```

package/docs/en-GB/intlayer_with_nextjs_compiler.md

@@ -20,6 +20,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-next-no-lolale-path-template
 youtubeVideo: https://www.youtube.com/watch?v=e_PPG7PTqGU
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.6
     date: 2026-02-23
     changes: Initial release
@@ -127,9 +130,25 @@ const config: IntlayerConfig = {
     mode: "search-params",
   },
   compiler: {
-    enabled: true, // Can be set to 'build-only' to limit impact on dev mode
-    outputDir: "i18n",
-    dictionaryKeyPrefix: "", // No prefix, default is "comp-"
+    /**
+     * Set to 'build-only' to skip the compiler during development and speed up start times.
+     */
+    enabled: true,
+
+    /**
+     * Output directory for the optimized dictionaries.
+     */
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
+
+    /**
+     * Inset only content in generated file, without key.
+     */
+    noMetadata: false,
+
+    /**
+     * Dictionary key prefix
+     */
+    dictionaryKeyPrefix: "", // Remove base prefix
   },
   ai: {
     provider: "openai",

package/docs/en-GB/intlayer_with_vite+react_compiler.md

@@ -19,6 +19,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-vite-react-template
 youtubeVideo: https://www.youtube.com/watch?v=dS9L7uJeak4
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.6
     date: 2026-02-23
     changes: Initial release
@@ -124,9 +127,25 @@ const config: IntlayerConfig = {
     defaultLocale: Locales.ENGLISH,
   },
   compiler: {
-    enabled: true, // Can be set to 'build-only' to limit impact on dev mode
-    outputDir: "i18n",
-    dictionaryKeyPrefix: "", // No prefix comp-
+    /**
+     * Set to 'build-only' to skip the compiler during development and speed up start times.
+     */
+    enabled: true,
+
+    /**
+     * Output directory for the optimized dictionaries.
+     */
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
+
+    /**
+     * Inset only content in generated file, without key.
+     */
+    noMetadata: false,
+
+    /**
+     * Dictionary key prefix
+     */
+    dictionaryKeyPrefix: "", // Remove base prefix
   },
   ai: {
     provider: "openai",

package/docs/en-GB/per_locale_file.md

@@ -126,7 +126,7 @@ const config: IntlayerConfig = {
 export default config;
 ```
 
-Using this configuration, all per-locale files will be generated with the default locale set to English. It also includes generation of `.content` files using the `extract` command, and the compiler. (See [Compiler](https://intlayer.org/doc/compiler) or [Extract](https://intlayer.org/doc/concept/cli/extract) for more information.)
+Using this configuration, all per-locale files will be generated with the default locale set to English. It also includes generation of `.content` files using the `extract` command, and the compiler. (See [Compiler](https://intlayer.org/doc/compiler) or [Extract](https://github.com/aymericzip/intlayer/edit/main/docs/docs/en/cli/extract.md) for more information.)
 
 ## Per-Locale Format
 

package/docs/es/compiler.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2025-09-09
-updatedAt: 2026-02-25
+updatedAt: 2026-03-10
 title: Intlayer Compiler | Extracción Automática de Contenido para i18n
 description: Automatiza tu proceso de internacionalización con el Intlayer Compiler. Extrae contenido directamente de tus componentes para una i18n más rápida y eficiente en Vite, Next.js y más.
 keywords:
@@ -20,6 +20,9 @@ slugs:
   - doc
   - compiler
 history:
+  - version: 8.2.0
+    date: 2026-03-10
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.7
     date: 2026-02-25
     changes: Actualizar opciones del compilador
@@ -157,7 +160,6 @@ import { type IntlayerConfig, Locales } from "intlayer";
 const config: IntlayerConfig = {
   compiler: {
     /**
-     * Indica si el compilador debe estar habilitado.
      * Establécelo en 'build-only' para omitir el compilador durante el desarrollo y acelerar los tiempos de inicio.
      */
     enabled: true,
@@ -171,23 +173,28 @@ const config: IntlayerConfig = {
     ],
 
     /**
-     * Patrón para excluir de la optimización.
+     * Patrón a excluir de la optimización.
      */
     excludePattern: ["**/node_modules/**"],
 
     /**
      * Directorio de salida para los diccionarios optimizados.
      */
-    outputDir: "i18n",
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
+
+    /**
+     * Inserta solo el contenido en el archivo generado, sin clave.
+     */
+    noMetadata: false,
 
     /**
      * Prefijo de clave de diccionario
      */
-    dictionaryKeyPrefix: "", // Eliminar prefijo base
+    dictionaryKeyPrefix: "", // Eliminar el prefijo base
 
     /**
      * Indica si los componentes deben guardarse después de ser transformados.
-     * De esta manera, el compilador puede ejecutarse solo una vez para transformar la aplicación y luego puede eliminarse.
+     * De esta manera, el compilador puede ejecutarse una sola vez para transformar la aplicación y luego puede eliminarse.
      */
     saveComponents: false,
   },
@@ -209,3 +216,61 @@ npx intlayer fill         # Rellenar traducciones faltantes
 ```
 
 > Para más detalles, consulta la [documentación de la CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/cli/ci.md)
+
+### Referencia de configuración del compilador
+
+Las siguientes propiedades pueden configurarse en el bloque `compiler` de tu archivo `intlayer.config.ts`:
+
+- **enabled**:
+  - _Tipo_: `boolean | 'build-only'`
+  - _Por defecto_: `true`
+  - _Descripción_: Indica si el compilador debe estar habilitado.
+- **dictionaryKeyPrefix**:
+  - _Tipo_: `string`
+  - _Por defecto_: `'comp-'`
+  - _Descripción_: Prefijo para las claves de diccionario extraídas.
+- **transformPattern**:
+  - _Tipo_: `string | string[]`
+  - _Por defecto_: `['**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}', '!**/node_modules/**']`
+  - _Descripción_: Patrones para recorrer el código a optimizar.
+- **excludePattern**:
+  - _Tipo_: `string | string[]`
+  - _Por defecto_: `['**/node_modules/**']`
+  - _Descripción_: Patrones para excluir de la optimización.
+- **outputDir** (Deprecated):
+  - _Tipo_: `string`
+  - _Por defecto_: `'compiler'`
+  - _Descripción_: El directorio donde se almacenarán los diccionarios extraídos.
+
+- **output**:
+  - _Type_: `FilePathPattern`
+  - _Por defecto_: `({ key }) => 'compiler/${key}.content.json'`
+  - _Descripción_: Define la ruta de los archivos de salida. Reemplaza `outputDir`. Maneja variables dinámicas como `{{locale}}`, `{{key}}`, `{{fileName}}`, `{{extension}}`, `{{format}}`, `{{dirPath}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{componentFormat}}`. Se puede configurar como una cadena usando el formato `'my/{{var}}/path'` o como una función.
+  - _Nota_: `./**/*` Los caminos se resuelven de forma relativa al componente. `/**/*` los caminos se resuelven de forma relativa al `baseDir` de Intlayer.
+  - _Ejemplo_: `output: ({ locale, key }) => 'compiler/${locale}/${key}.json'`
+
+- **noMetadata**:
+  - _Tipo_: `boolean`
+  - _Por defecto_: `false`
+  - _Descripción_: Indica si los metadatos deben guardarse en el archivo. Si es verdadero, el compilador no guardará los metadatos de los diccionarios (clave, contenedor de contenido).
+  - _Nota_: Útil si se usa con el plugin `loadJSON`.
+  - _Ejemplo_: Si es `true`:
+    ```json
+    {
+      "key": "value"
+    }
+    ```
+    Si es `false`:
+    ```json
+    {
+      "key": "value",
+      "content": {
+        "key": "value"
+      }
+    }
+    ```
+
+- **saveComponents**:
+  - _Tipo_: `boolean`
+  - _Por defecto_: `false`
+  - _Descripción_: Indica si los componentes deben guardarse después de ser transformados.

package/docs/es/configuration.md

@@ -1,6 +1,6 @@
 ---
 createdAt: 2024-08-13
-updatedAt: 2026-02-25
+updatedAt: 2026-03-10
 title: Configuración
 description: Aprende cómo configurar Intlayer para tu aplicación. Entiende las diversas configuraciones y opciones disponibles para personalizar Intlayer según tus necesidades.
 keywords:
@@ -14,6 +14,9 @@ slugs:
   - concept
   - configuration
 history:
+  - version: 8.2.0
+    date: 2026-03-10
+    changes: Update compiler options, add 'output' and 'noMetadata' support
   - version: 8.1.7
     date: 2026-02-25
     changes: Actualizar opciones del compilador
@@ -419,12 +422,12 @@ const config: IntlayerConfig = {
    */
   compiler: {
     /**
-     * Indicates if the compiler should be enabled.
+     * Establécelo en 'build-only' para omitir el compilador durante el desarrollo y acelerar los tiempos de inicio.
      */
     enabled: true,
 
     /**
-     * Pattern to traverse the code to optimize.
+     * Patrón para recorrer el código a optimizar.
      */
     transformPattern: [
       "**/*.{js,ts,mjs,cjs,jsx,tsx,vue,svelte}",
@@ -432,23 +435,28 @@ const config: IntlayerConfig = {
     ],
 
     /**
-     * Pattern to exclude from the optimization.
+     * Patrón a excluir de la optimización.
      */
     excludePattern: ["**/node_modules/**"],
 
     /**
-     * Output directory for the optimized dictionaries.
+     * Directorio de salida para los diccionarios optimizados.
      */
-    outputDir: "compiler",
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
 
     /**
-     * Dictionary key prefix
+     * Inserta solo el contenido en el archivo generado, sin clave.
      */
-    dictionaryKeyPrefix: "", // Remove base prefix
+    noMetadata: false,
 
     /**
-     * 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.
+     * Prefijo de clave de diccionario
+     */
+    dictionaryKeyPrefix: "", // Eliminar el prefijo base
+
+    /**
+     * Indica si los componentes deben guardarse después de ser transformados.
+     * De esta manera, el compilador puede ejecutarse una sola vez para transformar la aplicación y luego puede eliminarse.
      */
     saveComponents: false,
   },
@@ -704,7 +712,7 @@ Configuraciones relacionadas con el manejo de contenido dentro de la aplicación
 #### Propiedades
 
 - **autoFill**:
-  - _Tipo_: `boolean | string | { [key in Locales]?: string }`
+  - _Tipo_: `boolean | string | FilePathPattern | { [key in Locales]?: string }`
   - _Por defecto_: `undefined`
   - _Descripción_: Indica cómo debe completarse automáticamente el contenido usando IA. Puede declararse globalmente en el archivo `intlayer.config.ts`.
   - _Ejemplo_: true
@@ -962,10 +970,10 @@ Las opciones de compilación se aplican a los plugins `@intlayer/babel` y `@intl
   - _Nota_: Puede usarse para deshabilitar la compilación de diccionarios, por ejemplo cuando se debe evitar la ejecución en un entorno Node.js.
 
 - **checkTypes**:
-  - _Type_: `boolean`
-  - _Default_: `false`
-  - _Description_: Indica si la compilación debe comprobar los tipos de TypeScript y registrar errores.
-  - _Note_: Esto puede ralentizar la compilación.
+  - _Tipo_: `boolean`
+  - _Por defecto_: `false`
+  - _Descripción_: Indica si la compilación debe comprobar los tipos de TypeScript y registrar errores.
+  - _Nota_: Esto puede ralentizar la compilación.
 
 - **optimize**:
   - _Tipo_: `boolean`
@@ -978,7 +986,7 @@ Las opciones de compilación se aplican a los plugins `@intlayer/babel` y `@intl
   - _Nota_: Asegúrese de que todas las claves estén declaradas estáticamente en las llamadas a `useIntlayer`. Por ejemplo, `useIntlayer('navbar')`.
 
 - **importMode**:
-  - _Note_: **Deprecated**: Use `dictionary.importMode` instead.
+  - _Nota_: **Deprecated**: Use `dictionary.importMode` instead.
   - _Tipo_: `'static' | 'dynamic' | 'fetch'`
   - _Por defecto_: `'static'`
   - _Descripción_: Controla cómo se importan los diccionarios.
@@ -1057,3 +1065,31 @@ Ajustes que controlan el compilador Intlayer, que extrae diccionarios directamen
   - _Tipo_: `string`
   - _Por defecto_: `'compiler'`
   - _Descripción_: El directorio donde se almacenarán los diccionarios extraídos, relativo a la ruta base de su proyecto.
+
+- **output**:
+  - _Type_: `FilePathPattern`
+  - _Por defecto_: `({ key }) => 'compiler/${key}.content.json'`
+  - _Descripción_: Define la ruta de los archivos de salida. Reemplaza `outputDir`. Maneja variables dinámicas como `{{locale}}`, `{{key}}`, `{{fileName}}`, `{{extension}}`, `{{format}}`, `{{dirPath}}`, `{{componentFileName}}`, `{{componentExtension}}`, `{{componentFormat}}`. Se puede configurar como una cadena usando el formato `'my/{{var}}/path'` o como una función.
+  - _Nota_: `./**/*` Los caminos se resuelven de forma relativa al componente. `/**/*` los caminos se resuelven de forma relativa al `baseDir` de Intlayer.
+  - _Ejemplo_: `output: ({ locale, key }) => 'compiler/${locale}/${key}.json'`
+
+- **noMetadata**:
+  - _Tipo_: `boolean`
+  - _Por defecto_: `false`
+  - _Descripción_: Indica si los metadatos deben guardarse en el archivo. Si es verdadero, el compilador no guardará los metadatos de los diccionarios (clave, contenedor de contenido).
+  - _Nota_: Útil si se usa con el plugin `loadJSON`.
+  - _Ejemplo_: Si es `true`:
+    ```json
+    {
+      "key": "value"
+    }
+    ```
+    Si es `false`:
+    ```json
+    {
+      "key": "value",
+      "content": {
+        "key": "value"
+      }
+    }
+    ```

package/docs/es/intlayer_with_nextjs_compiler.md

@@ -20,6 +20,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-next-no-lolale-path-template
 youtubeVideo: https://www.youtube.com/watch?v=e_PPG7PTqGU
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.6
     date: 2026-02-23
     changes: Versión inicial
@@ -135,7 +138,12 @@ const config: IntlayerConfig = {
     /**
      * Directorio de salida para los diccionarios optimizados.
      */
-    outputDir: "compiler",
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
+
+    /**
+     * Inserta solo el contenido en el archivo generado, sin clave.
+     */
+    noMetadata: false,
 
     /**
      * Prefijo de clave de diccionario

package/docs/es/intlayer_with_vite+react_compiler.md

@@ -19,6 +19,9 @@ slugs:
 applicationTemplate: https://github.com/aymericzip/intlayer-vite-react-template
 youtubeVideo: https://www.youtube.com/watch?v=dS9L7uJeak4
 history:
+  - version: 8.2.0
+    date: 2026-03-09
+    changes: Update compiler options, add FilePathPattern support
   - version: 8.1.6
     date: 2026-02-23
     changes: Lanzamiento inicial
@@ -132,7 +135,12 @@ const config: IntlayerConfig = {
     /**
      * Directorio de salida para los diccionarios optimizados.
      */
-    outputDir: "compiler",
+    output: ({ locale, key }) => `compiler/${locale}/${key}.json`,
+
+    /**
+     * Inserta solo el contenido en el archivo generado, sin clave.
+     */
+    noMetadata: false,
 
     /**
      * Prefijo de clave de diccionario