Создать файл конфигурации CLI (Strings)

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

Предварительные требования

Токен доступа интерфейс приложений API с областью чтения и записи
Идентификатор проекта Strings, отображаемый на вкладке интерфейс приложений API в настройках проекта
Базовые знания YAML, включая отступы
Права на чтение и запись Git, если в хранилище будет выполняться phrase push или phrase pull в CI

Совет

Для получения более подробной информации обратитесь к Developer Hub.

Чтобы автоматически создать файл конфигурации, выполните следующие действия:

Введите в командной строке phrase init, чтобы создать файл .phrase.yml.

Мастер настройки запускается в CLI.
Предоставьте:
- Токен доступа
  
  Вставьте или нажмите Enter, чтобы разрешить использование $PHRASE_ACCESS_TOKEN
- Идентификатор проекта Strings (например, abcdef1234567890abcdef1234567890)
- Формат файла языкового стандарта (например, json, rails_yaml, ios_strings)
- Локальный путь
  
  Glob-шаблон или точный путь к файлам языкового стандарта в кодовой базе проекта (например, config/locales/*.json)

Базовый файл .phrase.yml создается в текущем каталоге.

Обзор параметров CLI

Образец файла конфигурации.

Общие настройки

Ключ	Тип	Обязательно	Описание
`phrase.access_token`	строка	Да	Личный токен доступа.
`phrase.project_id`	строка	Да	Идентификатор общедоступного проекта, отображаемый в настройках проекта Strings.
`phrase.file_format`	строка	Да	Языковой стандарт по умолчанию формат файла (расширение интерфейс приложений API).
`phrase.locale_mapping`	объект	Нет	Сопоставляет Идентификаторы языкового стандарта Phrase с Пользовательский именами для использовать в путях к файлам с помощью заполнитель `<locale_name>`. Это полезно для платформ с нестандартными соглашениями об именовании, таких как Android. Если языковой стандарт не указан в сопоставлении, по умолчанию используется его стандартное имя языкового стандарта Phrase.

Отправка: Оригиналы

Ключ	Тип	Обязательно	Описание
`push.sources[].file`	путь	Да	Относительный путь к файлу(ам) для отправки, например `./path/to/file/<locale_code>.json`. Supports `<locale_name>`, `<locale_code>`, `<tags>`.
`push.sources[].project_id`	строка		Переопределить глобальный `Идентификатор проекта` для этого конкретного оригинала файла. Полезно при отправке файлов в несколько проектов Phrase из одного и того же файла конфигурации.

Отправка: Параметры

Параметр	Тип	По умолчанию	Описание
`file_format`	строка	заголовок	Переопределить формат файла для этого оригинала.
`locale_id`	строка	—	Имя языкового стандарта (например, `en-US`) или общедоступный Идентификатор языкового стандарта.
`tags`	строка	—	Теги, разделенные запятыми, для новых ключей.
`update_translations`	булевский	`false`	Обновить существующие переводы с помощью контента файла.
`update_translation_keys`	булевский	`true`	Передайте `false` здесь, чтобы предотвратить создание новых ключей и обновление существующих ключей.
`update_descriptions`	булевский	`false`	Обновить описания ключей; пустой описания перезаписывают существующие.
`skip_upload_tags`	булевский	`false`	Теги загрузки не создаются.
`пропустить_не_проверено`	булевский	`false`	Обновленные переводы не являются не проверенными.
`file_encoding`	строка	—	Кодировка файла: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` или `ISO-8859-1`.
`locale_mapping`	объект	—	(Только Excel/CSV) Сопоставьте коды языкового стандарта с именами столбцов, например `{\"en\": \"C\", \"de\": \"D\"}` для синтаксического анализа переводов. Это отличается от `locale_mapping` верхнего уровня, используемого для путей к файлам.
`автоперевод`	булевский	`false`	Автоматически получать переводы для загруженного языка.
`mark_reviewed`	булевский	`false`	Пометить импортированные переводы как проверено (расширенный рабочий процесс проверки должен быть включен).

Отправка: Параметры формата

Все доступные параметры формата поддерживаются в конфигурации CLI. Примеры см. в Образец файла конфигурации.

Выгрузка: перевод

Ключ	Тип	Обязательно	Описание
`pull.targets[].file`	путь	Да	Относительный путь для выгруженных файлов языкового стандарта, например `./Radio.de/<locale_code>.lproj/Localizable.Strings`.
`pull.targets[].project_id`	строка		Переопределить глобальный `Идентификатор проекта` для этого конкретного целевого объекта выгрузки. Включить выгрузку переводов из нескольких проектов Phrase с использованием одного и того же файла конфигурации.

Выгрузка: Параметры

Параметр	Тип	По умолчанию	Описание
`file_format`	строка	—	Должно быть `Strings`.
`locale_id`	строка	—	Имя языкового стандарта (например, `en-US`) или общедоступный Идентификатор языкового стандарта.
`tags`	строка	—	Теги, разделенные запятыми, для фильтрации ключей, которые нужно выгрузить.
`include_empty_translations`	булевский	`false`	Включить ключи без каких-либо переводов.
`exclude_empty_zero_forms`	булевский	`false`	Исключить формы множественного числа с нулевым окончанием, если они пустые.
`include_translated_keys`	булевский	`true`	Включить ключи, для которых уже есть переводы.
`keep_notranslate_tags`	булевский	`false`	Сохранять теги `[NOTRANSLATE]` в результат.
`Кодирование`	строка	—	Кодировка файла: `UTF-8`, `UTF-16`, `UTF-16BE`, `UTF-16LE` или `ISO-8859-1`.
`include_unverified_translations`	булевский	`true`	Если `false`, исключить не проверено переводы.
`use_last_reviewed_version`	булевский	`false`	Если `true`, использовать последнюю проверено версию (требуется расширенный рабочий процесс проверки).
`fallback_locale_id`	строка	—	Языковой стандарт для использования в качестве резервного при отсутствии переводов.

Извлечение: Параметры формата

Все доступные параметры формата поддерживаются в конфигурации CLI. Примеры см. в Образец файла конфигурации.

Несколько конфигураций

В монорепозиториях размещайте по одному файлу конфигурации в каждом пакете и запускайте CLI из соответствующей подпапки или указывайте заданиям CI разные файлы конфигурации с помощью параметра --config.

Интеграция с Git

GitLab:

Файл конфигурации .phrase.yml должен присутствовать в хранилище. Файл определяет, какие файлы импортировать (отправка) или экспортировать (извлечение) из хранилища.
Для хранилища необходимо получить доступ для чтения и записи.
Неверно заданные файлы конфигурации могут вызвать ошибки. Убедитесь, что файл содержит хотя бы одну цель для отправки и одну для извлечения, правильные форматы файлов и правильную настройку параметра Update_translations.
Используйте GitLab 9.5 или более поздние версии для обеспечения совместимости интерфейса приложений API.

GitHub:

Файл конфигурации .phrase.yml должен присутствовать в хранилище. Файл определяет, какие файлы импортировать (отправка) или экспортировать (извлечение) из хранилища.
Для хранилища необходимо получить доступ для чтения и записи.
Неверно заданные файлы конфигурации могут вызвать ошибки. Убедитесь, что файл содержит хотя бы одну цель для отправки и одну для извлечения, правильные форматы файлов и правильную настройку параметра Update_translations.
Токен доступа GitHub для области хранилища (public_repo, если есть синхронизация с общедоступным хранилищем).
Если в GitHub включен единый вход в систему (SSO), его также необходимо активировать для токена доступа.
Невозможно защитить ветвь phrase_translations.
Убедитесь, что настройки хранилища не требуют подписанных фиксаций.

BitBucket:

Файл конфигурации .phrase.yml должен присутствовать в хранилище. Файл определяет, какие файлы импортировать (отправка) или экспортировать (извлечение) из хранилища.
Для хранилища необходимо получить доступ для чтения и записи.
Неверно заданные файлы конфигурации могут вызвать ошибки. Убедитесь, что файл содержит хотя бы одну цель для отправки и одну для извлечения, правильные форматы файлов и правильную настройку параметра Update_translations.

phrase.yml.sample
(3 КБ)