CLI

Изменить файл конфигурации CLI (строки)

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

Файл .phrase.yml используется для хранения повторно используемых аргументов командной строки.

Поддерживаемые аргументы:

  • project_id

    Идентификатор проекта.

  • file_format

    Формат файла, используемый в случаях, когда он явно не указан в исходных и целевых записях.

  • per_page

    Количество элементов, возвращенных в ответах на странице.

Пример файла конфигурации.

Push and Pull

Push

push фразы за $ 

Команда push загружает файлы, найденные в локальных каталогах проектов. Используйте файл .phrase.yml, чтобы указать файлы для загрузки и задать дополнительные параметры. Заполнитель <tag> также можно использовать для загрузки ключей в отдельные файлы по их тегам.

Вытащить

фразу за $ 

Аналогично команде push, за исключением globbing, использовать нельзя. Используя заполнители, используйте по возможности <locale_name>. Чтобы извлечь файл с ключами, имеющими определенный тег, используйте параметр тегов:

phrase:
  pull:
    целевые показатели:
    - file: path/to/file/<locale_name>.yml
      params:
        tags:tag_name

Для использования заполнителя <tag> нужные теги должны быть перечислены в разделе params.

Параметры

Команды push и pulg можно настроить в файле .phrase.yml. Параметры push такие же, как для конечной точки загрузки API, а параметры pull такие же, как у конечной точки загрузки locales API.

Push-пример:

push:
  источники:
  - file: ./locales/en.json
    params:
      update_translations: true 

Вытащить пример:

pull:
  целевые показатели:
  - файл: "./locales/example.yml"
    params:
      include_unverified_translations: true

Варианты формата

В зависимости от формата файла, к разделу параметра можно применить параметры формата. Параметры формата можно применять как к загрузкам, так и к загрузкам.

Примеры формата:

params:
  format_options:
    convert_placeholder: true

Некоторые форматы файлов позволяют усилить контроль над синтаксисом файлов:

phrase:
  pull:
    целевые показатели:
    - file: file.xml
      params:
        format_options:
          convert_placeholder: true

  push:
    источники:
    - file: file.csv
      params:
        format_options:
          column_separator: ";"

Заполнители и Globbing

Следующие заполнители и операторы перевода могут быть помещены на пути в записях вашего файла:

  • <locale_name>

    Уникальное название языкового стандарта.

  • <locale_code>

    Идентификатор языкового стандарта, совместимый с RFC 5646. Код языкового стандарта не должен быть уникальным, поэтому с одним и тем же кодом может существовать несколько языковых стандартов с разными именами.

  • <tag>

    Используйте теги для группировки ключей. Теги могут использоваться для сохранения исходной структуры файла.

Globbing

* и ** являются операторами глоблинга. Одна звездочка * пропускает любую папку по пути. Двойная звездочка ** соответствует стандартному оператору глобализации и соответствует любому символу для рекурсивного, неисчерпывающего совпадения.

Примеры:

# шаблон файла

./abc/**/*.yml
# с несколькими файлами в вашей системе

./abc/defg/en.yml

./abc/es.yml

./fr.yml
# выбирает

./abc/defg/en.yml

./abc/es.yml

Используя команду извлечь для загрузки файлов, укажите явный шаблон файла, такой как ./abc/defg/<locale_name>.yml вместо ./**/*.yml.

Ожидание загрузок

Все загрузки обрабатываются асинхронно. Чтобы дождаться загрузки, примените флаг --- подождите. Push будет ждать каждой загрузки файла и возвращает, не удалось это или нет.

Варианты использования

Загрузить файл в указанный языковой стандарт

Загрузите файл en.json в каталог ./locales/ с заданным locale_ id (языковой стандарт уже должен существовать).

Update_translations имеет значение ложь, поэтому импортируются только новые ключи и переводы. Если установлено, что клиент импортирует локальные изменения в существующие переводы, переписывая весь уже имеющийся контент.

phrase:
  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: nested_json

  push:
    источники:
    - file: ./locales/en.json
      params:
        update_translations: false
        locale_id: YOUR_LOCALE_ID # языковой стандарт должен существовать удаленно

Ruby on Rails: загрузить файл указанного типа

Загрузить все файлы, заканчивающиеся на .yml, расположенные в ./config/locales/. Ruby on Rails YAML файлы содержат информацию о языковом стандарте, поэтому нет необходимости указывать языковой стандарт в явном виде. Update_translations установлено значение истина, поэтому все изменения в переводах будут импортированы с переписыванием существующих данных.

phrase:
  push:
    источники:
    - file: ./config/locales/*.yml
      params:
        update_translations: true
        file_format: yml

Соответствие строк iOS

Для сопоставления всех файлов строк iOS с файлами с названием Localizable.strings в папках .lproj.

<locale_code> - это все, что совпадает после / и перед .lproj для создания и идентификации языковых стандартов.

Параметр update_translations опущен и имеет тот же эффект, что и ложный выбор.

phrase:
  push:
    источники:
    - файл: "./<locale_code>.lproj/Localizable.strings"
      params:
        file_format: strings

Ведение нескольких проектов Strings для одного проекта локализации

Отредактируйте файл конфигурации, чтобы ограничить объем проектов, разделив переводы на небольшие категории.

Примеры конфигурации для фреймворков

Измените файл конфигурации в соответствии с требованиями и проверьте его в системе контроля исходника или контроля версий.

Rails

phrase:
  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: "yml"

  push:
    источники:
    - файл: "./config/locales/*.yml"

  pull:
    целевые показатели:
    - file: "./config/locales/<locale_name>.yml"

Строки iOS

phrase:

  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: "strings"

  push:
    источники:
    - файл: "./<locale_code>.lproj/Localizable.strings"

  pull:
    целевые показатели:
    - файл: "./<locale_code>.lproj/Localizable.strings"
    - файл: "./<locale_code>.lproj/Localizable.stringsdict"
      params:
        #file_format можно перезаписать
        file_format: "stringsdict"

Android XML

В качестве шаблона файла Android не использует стандартные языковые коды ISO. Укажите требуемый шаблон в .phrase.yml.

phrase:
  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: "xml"

  push:
    источники:
    - файл: "./res/values-<locale_code>/strings.xml"

  pull:
    целевые показатели:
    - файл: "./res/values-<locale_code>/strings.xml"

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

phrase:
  access_token: ACCESS_TOKEN
  project_id: PROJECT_ID
  file_format: xml
  
  pull:
    целевые показатели:
    - file: ./app/src/main/res/values/strings.xml
      params:
        file_format: xml
        # Уникальный ID языкового стандарта для английского языка
        locale_id: LOCALE_ID
    - file: ./app/src/main/res/values-de/strings.xml
      params:
        file_format: xml
        # Уникальный ID языкового стандарта для немецкого языка
        locale_id: LOCALE_ID
    - file: ./app/src/main/res/values-de-rAU/strings.xml
      params:
        file_format: xml
        # Уникальный ID языкового стандарта для Австрии
        locale_id: LOCALE_ID
  push:
    источники:
    - file: ./app/src/main/res/values/strings.xml
      params:
        file_format: xml
        locale_id: LOCALE_ID
    - file: ./app/src/main/res/values-de/strings.xml
      params:
        file_format: xml
        locale_id: LOCALE_ID
    - file: ./app/src/main/res/values-de-rAU/strings.xml
      params:
        file_format: xml
        locale_id: LOCALE_ID
Была ли эта статья полезной?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.