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

token de acceso a la API con el alcance lectura escritura
ID del proyecto de Strings mostrado en la pestaña API de la configuración del proyecto
Conocimientos básicos de YAML, incluyendo la indentación
Permisos de lectura y escritura de Git si el repositorio ejecutará phrase push o phrase pull en CI

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

Desde 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 $PHRASE_ACCESS_TOKEN sea utilizado
- ID del proyecto de Strings (por ejemplo, abcdef1234567890abcdef1234567890)
- Formato de archivo de localización (por ejemplo, json, rails_yaml, ios_strings)
- Ruta local
  
  Ruta global o exacta a los archivos de localización en el código del proyecto (por ejemplo, config/locales/*.json)

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

Consejo

Proporciona banderas para omitir completamente el asistente, 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.
Ruta al archivo de configuración a través de la etiqueta --config (p. ej., /some/path/to/phrase.yml).

Resumen de opciones de la CLI

Archivo de configuración de muestra.

Configuración global

Clave	Tipo	Requerido	Descripción
`phrase.access_token`	cadena	Sí	Token de acceso personal.
`phrase.project_id`	cadena	Sí	ID de proyecto público mostrado en la configuración del proyecto Strings.
`phrase.file_format`	cadena	Sí	Formato de archivo local predeterminado (extensión de API).
`phrase.locale_mapping`	objeto	No	Asocia los ID de localización de Phrase a nombres personalizados para su uso 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 utiliza su nombre de localización estándar de Phrase por defecto.

Empujar: Fuentes

Clave	Tipo	Requerido	Descripción
`push.sources[].file`	ruta	Sí	Ruta relativa a archivo(s) a empujar, por ejemplo `./ruta/a/archivo/<código_local>`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	cadena		Sobrescribir el `id_proyecto` global para esta fuente de archivo específica. Útil al empujar archivos a múltiples proyectos de Phrase desde el mismo archivo de configuración.

Empujar: Parámetros

Parámetro	Tipo	Por defecto	Descripción
`file_format`	cadena	encabezado	Sobrescribir el formato de archivo para esta fuente.
`locale_id`	cadena	—	Nombre de la localización (por ejemplo `es-ES`) o ID de localización pública.
`etiquetas`	cadena	—	Etiquetas separadas por comas para nuevas claves.
`update_translations`	booleano	`false`	Actualizar traducciones existentes con el contenido del archivo.
`update_translation_keys`	booleano	`true`	Pase `false` aquí para evitar que se creen nuevas claves y se actualicen las claves existentes.
`update_descriptions`	booleano	`false`	Actualiza las descripciones de las claves; las descripciones vacías sobrescriben las existentes.
`skip_upload_tags`	booleano	`false`	Las etiquetas de carga no se crean.
`skip_unverification`	booleano	`false`	Las traducciones actualizadas no están 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) Mapea los códigos de localización a los nombres de las columnas, por ejemplo, `{"en": "C", "de": "D"}` para analizar traducciones. Esto es distinto del `mapeo_localización` de nivel superior utilizado para las rutas de archivo.
`autotranslate`	booleano	`false`	Obtiene automáticamente traducciones para el idioma cargado.
`mark_reviewed`	booleano	`false`	Marca las traducciones importadas como revisadas (flujo de trabajo de revisión avanzada debe estar habilitado).

Enviar: Opciones de formato

Todas las opciones de formato disponibles son compatibles en la configuración de la CLI. Consulta Archivo de configuración de ejemplo para ejemplos.

Recibir: Objetivos

Clave	Tipo	Requerido	Descripción
`pull.targets[].file`	ruta	Sí	Ruta relativa para los archivos de localización extraídos, por ejemplo, `./Radio.de/<código_localización>.lproj/Localizable.strings`.
`pull.targets[].project_id`	cadena		Sobrescribe el `project_id` global para este objetivo de extracción específico. Habilitar la extracción de traducciones de múltiples proyectos de Phrase utilizando el mismo archivo de configuración.

Extraer: Parámetros

Parámetro	Tipo	Por defecto	Descripción
`file_format`	cadena	—	Debe ser `cadenas`.
`locale_id`	cadena	—	Nombre de la localización (por ejemplo `es-ES`) o ID de localización pública.
`etiquetas`	cadena	—	Etiquetas separadas por comas para filtrar qué claves extraer.
`include_empty_translations`	booleano	`false`	Incluir claves sin traducciones.
`exclude_empty_zero_forms`	booleano	`false`	Excluir plurales de forma cero cuando estén vacíos.
`include_translated_keys`	booleano	`true`	Incluir claves que ya tienen traducciones.
`keep_notranslate_tags`	booleano	`false`	Preservar las 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 `false`, excluir traducciones sin verificar.
`use_last_reviewed_version`	booleano	`false`	Si `true`, usar la última versión revisada (requiere un flujo de trabajo de revisión avanzado).
`fallback_locale_id`	cadena	—	Localización de respaldo a utilizar para traducciones faltantes.

Extraer: Opciones de formato

Todas las opciones de formato disponibles son compatibles en la configuración de la CLI. Consulta Archivo de configuración de ejemplo para ejemplos.

Múltiples configuraciones

En monorepos, coloca un archivo de configuración en cada paquete y ejecuta la CLI desde la subcarpeta correspondiente, o apunta 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é archivos importar (extraer) o exportar (empujar) del repositorio.
Se requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contenga 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é archivos importar (extraer) o exportar (empujar) del repositorio.
Se requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contenga 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é archivos importar (extraer) o exportar (empujar) del repositorio.
Se requiere un acceso de lectura y escritura para el repositorio.
Los archivos de configuración definidos incorrectamente pueden causar errores. Comprueba que el archivo contenga 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.

phrase_configuration_overview.yml
(8 kB)