Cómo crear un archivo de configuración CLI (Strings)

El contenido se traduce automáticamente del inglés por Phrase Language AI.

Requisitos previos

identificador único (token) de acceder con read write scope
ID del proyecto de Strings que se muestra en la pestaña API de la configuración del proyecto
Conocimientos básicos de YAML, incluida la sangría
Permisos de lectura y escritura de Git si el repositorio ejecutará phrase push o phrase pull en CI

Consejo

Para obtener información más detallada, consulta el Developer Hub.

Para crear automáticamente un archivo de configuración, sigue estos pasos:

En la línea de comandos, escribe phrase init para crear un archivo .phrase.yml.

El asistente de configuración comienza en la CLI.
Introduce:
- Token de acceso
  
  Pega o presiona Enter para permitir que se use $PHRASE_ACCESS_TOKEN
- ID del proyecto de Strings (p. ej., abcdef1234567890abcdef1234567890)
- formato de localización (p. ej., json, rails_yaml, ios_strings)
- Ruta local
  
  Glob o ruta exacta a los archivos de localización en el código fuente del proyecto (p. ej., config/locales/*.json)

Se crea un archivo .phrase.yml básico en el directorio actual.

Consejo

Proporciona flags para omitir el asistente por completo, por ejemplo phrase init --access_token=$PHRASE_ACCESS_TOKEN --project_id=... --file_format=ios_strings --path='ios/*.strings'.

Si utilizas un archivo de configuración creado o copiado manualmente, colócalo en una de las siguientes ubicaciones:

El directorio de trabajo actual (pwd) en el que se llama al cliente de la CLI.
El directorio de inicio del usuario actual ($HOME en Unix, $HomePath en Windows).
La ruta especificada en la variable de entorno PHRASEAPP_CONFIG.
La ruta al archivo de configuración a través de la etiqueta --config (p. ej., /some/path/to/phrase.yml).

Descripción general de las opciones de la CLI

Archivo de configuración de muestra.

configuración global

Clave	Tipo	Requerido	Descripción
`phrase.access_token`	cadena	Sí	identificador único (token) de acceder personal.
`phrase.project_id`	cadena	Sí	ID del proyecto público que se muestra en la configuración del proyecto de Strings.
`phrase.file_format`	cadena	Sí	Formato de archivo de la localización predeterminado file format (extensión de API).
`phrase.locale_mapping`	objeto	No	Asigna los ID de localización de Phrase a nombres Personalizar para usar en rutas de archivo con el marcador de posición `<locale_name>`. Esto es útil para plataformas con convenciones de nomenclatura no estándar, como Android. Si no se especifica una localización en el mapeo, se usa su nombre de localización de Phrase estándar de forma predeterminada.

Enviar: Fuentes

Clave	Tipo	Requerido	Descripción
`push.sources[].file`	ruta	Sí	Ruta relativa al archivo o archivos que se van a enviar, p. ej., `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	cadena		Sustituir el `ID del proyecto` global para esta fuente de archivo específica. Útil al enviar archivos a múltiples proyectos de Phrase desde el mismo archivo de configuración.

Enviar: Parámetros

Parámetro	Tipo	Predeterminada	Descripción
`file_format`	cadena	encabezado	Sustituir el formato para esta fuente.
`locale_id`	cadena	—	Nombre de la localización (p. ej., `en-US`) o ID de localización pública.
`tags`	cadena	—	Etiquetas separadas por comas para nuevas clave.
`update_translations`	Booleano	`false`	Actualizar las traducciones existentes con el contenido del archivo.
`update_translation_keys`	Booleano	`true`	Pase `false` aquí para evitar que se creen nuevas clave y que se actualicen las clave existentes.
`update_descriptions`	Booleano	`false`	Actualizar las descripciones de clave; las descripciones vacío sobrescriben las existentes.
`skip_upload_tags`	Booleano	`false`	Las etiquetas de cargar no se crean.
`skip_unverification`	Booleano	`false`	Las traducciones actualizadas no se marcan como sin verificar.
`file_encoding`	cadena	—	Codificación de archivo: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` o `ISO-8859-1`.
`locale_mapping`	objeto	—	(Solo Excel/CSV) Asigne códigos de localización a nombres de columna, p. ej., `{"en": "C", "de": "D"}` para analizar las traducciones. Esto es distinto del `locale_mapping` de nivel superior utilizado para las rutas de archivo.
`autotranslate`	Booleano	`false`	Obtener automáticamente las traducciones para el idioma cargado.
`mark_reviewed`	Booleano	`false`	Marcar las traducciones importadas como revisado (el flujo de trabajo de revisión avanzado debe estar habilitado).

Push: Opciones de formato

Todas las opciones de formato disponibles son compatibles con la configuración de la CLI. Consulte Archivo de configuración de ejemplo para ver ejemplos.

Pull: Targets

Clave	Tipo	Requerido	Descripción
`pull.targets[].file`	ruta	Sí	Ruta relativa para los archivos de localización extraídos, p. ej., `./Radio.de/<locale_code>.lproj/Localizable.Strings`.
`pull.targets[].project_id`	cadena		Anular el `proyecto_ID` global para este meta de extracción específico. Habilitar la extracción de traducciones de múltiples proyectos Phrase usando el mismo archivo de configuración.

Extraer: Parámetros

Parámetro	Tipo	Predeterminada	Descripción
`file_format`	cadena	—	Debe ser `Strings`.
`locale_id`	cadena	—	Nombre de la localización (p. ej., `en-US`) o ID de localización pública.
`tags`	cadena	—	Etiquetas separadas por comas para filtrar qué claves extraer.
`include_empty_translations`	Booleano	`false`	Incluir claves sin ninguna traducción.
`exclude_empty_zero_forms`	Booleano	`false`	Excluir plurales de forma cero cuando estén vacío.
`include_translated_keys`	Booleano	`true`	Incluir claves que ya tienen traducciones.
`keep_notranslate_tags`	Booleano	`false`	Preservar etiquetas `[NOTRANSLATE]` en la salida.
`codificación`	cadena	—	Codificación de archivo: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` o `ISO-8859-1`.
`include_unverified_translations`	Booleano	`true`	Si es `false`, excluir traducciones sin verificar.
`use_last_reviewed_version`	Booleano	`false`	Si es `true`, usar la última versión revisado (requiere flujo de trabajo de revisión avanzado).
`fallback_locale_id`	cadena	—	Localización de reserva para usar en caso de traducciones faltantes.

Extraer: Opciones de formato

Todas las opciones de formato disponibles son compatibles con la configuración de la CLI. Consulte Archivo de configuración de ejemplo para ver ejemplos.

Configuraciones múltiples

En monorepos, coloque un archivo de configuración en cada paquete y ejecute la CLI desde la subcarpeta correspondiente, o apunte los trabajos de CI a diferentes archivos de configuración con la opción --config.

Integración de Git

GitLab:

El archivo de configuración .phrase.yml debe estar presente en el repositorio. El archivo define qué importar (pull) o exportar (push) del repositorio.
Requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contiene al menos un meta para importar y otro para exportar, que los formatos de archivo sean correctos y que la configuración del parámetro update_translations esté bien.
Usa GitLab 9.5 o una versión más reciente para garantizar la compatibilidad de la API.

GitHub:

El archivo de configuración .phrase.yml debe estar presente en el repositorio. El archivo define qué importar (pull) o exportar (push) del repositorio.
Requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contiene al menos un meta para importar y otro para exportar, que los formatos de archivo sean correctos y que la configuración del parámetro update_translations esté bien.
Un token de acceso de GitHub para el ámbito del repositorio (public_repo si se sincroniza con un repositorio público).
Si se ha habilitado el SSO en GitHub, también debe estar habilitado para el token de acceso.
No se puede proteger la rama phrase_translations.
Asegúrate de que la configuración del repositorio no necesite firmar compromisos.

BitBucket:

El archivo de configuración .phrase.yml debe estar presente en el repositorio. El archivo define qué importar (pull) o exportar (push) del repositorio.
Requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contiene al menos un meta para importar y otro para exportar, que los formatos de archivo sean correctos y que la configuración del parámetro update_translations esté bien.