Configuración

Descripción general

El archivo gt.config.json se utiliza para configurar los ajustes de GT de tu proyecto. Debe colocarse en la raíz de tu proyecto.

El comando CLI npx gtx-cli init creará un archivo gt.config.json para ti en tu proyecto.

Configuración

El archivo gt.config.json contiene los siguientes ajustes:

• defaultLocale: El idioma predeterminado para tu proyecto. Este es el idioma en el que está escrito tu contenido original. También es el idioma de respaldo para tu proyecto (si usas gt-next o gt-react).

• locales: Un array de idiomas para tu proyecto. Estos son los idiomas a los que quieres traducir tu proyecto. Consulta los idiomas soportados para más información. Si estás usando gt-next o gt-react, estos son también los idiomas que tu aplicación soporta.

• files: Este es un objeto que contiene información sobre el contenido que quieres traducir.

Aquí hay un esqueleto del archivo gt.config.json:

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "..."
    },
    "json": {
      "include": [...]
    },
    "mdx": {
      "include": [...]
    },
    "md": {
      "include": [...]
    }
  }
}

Configuración de ejemplo

Analicemos un archivo gt.config.json de ejemplo:

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/i18n/[locale].json"
    },
    "mdx": {
      "include": ["content/docs/[locale]/**/*.mdx"],
      "transform": "*.[locale].mdx"
    },
    "json": {
      "include": ["resources/[locale]/**/*.json"],
      "exclude": ["resources/[locale]/exclude/**/*.json"]
    }
  }
}

En este ejemplo, estamos traduciendo los siguientes archivos con una sola llamada a gtx-cli translate:

• Todos los archivos MDX en el directorio content/docs/en.
• Todos los archivos JSON en el directorio resources/en (excluyendo cualquier archivo en el directorio resources/en/exclude).
• Todos los componentes en línea <T> en tu proyecto de React o Next.js.
• Tu archivo dictionary.[json|js|ts].

GT: Las traducciones se guardarán en public/i18n/es.json y public/i18n/fr.json. Estos archivos pueden cargarse usando loadTranslations().

MDX: Las traducciones se guardarán en los directorios content/docs/fr y content/docs/es. Las extensiones de archivo se cambiarán a .fr.mdx y .es.mdx respectivamente (desde .mdx).

JSON: Las traducciones se guardarán en los directorios resources/fr y resources/es.

Tipos de archivos compatibles

files debe contener una clave para cada tipo de archivo que deseas traducir. Puedes configurar tu proyecto para mezclar y combinar diferentes tipos de archivos, y hacer que todos sean traducidos. Actualmente admitimos los siguientes tipos de archivos:

• gt: Archivos de Traducción General.
• json: Archivos JSON.
• mdx: Archivos de componentes Markdown (MDX).
• md: Archivos Markdown (MD).

Cada tipo de archivo debe corresponder a un objeto que contiene una o más de las siguientes claves:

• include
• exclude
• transform
• output

include

Si se utiliza, el valor de la clave include debe ser un array de patrones glob que coincidan con los archivos que deseas traducir.

Debes usar el marcador de posición [locale] en tus patrones glob para asegurar que se utilice el idioma correcto. La herramienta CLI reemplazará el marcador de posición [locale] con el valor de defaultLocale al buscar archivos traducibles.

La herramienta CLI guardará los archivos traducidos en la ruta correspondiente, con el marcador de posición [locale] reemplazado por el código del idioma.

{
  "include": ["docs/[locale]/**/*.json"]
}

exclude

Si se utiliza, el valor de la clave exclude debe ser un array de patrones glob que coincidan con los archivos que deseas excluir de la traducción.

El patrón es el mismo que el patrón de include.

{
  "exclude": ["docs/[locale]/exclude/**/*.json"]
}

transform

Si se utiliza, el valor de la clave transform debe ser una cadena que defina una reasignación del nombre del archivo. Debe contener un comodín * que será reemplazado por el nombre original del archivo (cualquier cosa antes del primer .).

Por ejemplo, si deseas que la extensión de todos tus archivos traducidos tenga .[locale].json en lugar de .json, puedes usar la siguiente configuración:

{
  "transform": "*.[locale].json"
}

output

Esta clave se utiliza exclusivamente para archivos de Traducción General, específicamente para guardar traducciones localmente. Si estás utilizando el CDN de GT, esta clave no es necesaria.

El valor debe ser una cadena que contenga un marcador de posición [locale] que indique la ubicación donde se guardarán las traducciones.

Por ejemplo, si deseas guardar tus traducciones al español en un archivo llamado ui.es.json en el directorio public/i18n, deberías usar la siguiente cadena:

{
  "output": "public/i18n/[locale].json"
}

Tipo de archivo: gt

Claves admitidas

• output (Obligatorio)

Ejemplo

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "gt": {
      "output": "public/i18n/[locale].json"
    },
  }
}

Esta configuración hará que la herramienta CLI guarde tus traducciones en francés y español en el directorio public/i18n/[locale].json.

Por defecto, la herramienta CLI no publicará tus traducciones en el CDN de GT con esta configuración.

Tipo de archivo: json

Claves admitidas

• include (Obligatorio)
• exclude (Opcional)
• transform (Opcional)

Ejemplo

{
  "defaultLocale": "en",
  "locales": ["fr", "es"],
  "files": {
    "json": {
      "include": ["json_files/[locale]/**/*.json"],
      "exclude": ["json_files/[locale]/exclude/**/*.json"]
    }
  }
}

Supongamos que el idioma predeterminado de tu proyecto es en, y quieres traducir tu proyecto a fr y es.

Con esta configuración, la CLI buscará todos los archivos JSON en el subdirectorio json_files/en/ y guardará los archivos traducidos en json_files/fr/ y json_files/es/.

Ignorará cualquier archivo en el subdirectorio json_files/en/exclude/.

Tipo de archivo: mdx

Claves admitidas

• include (Obligatorio)
• exclude (Opcional)
• transform (Opcional)

Ejemplo

{
  "defaultLocale": "en",
  "locales": ["ja"],
  "files": {
    "mdx": {
      "include": ["content/docs/[locale]/**/*.mdx"],
      "transform": "*.[locale].mdx"
    }
  }
}

Esta configuración le indicará a la herramienta CLI que busque todos los archivos MDX en el directorio content/docs/en y guarde los archivos traducidos en el directorio content/docs/ja.

La clave transform hace que la extensión de los archivos traducidos se cambie a .ja.mdx.

Tipo de archivo: md

Claves admitidas

• include (Obligatorio)
• exclude (Opcional)
• transform (Opcional)

Ejemplo

{
  "defaultLocale": "en",
  "locales": ["ja"],
  "files": {
    "md": {
      "include": ["content/docs/[locale]/**/*.md"],
      "exclude": ["content/docs/[locale]/exclude/**/*.md"],
      "transform": "*.[locale].md"
    }
  }
}

Esta configuración le indicará a la herramienta CLI que busque todos los archivos MD en el directorio content/docs/en y guarde los archivos traducidos en el directorio content/docs/ja.

La clave transform hace que la extensión de los archivos traducidos se cambie a .ja.md.

Todos los archivos en el directorio content/docs/en/exclude serán ignorados.

Siguientes pasos

Aprende cómo usar el comando init para generar este archivo de configuración.