Конфігурація · Перекладач ресурсів

Перезапишіть шлях за допомогою configPath входу, якщо потрібне нестандартне місцезнаходження.

Схема

# .github/resource-translator.yml
sourceLocale: en

# Provider config can be nested. Keep secrets in workflow inputs; use repo
# config for non-secret defaults like region, model, formality, or category.
provider:
  azure:
    categoryId: my-custom-translator-category
    apiVersion: "3.0"
    allowFallback: true

toLocales:
  - fr
  - de
  - es
include:
  - "src/**/*.en.json"
  - "apps/**/*.en.resx"
exclude:
  - "**/__tests__/**"
glossary:
  Acme: Contoso
  Octocat: Octocat   # keep brand names verbatim

# Translator request shape — most users can ignore these.
textType: plain                  # plain | html
profanityAction: NoAction        # NoAction | Marked | Deleted
profanityMarker: Asterisk        # Asterisk | Tag (only when profanityAction == Marked)

# Resilience — Translator returns 429 under load. Defaults are usually
# fine; tune only if your runs are large enough to hit them.
maxRetries: 5
retryBackoffMs: 30000             # cap on any single backoff sleep (ms)

# Placeholder protection. ON by default — wraps tokens like {{name}},
# {0}, %s, ${var} into sentinels before translation and restores them
# on the way back. Set false only when source intentionally contains
# placeholder-shaped literals.
protectPlaceholders: true
customPlaceholderPatterns:
  - "<<.+?>>"                     # any extra token syntax you use

# Per-key opt-out. Keys matching any glob are dropped from the request
# and pass through with the source value preserved.
noTranslatePatterns:
  - "errors.code.*"
  - "brands.*"

Польова довідка

provider

Тип: "azure" | "aws" | "google" | provider block

Either a provider string or a nested provider block (provider.azure, provider.aws, or provider.google). Prefer nested blocks for provider-specific settings; keep secrets in workflow inputs rather than committed config.

sourceLocale

Тип: string

Повертається до sourceLocale входу, якщо не встановлено. Також переадресовано на Translator як from=<locale>, щоб короткі рядки не визначалися автоматично.

toLocales

Тип: string[]

Або масив, або рядок, розділений комами.

include / exclude

Тип: string[]

Глоб-патерни оцінювалися за абсолютними та відносними до робочого простору траєкторії.

glossary

Тип: map<string,string>

Перевизначення термінів після перекладу. Обізнаний про межі слів (обробляє C++, .NET).

categoryId

Тип: string

Azure Custom Translator категорія — ваш регулятор галузі/домену (юридичний, медичний, маркетинговий тон тощо). Надіслано як ?category=....

textType

Тип: "plain" | "html"

За замовчуванням plain. Використовуйте html лише якщо ваші значення ресурсу містять реальні HTML-фрагменти.

profanityAction

Тип: "NoAction" | "Marked" | "Deleted"

Як ставитися до нецензурних термінів у перекладеному матеріалі.

profanityMarker

Тип: "Asterisk" | "Tag"

Це має сенс лише тоді, коли profanityAction "Marked".

allowFallback

Тип: boolean

Встановіть false для невдалого перекладу, коли ваш categoryId не має розгортання для цільової локації, замість того щоб повертатися до загальної моделі.

apiVersion

Тип: string

Версія REST API перекладача. За замовчуванням 3.0.

awsFormality

Тип: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Тип: boolean

Set to true to enable AWS Translate brevity mode for supported language pairs.

awsTerminologyNames / awsParallelDataNames

Тип: string[]

AWS Translate custom terminology and parallel data resource names. Either an array or comma-separated string.

googleModel

Тип: string

Google Cloud Translation model, e.g. nmt or base.

googleApiEndpoint

Тип: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Тип: boolean

Optional Google Cloud Translation automatic retry toggle. Leave unset to use the Google client default.

maxRetries

Тип: integer

Максимальна кількість повторних спроб для тимчасових HTTP-відповідей (408, 425, 429, 500, 502, 503, 504). За замовчуванням 5. Загальна кількість HTTP-дзвінків на запит становить 1 + maxRetries.

retryBackoffMs

Тип: integer

Ліміт (мс) на будь-якому одному відступному сні. За замовчуванням 30000. Заголовок Azure Retry-After вшановується саме тоді, коли він присутній; інакше використовується експоненціальне відскокування з обмеженням на цьому значенні.

protectPlaceholders

Тип: boolean

За замовчуванням true. Коли токени ввімкнені, такі як {{name}}, ${var}, {0}, {0:N2}, %s, %1$s та HTML-сутності, замінюються на токени Sentinel перед перекладом і відновлюються після цього. Вимкніть лише тоді, коли джерело навмисно містить тимчасові літерали.

customPlaceholderPatterns

Тип: string[]

Додаткові шаблони regex (без розділівників) додаються до стандартного набору заповнювачів, наприклад, <<.+?>> для синтаксису кастомних токенів. Некоректні виключні виключі ігноруються.

noTranslatePatterns

Тип: string[]

Шаблони Glob співставлялися з ключами рівня парсера (JSON пунктирний шлях, RESX name, PO msgid, XLIFF unit id, INI/restext key). Відповідні ключі відкидаються із запиту і проходять із збереженням їхнього вихідного значення.

changeDetection

Тип: "smart" | "disabled"

Defaults to smart. Uses the committed state manifest to translate only changed or missing parser keys. Set to disabled or false to preserve the legacy always-translate behavior.

statePath

Тип: string

Path to the deterministic smart change-detection state manifest. Defaults to .github/resource-translator-state.json.

Порядок завантаження

Дія зачитує явні введення з робочого процесу.
Він завантажує конфігурацію YAML з configPath.
Для кожного спільного поля виграє вхід; інакше використовується значення YAML.
Об'єднані значення перевіряються. Некоректні enums (наприклад, profanityAction: Mask) призводять до швидкої невдачі дії з чітким повідомленням.

Тон і індустрія, простими словами

Azure AI Translator v3 API не має єдиної ручки тону. Два режими разом дають майже однаковий контроль:

Галузь / домен: використовуйте categoryId, щоб вказати на категорію Azure Custom Translator, навчену на власному корпусі — юридичному, технічному, медичному, маркетинговому чи будь-чому іншому. Це найсильніший важіль для тону, брендового голосу та словникового запасу.
Поверхневий текст: Використовуйте Глосарій, щоб дослівно закріпити назви брендів і терміни продукту, а також використовуйте profanityAction для видалення нецензурних термінів при таргетингу локалізації для молодшої аудиторії.

Обирайте свою мову

Конфігурація репозиторію

Схема

Польова довідка

Порядок завантаження

Тон і індустрія, простими словами