Проверка Глобализации

Это Глобализация Проверка в модуле Quality Control обеспечивает готовность международного проекта к работе. Она выполняется при задачах QA и в pull-запросах и анализирует только то, что затронули изменения:

1. Каталоги. Строки, добавленные или изменённые изменением, на всех языках.
2. Код. Строки, добавленные изменением, для текста и форматирования, зависящих от конкретного языка или культуры.
3. Страницы. Когда проект указывает, как запустить свое приложение, его страницы отображаются с использованием псевдоперевода.

Мастер включает эту проверку по умолчанию после объединения pull request. Её настройки находятся в Quality Control → Глобализация; в рабочей области Настройки показывает, включена ли она.

Что блокируется по умолчанию#

Изменение возвращается на доработку, если в нём не хватает или повреждены строки, либо если добавленный код помещает читаемый пользователем текст прямо в код или собирает предложение из частей. Все остальные найденные проблемы отображаются как замечания и ничего не блокируют, пока вы сами не решите их заблокировать. Замечания по форматированию, сортировке и верстке остаются в отчёте, пока проект сам не столкнётся с ними в своём коде.

Выберите, что блокировать в разделе Quality Control → Глобализация: коды каталогов, Что в коде приводит к возврату изменения, и Проблемы со страницами, вызывающие возврат изменения на доработку. Проверить исходный код и Отобразить страницы отключить этапы проверки кода и страниц.

Коды каталогов#

Глоссарий, правила длины и запрещённых терминов выдают собственные коды, если в файле конфигурации заданы соответствующие параметры.

Коды кодов#

Дизайн для любого рынка показывает исправление для каждой проблемы.

Что анализирует эта проверка#

Этап проверки кода парсит JavaScript и TypeScript с JSX, а также считывает шаблоны Vue, Svelte, Astro, HTML, ERB и Handlebars, а также текст CSS. Правило применяется только в тех контекстах, где это указано: шаблон почтового индекса отображается только рядом с полем для почтового индекса, а список, соединённый запятой, — только там, где его читают люди.

• Переведено по определению. Текст в вызовах перевода и компонентах проекта (t(), formatMessage, <Trans>, <FormattedMessage>, $t()) и функции, перечисленные в файле конфигурации.
• Никогда текст. Защищённые термины и слова, разрешённые в файле конфигурации.
• Оставлено намеренно. Строка с i18n-ignore комментарием и строкой после него. Укажите причину: // i18n-ignore: product name.

Необязательный world раздел .coroid/i18n.json задаёт остальные параметры:

{
  "world": {
    "exclude": ["src/legacy/**", "scripts/**"],
    "translate": ["translateText", "i18n.translate"],
    "allow": ["Storefront", "OK"]
  }
}

Результаты и исправления#

Каждый результат сохраняется в протоколе выполнения проверки и отображается в разделе задачи Обнаруженные проблемыРезультаты каталогизируются по каталогу, ключу и языку, находки в коде — по файлу, строке и найденному тексту, результаты страниц — по странице, элементу и тексту. Находка считается устранённой, если при последней проверке того же элемента её больше нет.

В запросах на рецензирование находки в коде также отображаются в виде аннотаций на изменённых строках: как ошибка, если они блокируют процесс, и как предупреждение, если лишь фиксируются.

Если проверка блокирует задачу, агент разработчика получает каждую блокирующую находку, например src/pricing.tsx:7 hardcoded_text: “Simple pricing”, вместе с инструкцией по её устранению. Для исправления переводов для задачи запускается сессия перевода; Никогда не редактируются вручную каталоги других языков. Текст переносится в исходный каталог, составные предложения переписываются в одно сообщение с плейсхолдерами, а правила кода применяются к собственным изменениям перед передачей задачи дальше.

Вклады из любых источников#

Проверка обеспечивает единый стандарт для всех изменений, независимо от автора:

• Coroid's agents В рамках проекта с поддержкой интернационализации в каждой задаче указываются исходный каталог, функция перевода, одно сообщение на один предложение, форматтер проекта, логическое отображение для языков с письмом справа налево и нормы рынков из Culture.
• Pull-запросы от людей и других инструментов проходят проверку через Coroid Check с теми же Результатами и аннотациями. Включите Проводите рецензирование каждого PR чтобы запустить его на каждом pull request.
• Изменения, влитые без прохождения проверки выявляются после слияния. Переведите строки, влитые вне Coroid считывает результаты проверки, выполненной на pull request. При обнаружении отсутствующих или устаревших строк он создает задачу на перевод. Если проверка выявила блокирующие код Проверки, также создается задача под названием Обеспечьте интернационализацию влитого кода в pull request, указывая места для поиска. На каждое слияние приходится не более одной задачи каждого типа.

Существующий код никогда не блокируется: Готовность к работе в глобальном масштабе перечисляет их и создает задачи на исправление, которые вы можете запустить по собственному выбору.

Запустите его самостоятельно#

Движок представляет собой инструмент командной строки coroid-i18n, версия которого указана в вашем файле конфигурации:

coroid-i18n check                       # catalogues
coroid-i18n source --changed main       # the code a branch adds since main
coroid-i18n check --source --changed main

source считывает код, не обращаясь к каталогам, поэтому он работает даже тогда, когда они еще не настроены. Без --changed или --diff он считывает весь репозиторий. Обе команды завершаются с кодом возврата 1 при обнаружении ошибок; добавьте --format json для получения отчета в машиночитаемом формате.

Связанное#

• Глобализация
• Дизайн для любого рынка
• Псевдо-Локализация
• Готовность к работе в глобальном масштабе и учёт культурных особенностей
• Политики обеспечения качества и контрольные этапы
• Проверки, их выполнение и Результаты