Konfigurazzjoni · Traduttur tar-Riżorsi

Ikkontrolla t-triq bl-input tal-configPath jekk għandek bżonn post mhux default.

Skema

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

Referenza fil-qasam

provider

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

Tip: string

Jirritorna għall-sourceLocale input jekk ma jkunx issettjat. Ukoll mibgħuta lil Translator bħala from=<locale> sabiex strings qosra ma jiġu awtoskettati.

toLocales

Tip: string[]

Jew array jew stringa separata minn koma.

include / exclude

Tip: string[]

Mudelli glob evalwati kontra toroq assoluti u relattivi għall-ispazju tax-xogħol.

glossary

Tip: map<string,string>

Overrides ta' termini wara t-traduzzjoni. Konxju tal-limiti tal-kliem (jimmaniġġja C++, .NET).

categoryId

Tip: string

Azure Custom Translator kategorija — il-knob tal-industrija/dominju tiegħek (legali, mediċi, ton kummerċjali, eċċ.). Mibgħut bħala ?category=....

textType

Tip: "plain" | "html"

Jiddependi għal plain. Uża html biss jekk il-valuri tar-riżorsi tiegħek fihom frammenti HTML reali.

profanityAction

Tip: "NoAction" | "Marked" | "Deleted"

Kif tittratta termini profani f'output tradotti.

profanityMarker

Tip: "Asterisk" | "Tag"

Sens biss meta profanityAction tkun "Marked".

allowFallback

Tip: boolean

Issettja għal false li tfalli t-traduzzjoni meta l-categoryId tiegħek m'għandux implimentazzjoni għal lokalità fil-mira minflok terġa' lura għall-mudell ġenerali.

apiVersion

Tip: string

Verżjoni tal-API REST tat-traduttur. Jiddependi għal 3.0.

awsFormality

Tip: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Tip: boolean

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

awsTerminologyNames / awsParallelDataNames

Tip: string[]

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

googleModel

Tip: string

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

googleApiEndpoint

Tip: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Tip: boolean

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

maxRetries

Tip: integer

Tentattivi massimi ta' retry fuq risposti HTTP transitorji (408, 425, 429, 500, 502, 503, 504). Jiddependi għal 5. It-total ta' sejħiet HTTP għal kull talba huwa 1 + maxRetries.

retryBackoffMs

Tip: integer

Limit (ms) fuq kull waħda waħda ta' backoff. Jiddependi għal 30000. L-intestatura Retry-After ta' Azure tiġi onorata eżattament meta tkun preżenti; inkella jintuża jittered exponential backoff, limitat għal dan il-valur.

protectPlaceholders

Tip: boolean

Jiddependi għal true. Meta jkunu attivi, tokens bħal {{name}}, ${var}, {0}, {0:N2}, %s, %1$s u entitajiet HTML jiġu sostitwiti b'tokens sentinel qabel it-traduzzjoni u jiġu restawrati wara. Idiżattivaw biss meta s-sors intenzjonalment fih letterali f'forma ta' placeholder.

customPlaceholderPatterns

Tip: string[]

Mudelli regex żejda (mingħajr delimitaturi) miżjuda mas-sett default, eż. <<.+?>> għal sintassi personalizzata ta' token. Regex invalidi jiġu injorati.

noTranslatePatterns

Tip: string[]

Il-mudelli Glob kienu jaqblu ma' ċwievet ta' livell ta' parser (JSON dotted path, RESX name, PO msgid, unità XLIFF id, ċavetta INI/restext). Il-keys li jaqblu jitneħħew mit-talba u jgħaddu permezz tal-valur tas-sors tagħhom ippreservat.

changeDetection

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

Tip: string

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

Ordni tat-tagħbija

L-azzjoni taqra inputs espliciti mill-fluss tax-xogħol.
Jħaddem il-konfigurazzjoni YAML minn configPath.
Għal kull qasam kondiviż, l-input jirbaħ; inkella jintuża l-valur YAML.
Il-valuri magħquda jiġu vvalidati. Enums invalidi (eż. profanityAction: Mask) jikkawżaw li l-azzjoni tfalli malajr b'messaġġ ċar.

Ton u industrija, b'mod ċar

L-API Azure AI Translator v3 m'għandhiex knob wieħed tat-ton. Żewġ settings flimkien jagħtuk l-istess kontroll:

Industrija / dominju: uża categoryId biex tindika kategorija ta' Azure Custom Translator mħarrġa fuq il-korpus tiegħek stess — legali, tekniċi, mediċi, kummerċjali, jew xi ħaġa oħra. Dan huwa l-aktar lever b'saħħtu għat-ton, il-vuċi tal-marka, u l-vokabularju.
Test tal-wiċċ: Uża l-Glossarju biex tgħaqqad ismijiet ta' marki u termini tal-prodott littera għal oħra, u uża profanityAction biex tneħħi t-termini profani meta tiffoka fuq lokalizzazzjoni għal udjenzi iżgħar.

Agħżel il-lingwa tiegħek

Konfigurazzjoni tar-repożitorju

Skema

Referenza fil-qasam

Ordni tat-tagħbija

Ton u industrija, b'mod ċar