Konfiguratioun · Ressource-Übersetzer

Iwwerschreif de Wee mat der configPath Input, wanns de eng net-standardméisseg Plaz brauchs.

Schema

# .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.*"

Feldreferenz

provider

Typ: "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

Typ: string

Fällt zeréck op den sourceLocale Input, wann en net gesat ass. Och als from=<locale> un den Translator weidergeleet, sou datt kuerz Strings net automatesch erkannt ginn.

toLocales

Typ: string[]

Entweder eng Array oder eng komma-getrennt String.

include / exclude

Typ: string[]

Glob-Muster ginn am Verglach mat absoluten an Aarbechtsplazen-relativen Weeër evaluéiert.

glossary

Typ: map<string,string>

No der Iwwersetzung iwwerschreift de Begrëff. Wuertgrenzbewosst (behandelt C++, .NET).

categoryId

Typ: string

Azure Custom Translator Kategorie — Äre Industrie-/Domain-Knäppchen (juristesch, medezinesch, Marketing-Toun, asw.). Geschéckt als ?category=....

textType

Typ: "plain" | "html"

Standardméisseg plain. Benotzt html nëmmen, wann Är Ressourcewäerter richteg HTML-Fragmenter enthalen.

profanityAction

Typ: "NoAction" | "Marked" | "Deleted"

Wéi een profan Ausdréck an iwwersaten Output behandelt.

profanityMarker

Typ: "Asterisk" | "Tag"

Nëmmen bedeitend wann profanityAction "Marked" ass.

allowFallback

Typ: boolean

Setzt op false fir d'Iwwersetzung ze feelen, wann deng categoryId keng Deployéierung fir eng Zilplaz huet, amplaz op de generelle Modell zréckzefalen.

apiVersion

Typ: string

Translator REST API Versioun. Standardméisseg 3.0.

awsFormality

Typ: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Typ: boolean

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

awsTerminologyNames / awsParallelDataNames

Typ: string[]

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

googleModel

Typ: string

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

googleApiEndpoint

Typ: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Typ: boolean

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

maxRetries

Typ: integer

Maximal Retry-Versich op transient HTTP-Äntwerten (408, 425, 429, 500, 502, 503, 504). Standardméisseg 5. D'Zuel vun HTTP-Uruff pro Ufro ass 1 + maxRetries.

retryBackoffMs

Typ: integer

Cap (ms) op all eenzelen Backoff-Schlof. Standardméisseg 30000. Azure säi Retry-After Header gëtt genee dann respektéiert, wann en do ass; soss gëtt e jittered exponentiellen Backoff benotzt, deen op dësem Wäert limitéiert ass.

protectPlaceholders

Typ: boolean

Standardméisseg true. Wann se op sinn, ginn Token wéi {{name}}, ${var}, {0}, {0:N2}, %s, %1$s an HTML-Entitéiten virun der Iwwersetzung duerch Sentinel-Token ersat a spéider erëm restauréiert. Deaktivéiert nëmmen, wann d'Quell bewosst Plazhalter-ähnlech Literaler enthält.

customPlaceholderPatterns

Typ: string[]

Zousätzlech Regex-Muster (ouni Delimiter), déi zum Standard-Platzhalter-Set derbäigesat goufen, z.B. <<.+?>> fir personaliséiert Token-Syntax. Ongëlteg Regexen ginn ignoréiert.

noTranslatePatterns

Typ: string[]

Glob-Mustere goufen mat Parser-Niveau Schlësselen ofgestëmmt (JSON gepunktete Wee, RESX name, PO msgid, XLIFF Eenheet id, INI/restext Schlëssel). Passend Schlësselen ginn aus der Ufro erausgeholl a ginn duerch, mat hirem Quellwäert erhalen.

changeDetection

Typ: "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

Typ: string

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

Luedreiefolleg

D'Aktioun liest explizit Inputen aus dem Workflow.
Et lued d'YAML-Konfiguratioun vun configPath.
Fir all gedeelt Feld gewënnt den Input; soss gëtt de YAML-Wäert benotzt.
Déi fusionéiert Wäerter ginn validéiert. Ongëlteg Enums (z.B. profanityAction: Mask) verursaachen, datt d'Aktioun séier mat enger kloerer Noriicht feelt.

Ton an Industrie, einfach gesot

D'Azure AI Translator v3 API huet kee eenzege Tounknäppchen. Zwee Astellungen kombinéieren sech fir Iech déi meescht vun der selwechter Kontroll ze ginn:

Industrie / Domain: benotzt categoryId fir op eng Azure Custom Translator Kategorie ze weisen, déi op Ärem eegene Korpus trainéiert ass — juristesch, technesch, medezinesch, Marketing oder eppes anescht. Dëst ass dee staarkste Hebel fir Toun, Markestëmm a Vokabular.
Uewerflächtext: Benotzt d'Glossar fir Markennimm a Produktbegrëffer wuertwiertlech ze spären, a benotzt profanityAction fir profan Begrëffer ze läschen, wann Dir d'Lokalisatioun fir jonk Publikum zielt.

Wielt Är Sprooch

Repository-Konfiguratioun

Schema

Feldreferenz

Luedreiefolleg

Ton an Industrie, einfach gesot