@intlayer/docs 7.0.6 → 7.0.8-canary.0

package/docs/es/intlayer_with_next-intl.md

@@ -0,0 +1,446 @@
+---
+createdAt: 2025-10-05
+updatedAt: 2025-10-05
+title: Cómo traducir tu Next.js 15 usando next-intl – guía i18n 2025
+description: Descubre cómo hacer tu sitio web Next.js 15 App Router multilingüe. Sigue la documentación para internacionalizar (i18n) y traducirlo.
+keywords:
+  - Internacionalización
+  - Documentación
+  - Intlayer
+  - Next.js 15
+  - next-intl
+  - JavaScript
+  - React
+slugs:
+  - doc
+  - next-intl
+applicationTemplate: https://github.com/aymericzip/intlayer-next-intl-template
+---
+
+# Traduce tu sitio web Next.js 15 usando next-intl con Intlayer | Internacionalización (i18n)
+
+Esta guía te lleva a través de las mejores prácticas de next-intl en una aplicación Next.js 15 (App Router), y muestra cómo superponer Intlayer para una gestión y automatización robusta de traducciones.
+
+Consulta la comparación en [next-i18next vs next-intl vs Intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/blog/es/next-i18next_vs_next-intl_vs_intlayer.md).
+
+- Para juniors: sigue las secciones paso a paso para obtener una aplicación multilingüe funcional.
+- Para desarrolladores de nivel medio: presta atención a la optimización del payload y la separación servidor/cliente.
+- Para seniors: ten en cuenta la generación estática, middleware, integración SEO y hooks de automatización.
+
+Lo que cubriremos:
+
+- Configuración y estructura de archivos
+- Optimización de la carga de mensajes
+- Uso de componentes cliente y servidor
+- Metadatos, sitemap, robots para SEO
+- Middleware para enrutamiento por locale
+- Añadir Intlayer encima (CLI y automatización)
+
+## Configura tu aplicación usando next-intl
+
+Instala las dependencias de next-intl -
+
+```bash packageManager="npm"
+npm install next-intl
+```
+
+```bash packageManager="pnpm"
+pnpm add next-intl
+```
+
+```bash packageManager="yarn"
+yarn add next-intl
+```
+
+```bash
+.
+├── locales
+│   ├── en
+│   │  ├── common.json
+│   │  └── about.json
+│   ├── fr
+│   │  ├── common.json
+│   │  └── about.json
+│   └── es
+│      ├── common.json
+│      └── about.json
+└── src
+    ├── i18n.ts
+    ├── middleware.ts
+    ├── app
+    │   └── [locale]
+    │       ├── layout.tsx
+    │       └── about
+    │           └── page.tsx
+    └── components
+        ├── ClientComponentExample.tsx
+        └── ServerComponent.tsx
+```
+
+#### Configuración y carga de contenido
+
+Carga solo los namespaces que tus rutas necesitan y valida los locales desde el principio. Mantén los componentes del servidor síncronos cuando sea posible y envía solo los mensajes requeridos al cliente.
+
+```tsx fileName="src/i18n.ts"
+import { getRequestConfig } from "next-intl/server";
+import { notFound } from "next/navigation";
+
+export const locales = ["en", "fr", "es"] as const;
+export const defaultLocale = "en" as const;
+
+async function loadMessages(locale: string) {
+  // Carga solo los namespaces que tu layout/páginas necesitan
+  const [common, about] = await Promise.all([
+    import(`../locales/${locale}/common.json`).then((m) => m.default),
+    import(`../locales/${locale}/about.json`).then((m) => m.default),
+  ]);
+
+  return { common, about } as const;
+}
+
+export default getRequestConfig(async ({ locale }) => {
+  if (!locales.includes(locale as any)) notFound();
+
+  return {
+    messages: await loadMessages(locale),
+  };
+});
+```
+
+```tsx fileName="src/app/[locale]/layout.tsx"
+import type { ReactNode } from "react";
+import { locales } from "@/i18n";
+import {
+  getLocaleDirection,
+  unstable_setRequestLocale,
+} from "next-intl/server";
+
+export const dynamic = "force-static";
+
+export function generateStaticParams() {
+  return locales.map((locale) => ({ locale }));
+}
+
+export default async function LocaleLayout({
+  children,
+  params,
+}: {
+  children: ReactNode;
+  params: { locale: string };
+}) {
+  const { locale } = params;
+
+  // Establece la locale activa para esta renderización del servidor (RSC)
+  unstable_setRequestLocale(locale);
+
+  const dir = getLocaleDirection(locale);
+
+  return (
+    <html lang={locale} dir={dir}>
+      <body>{children}</body>
+    </html>
+  );
+}
+```
+
+```tsx fileName="src/app/[locale]/about/page.tsx"
+import { getTranslations, getMessages, getFormatter } from "next-intl/server";
+import { NextIntlClientProvider } from "next-intl";
+import pick from "lodash/pick";
+import ServerComponent from "@/components/ServerComponent";
+import ClientComponentExample from "@/components/ClientComponentExample";
+
+export const dynamic = "force-static";
+
+export default async function AboutPage({
+  params,
+}: {
+  params: { locale: string };
+}) {
+  const { locale } = params;
+
+  // Los mensajes se cargan del lado del servidor. Solo se envía al cliente lo necesario.
+  const messages = await getMessages();
+  const clientMessages = pick(messages, ["common", "about"]);
+
+  // Traducciones/formateo estrictamente del lado del servidor
+  const tAbout = await getTranslations("about");
+  const tCounter = await getTranslations("about.counter");
+  const format = await getFormatter();
+
+  const initialFormattedCount = format.number(0);
+
+  return (
+    <NextIntlClientProvider locale={locale} messages={clientMessages}>
+      <main>
+        <h1>{tAbout("title")}</h1>
+        <ClientComponentExample />
+        <ServerComponent
+          formattedCount={initialFormattedCount}
+          label={tCounter("label")}
+          increment={tCounter("increment")}
+        />
+      </main>
+    </NextIntlClientProvider>
+  );
+}
+```
+
+### Uso en un componente cliente
+
+Tomemos un ejemplo de un componente cliente que renderiza un contador.
+
+**Traducciones (misma estructura; cárgalas en los mensajes de next-intl como prefieras)**
+
+```json fileName="locales/en/about.json"
+{
+  "counter": {
+    "label": "Contador",
+    "increment": "Incrementar"
+  }
+}
+```
+
+```json fileName="locales/fr/about.json"
+{
+  "counter": {
+    "label": "Contador",
+    "increment": "Incrementar"
+  }
+}
+```
+
+**Componente cliente**
+
+```tsx fileName="src/components/ClientComponentExample.tsx"
+"use client";
+
+import React, { useState } from "react";
+import { useTranslations, useFormatter } from "next-intl";
+
+const ClientComponentExample = () => {
+  // Enfocar directamente al objeto anidado
+  const t = useTranslations("about.counter");
+  const format = useFormatter();
+  const [count, setCount] = useState(0);
+
+  return (
+    <div>
+      <p>{format.number(count)}</p>
+      <button
+        aria-label={t("label")}
+        onClick={() => setCount((count) => count + 1)}
+      >
+        {t("increment")}
+      </button>
+    </div>
+  );
+};
+```
+
+> No olvides añadir el mensaje "about" en el mensaje cliente de la página
+> (solo incluya los namespaces que su cliente realmente necesite).
+
+### Uso en un componente servidor
+
+Este componente UI es un componente servidor y puede ser renderizado dentro de un componente cliente (página → cliente → servidor). Manténgalo síncrono pasando cadenas precomputadas.
+
+```tsx fileName="src/components/ServerComponent.tsx"
+type ServerComponentProps = {
+  formattedCount: string;
+  label: string;
+  increment: string;
+};
+
+const ServerComponent = ({
+  formattedCount,
+  label,
+  increment,
+}: ServerComponentProps) => {
+  return (
+    <div>
+      <p>{formattedCount}</p>
+      <button aria-label={label}>{increment}</button>
+    </div>
+  );
+};
+```
+
+Notas:
+
+- Calcule `formattedCount` del lado del servidor (por ejemplo, `const initialFormattedCount = format.number(0)`).
+- Evite pasar funciones u objetos no serializables a los componentes servidor.
+
+```tsx fileName="src/app/[locale]/about/layout.tsx"
+import type { Metadata } from "next";
+import { locales, defaultLocale } from "@/i18n";
+import { getTranslations } from "next-intl/server";
+
+function localizedPath(locale: string, path: string) {
+  return locale === defaultLocale ? path : "/" + locale + path;
+}
+
+export async function generateMetadata({
+  params,
+}: {
+  params: { locale: string };
+}): Promise<Metadata> {
+  const { locale } = params;
+  const t = await getTranslations({ locale, namespace: "about" });
+
+  const url = "/about";
+  const languages = Object.fromEntries(
+    locales.map((locale) => [locale, localizedPath(locale, url)])
+  );
+
+  return {
+    title: t("title"),
+    description: t("description"),
+    alternates: {
+      canonical: localizedPath(locale, url),
+      languages: { ...languages, "x-default": url },
+    },
+  };
+}
+
+// ... Resto del código de la página
+```
+
+```tsx fileName="src/app/sitemap.ts"
+import type { MetadataRoute } from "next";
+import { locales, defaultLocale } from "@/i18n";
+
+const origin = "https://example.com";
+
+const formatterLocalizedPath = (locale: string, path: string) =>
+  locale === defaultLocale ? origin + path : origin + "/" + locale + path;
+
+export default function sitemap(): MetadataRoute.Sitemap {
+  const aboutLanguages = Object.fromEntries(
+    locales.map((l) => [l, formatterLocalizedPath(l, "/about")])
+  );
+
+  return [
+    {
+      url: formatterLocalizedPath(defaultLocale, "/about"),
+      lastModified: new Date(),
+      changeFrequency: "monthly",
+      priority: 0.7,
+      alternates: { languages: aboutLanguages },
+    },
+  ];
+}
+```
+
+```tsx fileName="src/app/robots.ts"
+import type { MetadataRoute } from "next";
+import { locales, defaultLocale } from "@/i18n";
+
+const origin = "https://example.com";
+const withAllLocales = (path: string) => [
+  path,
+  ...locales
+    .filter((locale) => locale !== defaultLocale)
+    .map((locale) => "/" + locale + path),
+];
+
+export default function robots(): MetadataRoute.Robots {
+  const disallow = [
+    ...withAllLocales("/dashboard"),
+    ...withAllLocales("/admin"),
+  ];
+
+  return {
+    rules: { userAgent: "*", allow: ["/"], disallow },
+    host: origin,
+    sitemap: origin + "/sitemap.xml",
+  };
+}
+```
+
+### Middleware para el enrutamiento de locales
+
+Agrega un middleware para manejar la detección y el enrutamiento de locales:
+
+```ts fileName="src/middleware.ts"
+import createMiddleware from "next-intl/middleware";
+import { locales, defaultLocale } from "@/i18n";
+
+export default createMiddleware({
+  locales: [...locales],
+  defaultLocale,
+  localeDetection: true,
+});
+
+export const config = {
+  // Omitir API, internals de Next y assets estáticos
+  matcher: ["/((?!api|_next|.*\\..*).*)"],
+};
+```
+
+### Mejores prácticas
+
+- **Configurar html `lang` y `dir`**: En `src/app/[locale]/layout.tsx`, calcula `dir` mediante `getLocaleDirection(locale)` y establece `<html lang={locale} dir={dir}>`.
+- **Dividir mensajes por namespace**: Organiza JSON por locale y namespace (por ejemplo, `common.json`, `about.json`).
+- **Minimiza la carga en el cliente**: En las páginas, envía solo los namespaces requeridos a `NextIntlClientProvider` (por ejemplo, `pick(messages, ['common', 'about'])`).
+- **Prefiere páginas estáticas**: Exporta `export const dynamic = 'force-static'` y genera parámetros estáticos para todos los `locales`.
+- **Componentes de servidor síncronos**: Pasa cadenas precomputadas (etiquetas traducidas, números formateados) en lugar de llamadas asíncronas o funciones no serializables.
+
+## Implementar Intlayer sobre next-intl
+
+Instala las dependencias de intlayer:
+
+```bash packageManager="npm"
+npm install intlayer @intlayer/sync-json-plugin  -D
+```
+
+```bash packageManager="yarn"
+yarn add intlayer @intlayer/sync-json-plugin  -D
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer @intlayer/sync-json-plugin  -D
+```
+
+Crea el archivo de configuración de intlayer:
+
+```tsx fileName="intlayer.config.ts"
+import { type IntlayerConfig, Locales } from "intlayer";
+import { syncJSON } from "@intlayer/sync-json-plugin";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+  ai: {
+    apiKey: process.env.OPENAI_API_KEY,
+  },
+  plugins: [
+    // Mantén la estructura de carpetas por namespace sincronizada con Intlayer
+    syncJSON({
+      source: ({ key, locale }) => `./locales/${locale}/${key}.json`,
+    }),
+  ],
+};
+
+export default config;
+```
+
+Agrega los scripts en `package.json`:
+
+```json fileName="package.json"
+{
+  "scripts": {
+    "i18n:fill": "intlayer fill",
+    "i18n:test": "intlayer test"
+  }
+}
+```
+
+Notas:
+
+- `intlayer fill`: utiliza tu proveedor de IA para completar las traducciones faltantes basándose en los locales configurados.
+- `intlayer test`: verifica traducciones faltantes o inválidas (úsalo en CI).
+
+Puedes configurar argumentos y proveedores; consulta [Intlayer CLI](https://github.com/aymericzip/intlayer/blob/main/docs/docs/es/intlayer_cli.md).

package/docs/es/intlayer_with_nextjs_16.md

@@ -24,10 +24,31 @@ history:
 
 # Traduce tu sitio web Next.js 16 usando Intlayer | Internacionalización (i18n)
 
+<Tab defaultTab="video">
+  <TabItem label="Video" value="video">
+  
 <iframe title="¿La mejor solución i18n para Next.js? Descubre Intlayer" class="m-auto aspect-[16/9] w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/e_PPG7PTqGU?autoplay=0&amp;origin=http://intlayer.org&amp;controls=0&amp;rel=1"/>
 
+  </TabItem>
+  <TabItem label="Code" value="code">
+
+<iframe
+  src="https://stackblitz.com/github/aymericzip/intlayer-next-16-template?embed=1&ctl=1&file=intlayer.config.ts"
+  className="m-auto overflow-hidden rounded-lg border-0 max-md:size-full max-md:h-[700px] md:aspect-16/9 md:w-full"
+  title="Demo CodeSandbox - How to Internationalize your application using Intlayer"
+  sandbox="allow-forms allow-modals allow-popups allow-presentation allow-same-origin allow-scripts"
+  loading="lazy"
+/>
+
+  </TabItem>
+</Tab>
+
 Consulta la [Plantilla de Aplicación](https://github.com/aymericzip/intlayer-next-16-template) en GitHub.
 
+## Tabla de Contenidos
+
+<TOC/>
+
 ## ¿Qué es Intlayer?
 
 **Intlayer** es una biblioteca innovadora y de código abierto para la internacionalización (i18n) diseñada para simplificar el soporte multilingüe en aplicaciones web modernas. Intlayer se integra perfectamente con el último framework **Next.js 16**, incluyendo su potente **App Router**. Está optimizado para trabajar con **Componentes del Servidor** para un renderizado eficiente y es totalmente compatible con [**Turbopack**](https://nextjs.org/docs/architecture/turbopack).

package/docs/es/intlayer_with_tanstack.md

@@ -25,6 +25,10 @@ history:
 
 # Traduce tu Tanstack Start con Intlayer | Internacionalización (i18n)
 
+## Tabla de contenido
+
+<TOC/>
+
 Esta guía demuestra cómo integrar **Intlayer** para una internacionalización fluida en proyectos Tanstack Start con enrutamiento consciente de la configuración regional, soporte para TypeScript y prácticas modernas de desarrollo.
 
 ## ¿Qué es Intlayer?

package/docs/es/intlayer_with_vite+react.md

@@ -25,6 +25,10 @@ history:
 
 # Comenzando con la internacionalización (i18n) usando Intlayer en Vite y React
 
+## Tabla de contenido
+
+<TOC/>
+
 <iframe title="The best i18n solution for Vite and React? Discover Intlayer" class="m-auto aspect-[16/9] w-full overflow-hidden rounded-lg border-0" allow="autoplay; gyroscope;" loading="lazy" width="1080" height="auto" src="https://www.youtube.com/embed/dS9L7uJeak4?si=VaKmrYMmXjo3xpk2"/>
 
 Consulta la [Plantilla de Aplicación](https://github.com/aymericzip/intlayer-vite-react-template) en GitHub.

package/docs/fr/configuration.md

@@ -42,6 +42,12 @@ Les fichiers de configuration d'Intlayer permettent de personnaliser divers aspe
 
 ---
 
+## Table des matières
+
+<TOC/>
+
+---
+
 ## Formats de fichiers de configuration supportés
 
 Intlayer accepte les formats de fichiers de configuration JSON, JS, MJS et TS :

package/docs/fr/intlayer_cli.md

@@ -27,6 +27,14 @@ history:
 
 # CLI Intlayer
 
+---
+
+## Table des matières
+
+<TOC/>
+
+---
+
 ## Installer le paquet
 
 Installez les paquets nécessaires en utilisant npm :
@@ -372,7 +380,6 @@ npx intlayer doc translate
   > Exemple : `npx intlayer doc translate --excluded-glob-pattern "docs/internal/**"`
 
 - **`--skip-if-modified-before [skipIfModifiedBefore]`** : Ignorer le fichier s'il a été modifié avant l'heure donnée.
-
   - Peut être une heure absolue comme "2025-12-05" (chaîne ou Date)
   - Peut être une durée relative en ms `1 * 60 * 60 * 1000` (1 heure)
   - Cette option vérifie la date de mise à jour du fichier en utilisant la méthode `fs.stat`. Elle peut donc être impactée par Git ou d'autres outils qui modifient le fichier.
@@ -380,7 +387,6 @@ npx intlayer doc translate
   > Exemple : `npx intlayer doc translate --skip-if-modified-before "2025-12-05"`
 
 - **`--skip-if-modified-after [skipIfModifiedAfter]`** : Ignorer le fichier s'il a été modifié dans le délai donné.
-
   - Peut être une date absolue comme "2025-12-05" (chaîne ou Date)
   - Peut être un temps relatif en ms `1 * 60 * 60 * 1000` (1 heure)
   - Cette option vérifie la date de mise à jour du fichier en utilisant la méthode `fs.stat`. Elle peut donc être impactée par Git ou d'autres outils qui modifient le fichier.
@@ -431,7 +437,6 @@ npx intlayer doc translate
 **Options des instructions personnalisées :**
 
 - **`--custom-instructions [customInstructions]`** : Instructions personnalisées ajoutées au prompt. Utile pour appliquer des règles spécifiques concernant le formatage, la traduction des URLs, etc.
-
   - Peut être une date absolue comme "2025-12-05" (chaîne ou Date)
   - Peut être un temps relatif en ms `1 * 60 * 60 * 1000` (1 heure)
   - Cette option vérifie la date de mise à jour du fichier en utilisant la méthode `fs.stat`. Elle peut donc être impactée par Git ou d'autres outils qui modifient le fichier.