@intlayer/docs 7.2.3 → 7.3.0

package/docs/es/cli/test.md

@@ -0,0 +1,76 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Testear traducciones faltantes
+description: Aprende cómo probar e identificar traducciones faltantes en tus diccionarios.
+keywords:
+  - Prueba
+  - Traducciones faltantes
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - test
+---
+
+# Probar traducciones faltantes
+
+```bash
+npx intlayer content test
+```
+
+## Alias:
+
+- `npx intlayer test`
+
+Este comando analiza tus archivos de declaración de contenido para identificar traducciones faltantes en todos los locales configurados. Proporciona un informe completo que muestra qué claves de traducción faltan para qué locales, ayudándote a mantener la consistencia en tu contenido multilingüe.
+
+## Ejemplo de salida:
+
+```bash
+pnpm intlayer content test
+Missing translations:
+ - home-page                      - tr         - src/components/HomePage/homePage.content.ts
+ - server-component               - es, tr     - src/components/ServerComponent/serverComponent.content.ts
+ - client-component               - pl, tr     - src/components/ClientComponent/clientComponent.content.ts
+Locales: en, ru, ja, fr, ko, zh, es, de, ar, it, en-GB, pt, hi, tr, pl
+Locales requeridos: en
+Locales faltantes: pl, tr, es
+Locales requeridos faltantes: -
+Total de locales faltantes: 3
+Total de locales requeridos faltantes: 0
+```
+
+## Argumentos:
+
+**Opciones de configuración:**
+
+- **`--env`**: Especifica el entorno (por ejemplo, `development`, `production`).
+- **`--env-file [envFile]`**: Proporciona un archivo de entorno personalizado para cargar variables.
+- **`--base-dir`**: Especifica el directorio base para el proyecto.
+
+  > Ejemplo: `npx intlayer content test --base-dir ./src --env-file .env.production.local`
+
+- **`--no-cache`**: Deshabilita la caché.
+
+  > Ejemplo: `npx intlayer build --no-cache`
+
+**Opciones de preparación:**
+
+- **`--build`**: Construye los diccionarios antes de hacer push para asegurar que el contenido esté actualizado. True forzará la construcción, false la omitirá, undefined permitirá usar la caché de la construcción.
+
+**Opciones de registro:**
+
+- **`--verbose`**: Activa el registro detallado para depuración. (por defecto es true usando CLI)
+
+  > Ejemplo: `npx intlayer content test --verbose`
+
+## Ejemplo:
+
+```bash
+npx intlayer content test --verbose
+```
+
+La salida te ayuda a identificar rápidamente qué traducciones necesitan completarse para asegurar que tu aplicación funcione correctamente en todos los locales configurados.

package/docs/es/cli/transform.md

@@ -0,0 +1,65 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Transformar Componentes
+description: Aprende cómo transformar componentes existentes para usar Intlayer.
+keywords:
+  - Transformar
+  - Componentes
+  - Migración
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - transform
+---
+
+# Transformar componentes
+
+```bash
+npx intlayer transform
+```
+
+Este comando analiza tus archivos de código para ayudar a migrar componentes existentes a usar Intlayer. Soporta selección interactiva de archivos o la selección específica de archivos.
+
+## Alias:
+
+- `npx intlayer trans`
+
+## Argumentos:
+
+**Opciones de selección de archivos:**
+
+- **`-f, --file [files...]`**: Lista de archivos específicos para transformar. Si no se proporciona, el CLI escaneará archivos que coincidan (`**/*.{tsx,jsx,vue,svelte,ts,js}`) y te pedirá seleccionar cuáles transformar.
+
+  > Ejemplo: `npx intlayer transform -f src/components/MyComponent.tsx`
+
+**Opciones de salida:**
+
+- **`-o, --output-content-declarations [outputContentDeclarations]`**: Directorio para guardar los archivos generados de declaración de contenido.
+
+  > Ejemplo: `npx intlayer transform -o src/content`
+
+- **`--code-only`**: Solo transforma el código del componente (no escribe la declaración de contenido).
+
+  > Ejemplo: `npx intlayer transform --code-only`
+
+- **`--declaration-only`**: Solo genera la declaración de contenido (no reescribe el componente).
+
+  > Ejemplo: `npx intlayer transform --declaration-only`
+
+**Opciones de configuración:**
+
+- **`--base-dir`**: Especifica el directorio base para el proyecto.
+- **`--env`**: Especifica el entorno.
+- **`--env-file`**: Proporciona un archivo de entorno personalizado.
+- **`--verbose`**: Habilita el registro detallado.
+
+**Plugins requeridos:**
+
+El comando transform funciona sin plugins adicionales en archivos TypeScript / JSX. Sin embargo, requiere que los siguientes plugins estén instalados para proyectos Vue y Svelte:
+
+- **`@intlayer/vue-transformer`**: Para archivos Vue.
+- **`@intlayer/svelte-transformer`**: Para archivos Svelte.

package/docs/es/cli/version.md

@@ -0,0 +1,24 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Comprobar la versión de la CLI
+description: Aprende cómo comprobar la versión instalada de la CLI de Intlayer.
+keywords:
+  - Versión
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - version
+---
+
+# Comprobar la versión de la CLI
+
+```bash
+npx intlayer --version
+npx intlayer version
+```
+
+Ambos comandos muestran la versión instalada de la CLI de Intlayer.

package/docs/es/cli/watch.md

@@ -0,0 +1,37 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Observar Diccionarios
+description: Aprende cómo observar cambios en tus archivos de declaración de contenido y construir diccionarios automáticamente.
+keywords:
+  - Observar
+  - Diccionarios
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - watch
+---
+
+# Observar Diccionarios
+
+```bash
+npx intlayer watch
+```
+
+Este comando observará los cambios en tus archivos de declaración de contenido y construirá los diccionarios en el directorio `.intlayer`.
+Este comando es el equivalente a `npx intlayer build --watch --skip-prepare`.
+
+## Alias:
+
+- `npx intlayer dictionaries watch`
+- `npx intlayer dictionary watch`
+- `npx intlayer dic watch`
+
+## Argumentos:
+
+- **`--with`**: Inicia un comando en paralelo con la observación.
+
+  > Ejemplo: `npx intlayer watch --with "next dev --turbopack"`

package/docs/es/packages/intlayer/getPrefix.md

@@ -0,0 +1,213 @@
+---
+createdAt: 2025-11-16
+updatedAt: 2025-11-16
+title: Documentación de la función getPrefix | intlayer
+description: Vea cómo usar la función getPrefix para el paquete intlayer
+keywords:
+  - getPrefix
+  - prefijo
+  - Intlayer
+  - intlayer
+  - Internacionalización
+  - Documentación
+  - Next.js
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getPrefix
+history:
+  - version: 7.1.0
+    date: 2025-11-16
+    changes: Documentación inicial
+---
+
+# Documentación: Función `getPrefix` en `intlayer`
+
+## Descripción
+
+La función `getPrefix` determina el prefijo de URL para un locale dado basado en la configuración del modo de enrutamiento. Compara el locale con el locale por defecto y devuelve un objeto que contiene tres formatos diferentes de prefijo para una construcción flexible de URLs.
+
+**Características clave:**
+
+- Toma un locale como primer parámetro (requerido)
+- Objeto `options` opcional con `defaultLocale` y `mode`
+- Devuelve un objeto con las propiedades `prefix` y `localePrefix`
+- Soporta todos los modos de enrutamiento: `prefix-no-default`, `prefix-all`, `no-prefix` y `search-params`
+- Utilidad ligera para determinar cuándo agregar prefijos de locale
+
+---
+
+## Firma de la función
+
+```typescript
+getPrefix(
+  locale: Locales,               // Requerido
+  options?: {                    // Opcional
+    defaultLocale?: Locales;
+    mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params';
+  }
+): GetPrefixResult
+
+type GetPrefixResult = {
+  prefix: string;   // p. ej., 'fr/' o ''
+  localePrefix?: Locale; // p. ej., 'fr' o undefined
+}
+```
+
+---
+
+## Parámetros
+
+- `locale: Locales`
+  - **Descripción**: El locale para el cual se generará el prefijo. Si el valor es falsy (undefined, null, cadena vacía), la función devuelve una cadena vacía.
+  - **Tipo**: `Locales`
+  - **Requerido**: Sí
+
+- `options?: object`
+  - **Descripción**: Objeto de configuración para la determinación del prefijo.
+  - **Tipo**: `object`
+  - **Requerido**: No (Opcional)
+
+  - `options.defaultLocale?: Locales`
+    - **Descripción**: El locale por defecto para la aplicación. Si no se proporciona, se usa el locale por defecto configurado en la configuración de tu proyecto.
+    - **Tipo**: `Locales`
+    - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#middleware)
+
+  - `options.mode?: 'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Descripción**: El modo de enrutamiento de URL para el manejo del locale. Si no se proporciona, usa el modo configurado en la configuración de tu proyecto.
+    - **Tipo**: `'prefix-no-default' | 'prefix-all' | 'no-prefix' | 'search-params'`
+    - **Por defecto**: [`Configuración del Proyecto`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/configuration.md#middleware)
+    - **Modos**:
+      - `prefix-no-default`: Devuelve cadenas vacías cuando el locale coincide con el locale por defecto
+      - `prefix-all`: Devuelve prefijo para todos los locales incluyendo el por defecto
+      - `no-prefix`: Devuelve cadenas vacías (sin prefijo en las URLs)
+      - `search-params`: Devuelve cadenas vacías (locale en parámetros de consulta)
+
+### Retorna
+
+- **Tipo**: `GetPrefixResult`
+- **Descripción**: Un objeto que contiene tres formatos diferentes de prefijo:
+  - `prefix`: El prefijo de la ruta con barra diagonal al final (por ejemplo, `'fr/'`, `''`)
+  - `localePrefix`: El identificador del locale sin barras diagonales (por ejemplo, `'fr'`, `undefined`)
+
+---
+
+## Ejemplo de Uso
+
+### Uso Básico
+
+```typescript codeFormat="typescript"
+import { getPrefix, Locales } from "intlayer";
+
+// Verificar prefijo para el locale inglés
+getPrefix(Locales.ENGLISH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-all",
+});
+// Devuelve: { prefix: 'en/', localePrefix: 'en' }
+
+// Verificar prefijo para el locale francés
+getPrefix(Locales.FRENCH, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+// Devuelve: { prefix: 'fr/', localePrefix: 'fr' }
+```
+
+```javascript codeFormat="esm"
+import { getPrefix, Locales } from "intlayer";
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Devuelve: { prefix: '', localePrefix: undefined }
+```
+
+```javascript codeFormat="commonjs"
+const { getPrefix, Locales } = require("intlayer");
+
+getPrefix(Locales.ENGLISH, { mode: "prefix-all" });
+// Devuelve: { prefix: '', localePrefix: undefined }
+```
+
+### Modos Diferentes de Enrutamiento
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// prefix-all: Siempre devuelve el prefijo
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-all",
+  defaultLocale: Locales.ENGLISH,
+});
+// Devuelve: { prefix: '/en', localePrefix: 'en' }
+
+// prefix-no-default: No hay prefijo cuando el locale coincide con el predeterminado
+getPrefix(Locales.ENGLISH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Devuelve: { prefix: '', localePrefix: undefined }
+
+// prefix-no-default: Devuelve el prefijo cuando el locale difiere del predeterminado
+getPrefix(Locales.FRENCH, {
+  mode: "prefix-no-default",
+  defaultLocale: Locales.ENGLISH,
+});
+// Devuelve: { prefix: 'fr/', localePrefix: 'fr' }
+
+// no-prefix & search-params: Nunca devuelve prefijo
+getPrefix(Locales.ENGLISH, { mode: "no-prefix" });
+// Devuelve: { prefix: '', localePrefix: undefined }
+
+getPrefix(Locales.ENGLISH, { mode: "search-params" });
+// Devuelve: { prefix: '', localePrefix: undefined }
+```
+
+### Ejemplo Práctico
+
+```typescript
+import { getPrefix, Locales } from "intlayer";
+
+// Construir URLs con el prefijo apropiado para un locale específico
+const locale = Locales.FRENCH;
+const { prefix, localePrefix } = getPrefix(locale, {
+  defaultLocale: Locales.ENGLISH,
+  mode: "prefix-no-default",
+});
+
+// Usando prefix para la construcción de rutas
+const url1 = `/${prefix}about`.replace(/\/+/g, "/");
+// Resultado: "/fr/about"
+
+// Usando localePrefix para la identificación del locale
+console.log(`Current locale: ${localePrefix}`);
+// Salida: "Current locale: fr"
+```
+
+---
+
+## Funciones Relacionadas
+
+- [`getLocalizedUrl`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/packages/intlayer/getLocalizedUrl.md): Genera una URL localizada para un locale específico
+- [`getMultilingualUrls`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/packages/intlayer/getMultilingualUrls.md): Genera URLs para todos los locales configurados
+
+---
+
+## TypeScript
+
+```typescript
+type GetPrefixResult = {
+  prefix: string; // El prefijo de la ruta con barra final (ej., 'fr/' o '')
+  localePrefix?: Locale; // El identificador de locale sin barras (por ejemplo, 'fr' o indefinido)
+};
+
+function getPrefix(
+  locale: Locales,
+  options?: {
+    defaultLocale?: Locales;
+    mode?: "prefix-no-default" | "prefix-all" | "no-prefix" | "search-params";
+  }
+): GetPrefixResult;
+```

package/docs/fr/cli/build.md

@@ -0,0 +1,64 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Construire des Dictionnaires
+description: Apprenez à construire vos dictionnaires Intlayer à partir des fichiers de déclaration de contenu.
+keywords:
+  - Construire
+  - Dictionnaires
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - build
+---
+
+# Construire des Dictionnaires
+
+Pour construire vos dictionnaires, vous pouvez exécuter les commandes :
+
+```bash
+npx intlayer build
+```
+
+ou en mode surveillance
+
+```bash
+npx intlayer build --watch
+```
+
+Cette commande trouvera par défaut vos fichiers de déclaration de contenu sous la forme `./src/**/*.content.{ts|js|mjs|cjs|json|tsx|jsx}`. Et construira les dictionnaires dans le répertoire `.intlayer`.
+
+## Alias :
+
+- `npx intlayer dictionaries build`
+- `npx intlayer dictionary build`
+- `npx intlayer dic build`
+
+## Arguments :
+
+- **`--base-dir`** : Spécifiez le répertoire de base pour le projet. Pour récupérer la configuration intlayer, la commande cherchera le fichier `intlayer.config.{ts,js,json,cjs,mjs}` dans le répertoire de base.
+
+  > Exemple : `npx intlayer build --base-dir ./src`
+
+- **`--env`** : Spécifiez l'environnement (par exemple, `development`, `production`). Utile dans le cas où vous utilisez des variables d'environnement dans votre fichier de configuration intlayer.
+
+  > Exemple : `npx intlayer build --env production`
+
+- **`--env-file`** : Fournissez un fichier d'environnement personnalisé pour charger les variables. Utile dans le cas où vous utilisez des variables d'environnement dans votre fichier de configuration intlayer.
+
+  > Exemple : `npx intlayer build --env-file .env.production.local`
+
+- **`--with`** : Démarrer une commande en parallèle avec la construction.
+
+  > Exemple : `npx intlayer build --with "next dev --turbopack"`
+
+- **`--skip-prepare`** : Ignorer l'étape de préparation.
+
+  > Exemple : `npx intlayer build --skip-prepare`
+
+- **`--no-cache`** : Désactiver le cache.
+
+  > Exemple : `npx intlayer build --no-cache`

package/docs/fr/cli/configuration.md

@@ -0,0 +1,63 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Gérer la Configuration
+description: Apprenez à récupérer et pousser votre configuration Intlayer vers le CMS.
+keywords:
+  - Configuration
+  - Config
+  - CLI
+  - Intlayer
+  - CMS
+slugs:
+  - doc
+  - concept
+  - cli
+  - configuration
+---
+
+# Gérer la Configuration
+
+## Récupérer la Configuration
+
+La commande `configuration get` récupère la configuration actuelle pour Intlayer, en particulier les paramètres de locale. Ceci est utile pour vérifier votre configuration.
+
+```bash
+npx intlayer configuration get
+```
+
+## Alias :
+
+- `npx intlayer config get`
+- `npx intlayer conf get`
+
+## Arguments :
+
+- **`--env`** : Spécifie l'environnement (par exemple, `development`, `production`).
+- **`--env-file`** : Fournit un fichier d'environnement personnalisé pour charger les variables.
+- **`--base-dir`** : Spécifie le répertoire de base pour le projet.
+- **`--verbose`** : Active la journalisation détaillée pour le débogage. (par défaut à true via la CLI)
+- **`--no-cache`** : Désactive le cache.
+
+## Pousser la Configuration
+
+La commande `configuration push` télécharge votre configuration vers le CMS et l'éditeur Intlayer. Cette étape est nécessaire pour permettre l'utilisation des dictionnaires distants dans l'éditeur visuel Intlayer.
+
+```bash
+npx intlayer configuration push
+```
+
+## Alias :
+
+- `npx intlayer config push`
+- `npx intlayer conf push`
+
+## Arguments :
+
+- **`--env`** : Spécifie l'environnement (par exemple, `development`, `production`).
+- **`--env-file`** : Fournit un fichier d'environnement personnalisé pour charger les variables.
+- **`--base-dir`** : Spécifie le répertoire de base pour le projet.
+- **`--verbose`** : Active la journalisation détaillée pour le débogage. (par défaut à true via la CLI)
+- **`--no-cache`** : Désactive le cache.
+
+En poussant la configuration, votre projet est entièrement intégré au CMS Intlayer, permettant une gestion fluide des dictionnaires entre les équipes.

package/docs/fr/cli/debug.md

@@ -0,0 +1,46 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Déboguer la commande Intlayer
+description: Apprenez à déboguer et résoudre les problèmes de la CLI Intlayer.
+keywords:
+  - Déboguer
+  - Résoudre les problèmes
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - debug
+---
+
+# Déboguer la commande intlayer
+
+## 1. **Assurez-vous d'utiliser la dernière version**
+
+Exécutez :
+
+```bash
+npx intlayer --version                  # version locale actuelle d'intlayer
+npx intlayer@latest --version           # dernière version disponible d'intlayer
+```
+
+## 2. **Vérifiez si la commande est enregistrée**
+
+Vous pouvez vérifier avec :
+
+```bash
+npx intlayer --help                     # Affiche la liste des commandes disponibles et les informations d'utilisation
+npx intlayer dictionary build --help    # Affiche la liste des options disponibles pour une commande
+```
+
+## 3. **Redémarrez votre terminal**
+
+Parfois, un redémarrage du terminal est nécessaire pour reconnaître les nouvelles commandes.
+
+## 4. **Videz le cache de npx (si vous êtes bloqué avec une version plus ancienne)**
+
+```bash
+npx clear-npx-cache
+```

package/docs/fr/cli/doc-review.md

@@ -0,0 +1,43 @@
+---
+createdAt: 2024-08-11
+updatedAt: 2025-11-22
+title: Revue de Document
+description: Apprenez comment revoir les fichiers de documentation pour la qualité, la cohérence et l'exhaustivité à travers différentes locales.
+keywords:
+  - Revue
+  - Document
+  - Documentation
+  - IA
+  - CLI
+  - Intlayer
+slugs:
+  - doc
+  - concept
+  - cli
+  - doc-review
+---
+
+# Revue de Document
+
+La commande `doc review` analyse les fichiers de documentation pour la qualité, la cohérence et l'exhaustivité à travers différentes locales.
+
+```bash
+npx intlayer doc review
+```
+
+Elle peut être utilisée pour revoir les fichiers déjà traduits, et pour vérifier si la traduction est correcte.
+
+Pour la plupart des cas d'utilisation,
+
+- préférez utiliser `doc translate` lorsque la version traduite de ce fichier n'est pas disponible.
+- préférez utiliser `doc review` lorsque la version traduite de ce fichier existe déjà.
+
+> Notez que le processus de revue consomme plus de tokens d'entrée que le processus de traduction pour revoir entièrement le même fichier. Cependant, le processus de revue optimisera les chunks à revoir, et sautera les parties qui n'ont pas été modifiées.
+
+## Arguments :
+
+La commande `doc review` accepte les mêmes arguments que `doc translate`, vous permettant de revoir des fichiers de documentation spécifiques et d'appliquer des contrôles de qualité.
+
+Si vous avez activé l'une des options git, la commande ne passera en revue que la partie des fichiers qui est modifiée. Le script traitera le fichier par découpage en chunks et examinera chaque chunk. S'il n'y a pas de modifications dans le chunk, le script le sautera pour accélérer le processus de revue et limiter le coût de l'API du fournisseur d'IA.
+
+Pour une liste complète des arguments, consultez la documentation de la commande [Translate Document](https://github.com/aymericzip/intlayer/blob/main/docs/docs/fr/cli/doc-translate.md).