Файл конфигурации

Введение

Crowdin CLI использует файл конфигурации YAML, который содержит описание ресурсов для управления: файлы, которые будут загружены в Crowdin, и местоположения соответствующих переводов.

Чтобы использовать Crowdin CLI, вы должны сначала сгенерировать файл конфигурации, а затем запустить инструмент. By default, Crowdin CLI looks for a configuration file named crowdin.yaml (so you don’t have to specify the file name unless it’s different from crowdin.yaml).

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

$ crowdin generate

Структура файла конфигурации

Правильный файл конфигурации Crowdin CLI YAML имеет следующую структуру, поэтому убедитесь, что вы заполнили всю необходимую информацию:

• Заглавие файла с учетными данными проекта, настройками и информацией о доступе
• Один элемент массива файлов, который описывает набор исходных файлов и файлов перевода, которыми вы будете управлять
• Required fields in the files array: Source that defines filters for the source files and Translation with instructions on where to store the translated files or where to look for translations you already have if you want to upload them while setting up the CLI

Смотрите статью Настройка интеграции API, чтобы узнать, где найти учетные данные вашего проекта.

Создание простого файла конфигурации

Типичный файл конфигурации YAML выглядит примерно так:

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/office/source-code"

"files": [
  {
    "source" : "/resources/en/*.json",                                          #source files filter
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #where translations are stored
  }
]

Примечание: В Windows, если вы используете разделитель каталогов в стиле Windows, он должен быть удвоен в соответствии с синтаксисом YAML:

{
"source" : "\\resources\\en\\*.json",
"translation" : "\\resources\\%two_letters_code%\\%original_file_name%"
}

Чтобы запустить этот файл конфигурации и загрузить исходные файлы на Crowdin, стоит всего лишь выполнить команду:

$ crowdin upload sources

Скачать переводы из Crowdin и положить их в правильные директории:

$ crowdin download

Учетные данные API из переменных окружения

Вы можете загрузить учетные данные API из переменной окружения, например:

"api_key_env": CROWDIN_API_KEY "project_identifier_env": CROWDIN_PROJECT_ID "base_path_env": CROWDIN_BASE_PATH

Если смешано, api_key и project_identifier имеют приоритет:

"api_key_env": CROWDIN_API_KEY            # Низкий приоритет "project_identifier_env": CROWDIN_PROJECT # Низкий приоритет "base_path_env": CROWDIN_BASE_PATH        # Низкий приоритет "api_key": "xxx"                          # Высокий приоритет "project_identifier": "yyy"               # Высокий приоритет "base_path": "zzz"                        # Высокий приоритет

Разделение конфигурации проекта и учетных данных API

Файл crowdin.yaml содержит описание ресурсов для управления и учетные данные API (api_key, project_identifier, base_path). Это означает, что небезопасно, помещать этот файл в репозиторий кода, так как ключ API будет доступен другим пользователям. Crowdin CLI supports 2 types of configuration files:

• a description of the resources to manage, residing in the project directory
• API credentials, probably residing in $HOME/.crowdin.yaml

Note: API credentials from .crowdin.yaml configuration file are of higher priority than credentials from project directory(crowdin.yaml).

Если вам нужно запустить команду с пользовательскими учетными данными (например, upload sources) то выполните следующую команду:

$ crowdin upload sources --identity 'path-to-user-credentials-file'

Но если файл пользовательских учетных данных находится в $HOME/.crowdin.yaml, вы можете просто запустить:

$ crowdin upload sources

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

Приведенный выше пример конфигурации имеет атрибуты ‘source’ и ‘translation’, которые содержат стандартные постановочные знаки (также известные как универсальные шаблоны) для упрощения работы с несколькими файлами.

Вот шаблоны, которые вы можете использовать:

* (asterisk)

Represents any character in file or directory name. If you specify a “*.json” it will include all files like “messages.json”, “about_us.json” and anything that ends with “.json”.

** (doubled asterisk)

Совпадает с любой строчкой рекурсивно (включая подпапки). Note that you can use ** in both source and translation patterns. When using ** in the translation pattern, it will always contain sub-path from source for a certain file. For example, you can use source: ‘/en/**/*.po’ to upload all *.po files to Crowdin recursively. The translation pattern will be ‘/%two_letters_code%/**/%original_file_name%’.

? (воспросительный знак)

Соответствует любому одному символу.

[set]

Matches any single character in a set. Behaves exactly like character sets in Regexp, including set negation ([^a-z]).

\ (Обратный слэш)

Экранирует следующий метасимвол.

Заполнители

В crowdin cli можно использовать следующие заполнители для внесения соответствующих переменных в результирующее имя файла:

Вы также можете указать полный путь к файлам в архиве, поставив косую черту (/) в начале шаблона.

Шаблон translation может выглядеть следующим образом: “/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%”.

Использование постановочных знаков (wildcards)

Структура файлов и папок на локальном компьютере:

- base_path | |-- folder |     | |     |-- 1.xml |     |-- 1.txt |     |-- 123.txt |     |-- 123_test.txt |     |-- a.txt |     |-- a1.txt |     |-- crowdin?test.txt |     |-- crowdin_test.txt | |-- 1.xml |-- 1.txt |-- 123.txt |-- 123_test.txt |-- a.txt |-- a1.txt |-- crowdin?test.txt |-- crowdin_test.txt |-- 3.txt

Example 1. Usage of wildcards in the source path:

# ........конфигурация вашего проекта........
"files" : [
  { "source" : "/**/?[0-9].txt", #upload a1.txt, folder/a1.txt "translation" : "/**/%two_letters_code%_%original_file_name%" },
  { "source" : "/**/*\\?*.txt", #upload crowdin?test.txt, folder/crowdin?test.txt "translation" : "/**/%two_letters_code%*%original_file_name%" },
  { "source" : "/**/[^0-2].txt", #upload 3.txt, folder/3.txt, a.txt, folder/a.txt (ignore 1.txt, folder/1.txt) "translation" : "/**/%two_letters_code%_%original_file_name%" } ]

Example 2. Usage of wildcards for ignoring files:

# ........конфигурация вашего проекта........

"files": [
  { "source" : "/**/*.*", #upload all files that  the base_path contains "translation" : "/**/%two_letters_code%_%original_file_name%", "ignore" : [ "/**/%two_letters_code%_%original_file_name%", #ignore the translated files "/**/?.txt",                                   #ignore 1.txt, a.txt, folder/1.txt, folder/a.txt "/**/[0-9].txt",                               #ignore 1.txt, folder/1.txt "/**/*\\?*.txt",                               #ignore crowdin?test.txt, folder/crowdin?test.txt "/**/\[0-9\]\[0-9\][0-9].txt",                     #ignore 123.txt , folder/123.txt "/**/[0-9]***.txt"                             #ignore 123_test.txt, folder/123_test.txt ] } ]

Сопоставление языка

Часто программные проекты имеют собственные имена для каталогов локали. Crowdin allows you to map your own languages.

Предположим, папки с вашими локалями называются ‘en’, ‘uk’, ‘fr’, ‘de’. Все они могут быть представлены заполнителем %two_letters_code%. В то же время у вас имеется папка ‘zh_CH’. Чтобы заставить это работать с Crowdin CLI без изменений в вашем проекте, вы можете добавить раздел languages_mapping к вашему набору файлов.

Формат разметки следующий:“crowdin_language_code” : “нужный_языковый_код”. Ознакомьтесь с полным списком языковых кодов Crowdin, которые можно использовать для разметки.

You can also override language codes for other placeholders like %android_code%, %locale%, etc.

You can set up Language Mapping for any of your project’s target languages via the user interface (UI):

1. Go to the Project Settings, Export section.
2. Click Language Mapping.
3. Choose the necessary language, placeholder, and add custom code.

Переименование файла перевода

Если вам нужно переименовать файл с переводами после экспорта, это легко сделать с помощью параметра ` translation_replace`.

Например, если файл называется «strings_en.xml», его можно переименовать в «strings.xml». Для этого добавьте новый параметр (на том же уровне, что и параметр перевода) в файл конфигурации (crowdin.yaml):

"files" : [
  { "source" : "/locale/**/en_*.po", "translation" : "/locale/**/%two_letters_code%_%original_file_name%", "translation_replace": { "en_" : "" } } ]

В этом случае «_en» будет просто удален из имени файла.

Игнорирование файлов и каталогов

From time to time there are files and directories you don’t need to translate in Crowdin. In such cases, local per-file rules can be added to the config file in your project.

"files": [
  { "source" : "/**/*.properties", "translation" : "/**/%file_name%_%two_letters_code%.%file_extension%", "ignore" : [ "/test/file.properties", "/example.properties" ] },
  { "source" : "/locale/en/**/*.po", "translation" : "/locale/%two_letters_code%/**/%original_file_name%", "ignore" : [ "/locale/en/templates", "/locale/en/workflow" ] } ]

Многоколоночный CSV

Если файл CSV содержит переводы для всех целевых языков, вы должны указать соответствующие коды языков в схеме.

Пример файла CSV:

identifier,source_phrase,context,Ukrainian,Russian,French ident1,Source 1,Context 1,,, ident2,Source 2,Context 2,,, ident3,Source 3,Context 3,,,

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

"files" : [
  {
    "source" : "multicolumn.csv",
    "translation" : "multicolumn.csv",
    "first_line_contains_header" : true,
    "scheme" : "identifier,source_phrase,context,uk,ru,fr"
  }
]

If your CSV file contains columns that should be skipped on import, use none for such columns in the scheme, for example:

"scheme" : "identifier,source_phrase,context,uk,none,ru,none,fr"

Сохранение структуры каталогов на сервере

"preserve_hierarchy": true

Пример использования конфигурации с использованием параметра preserve_hierarchy:

"project_identifier": "test" "api_key": "KeepTheAPIkeySecret" "base_url": "https://api.crowdin.com" "base_path": "/path/to/your/project" "preserve_hierarchy": true

"files" : [
  { "source" : "/locale/en/**/*.po", "translation" : "/locale/%two_letters_code%/**/%original_file_name%" } ]

By default, directories that do not contain any files for translation will not be created in Crowdin. For example:

- locale | |-- en | |-- foo.po |-- bar.po

По умолчанию файлы проекта будут представлены в Crowdin следующим образом:

- foo.po
- bar.po

С использованием параметра preserve_hierarchy структура файлов в Crowdin будет следующей:

- en | |-- foo.po |-- bar.po

Загрузить файлы указанного типа по указанному пути

Эта функция добавляет поддержку 2 дополнительных параметров в yaml файл: dest и type. Это как правило полезно для некоторых проектов, где загруженные имена должны отличаться от Crowdin, но он мог определить тип правильно. Параметр Dest позволяет задать имя файла в Crowdin.

Пример конфигурационного файла с обоими параметрами:

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/office/source-code" "preserve_hierarchy": true

"files" : [
  { "source" : "/conf/messages", "dest" : "/messages.properties", "translation" : "/conf/messages.%two_letters_code%", "type" : "properties" },
  {
  "source" : "/app/strings.xml",
  "dest" : "/strings.xml",
  "translation" : "/res/values-%android_code%/%original_file_name%"
  }
]

Обновление изменённых строк

The parameter update_option is optional. If it is not set, translations for changed strings will be lost. Useful for typo fixes and minor changes in source strings.

В зависимости от значения update_option используется для сохранения переводов и сохранения/удаления утверждений переводов и изменённых строк во время обновления файла.

Используйте следующие значения:

• update_as_unapproved - preserve translations of changed strings and remove validations of those translations if they exist
• update_without_changes - preserve translations and validations of changed strings

Пример конфигурационного файла с использованием параметра update_option:</p>

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/office/source-code"

"files" : [
  { "source" : "/*.csv", "translation" : "/%three_letters_code%/%file_name%.csv", "first_line_contains_header" : true, "scheme" : "identifier,source_phrase,translation,context", "update_option" : "update_as_unapproved" },
  {
    "source": "/**/*.xlsx",
    "translation" : "/%three_letters_code%/folder/%file_name%.xlsx",
    "update_option" : "update_without_changes"
  }
]

Загрузка переводов

Команда upload translations загружает существующие переводы в Crowdin. Если параметры не указаны, загруженные переводы не будут импортированы, даже если они дублированы или совпадают с исходными строками и не будут утверждены.

Используйте следующие значения:

• -l, –language = language_code - определяет языковые переводы, которые должны быть загружены в Crowdin. По умолчанию переводы загружаются на все целевые языки проекта. (языковые коды Crowdin)
• –[no-]import-duplicates - определяет, добавлять ли перевод, если в проекте Crowdin уже есть такой же перевод
• –[no-]import-duplicates - определяет, добавлять ли перевод, если строка равна исходной в проекте Crowdin
• –[no-]auto-approve-imported - автоматически утверждать загруженные переводы

Дополнительные параметры для XML-файлов

Пример конфигурационного файла с дополнительными параметрами:

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/office/source-code"

"files" : [
  { "source" : "/app/sample1.xml", "translation" : "/app/%locale%/%original_file_name%", "translate_attributes" : 1, "translate_content" : 0 },
  {
    "source" : "/app/sample2.xml",
    "translation" : "/app/%locale%/%original_file_name%",
    "translatable_elements" : [
      "/content/text",             # translatable texts are stored in "text" nodes of parent node "content"
      "/content/text[@value]"      # translatable texts are stored in "value" attribute of "text" nodes
    ]
  }
]

Экранирование кавычек в формате .properties

Определяет, будет ли одинарная кавычка экранирована другой одинарной кавычкой или обратным слешем в экспортированных переводах. You can add escape_quotes per-file option. Допустимые значения: 0, 1, 2, 3. Значение по умолчанию 3.

Используйте следующие значения:

• 0 - не экранировать одинарную кавычку
• 1 - экранировать одинарную кавычку другой одинарной кавычкой
• 2 - экранировать одинарную кавычку обратным слешем
• 3 - экранировать одинарную кавычку другой одинарной кавычкой только в строках, содержащих переменные ( {0} )

Экранирование специальных символов
Определяет, нужно ли экранировать специальные символы (=,:,! и #) обратной косой чертой в экспортированных переводах. Вы можете добавить параметр escape_special_characters для каждого файла.

Допустимые значения: 0, 1. Значение по умолчанию 1.

• 0 - не экранировать специальные символы
• 1 - экранировать специальные символы обратной косой чертой

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

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/office/source-code"

"files" : [
  {
    "source" : "/en/strings.properties",
    "translation" : "/%two_letters_code%/%original_file_name%",
    "escape_quotes" : 1,
    "escape_special_characters" : 0
  }
]

Примеры конфигурации

Загрузка файлов CSV через API

"project_identifier": "test" "api_key": "KeepTheAPIkeySecret" "base_url": "https://api.crowdin.com" "base_path": "/path/to/your/project"

"files" : [
  {
    "source" : "/*.csv",
    "translation" : "/%two_letters_code%/%original_file_name%",
    # Defines whether first line should be imported or it contains columns headers
    "first_line_contains_header" : true,
    # Used only when uploading CSV file to define data columns mapping.
    "scheme" : "identifier,source_phrase,translation,context,max_length"
  }
]

Проект GetText

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/website"

"files" : [
  {
    "source" : "/locale/en/**/*.po",
    "translation" : "/locale/%two_letters_code%/LC_MESSAGES/%original_file_name%",
    "languages_mapping" : {
      "two_letters_code" : {
        "zh-CN" : "zh_CH",
        "fr-QC": "fr"
      }
    } } ]

Проект Android

"project_identifier": "your-project-identifier" "api_key": "54e01e81--your-api-key--f6a2724a"                 #can be found in your project settings > API tab "base_path": "/home/android-app"

"files" : [
  {
    "source" : "/res/values/*.xml",
    "translation" : "/res/values-%android_code%/%original_file_name%",
    "languages_mapping" : {
      "android_code" : {
        "de" : "de",
        "ru" : "ru"
      }
    } } ]

Файл конфигурации для интеграции VCS

Интеграция VCS требует того же файла конфигурации, что и инструмент CLI, то есть поддерживается та же структура. Единственное отличие состоит в том, что учетные данные проекта не должны храниться в заголовке файла по соображениям безопасности. Также можно использовать два дополнительных параметра.

Параметр сообщения слияния для интеграции VCS

Each time translations are commited the default message is shown “New translations {fileName} ({languageName})”. You can use commit_message parameter to add Git tags, in order to skip builds, add tests, and more.

Пример:

"base_path": "/home/office/source-code" "commit_message": "[ci skip]" "files": [
  {
    "source" : "/resources/en/*.json",                                          #source files filter
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #where translations are stored
  }
]

Чтобы заменить сообщение коммита по умолчанию, используйте параметр append_commit_message со значением false. Вы также можете добавить два необязательных заполнителя: %original_file_name% и %language% чтобы использовать переменные имя файла и язык соответственно.

Пример:

"commit_message": "Fix: New translations %original_file_name% from Crowdin" "append_commit_message": false "files": [
  {
    "source" : "/resources/en/*.json",                                          #source files filter
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #where translations are stored
  }
]

Параметр экспорта языков для интеграции VCS

By default, all the languages are exported. If you need to export some specific languages, use export_languages paramenter to specify them.

Пример:

"base_path": "/home/office/source-code" "export_languages": [ "ru", "uk", "ja" ] "files": [
  {
    "source" : "/resources/en/*.json",                                          #source files filter
    "translation" : "/resources/%two_letters_code%/%original_file_name%"        #where translations are stored
  }
]

Нужна помощь

Need help working with Crowdin CLI or have any questions? Contact Support Team.

Полезная информация

• Управление версиями
• Crowdin CLI