Configuración · Tradutor de recursos

Anula o camiño coa entrada configPath se precisas unha localización non predeterminada.

Esquema

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

Referencia de campo

provider

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

Tipo: string

Volve á entrada sourceLocale se non está activada. Tamén se reenvia a Tradutor como from=<locale> para que as cadeas curtas non se detecten automaticamente.

toLocales

Tipo: string[]

Ou un array ou unha cadea separada por comas.

include / exclude

Tipo: string[]

Patróns de globos avaliados fronte a camiños absolutos e relativos ao espazo de traballo.

glossary

Tipo: map<string,string>

Anulacións de termos post-tradución. Consciente da fronteira de palabras (manexa C++, .NET).

categoryId

Tipo: string

Azure Custom Translator categoría — a túa perilla de industria/dominio (legal, médica, ton de marketing, etc.). Enviado como ?category=....

textType

Tipo: "plain" | "html"

Por defecto é plain. Usa html só se os valores dos teus recursos conteñen fragmentos HTML reais.

profanityAction

Tipo: "NoAction" | "Marked" | "Deleted"

Como tratar termos profanos na saída traducida.

profanityMarker

Tipo: "Asterisk" | "Tag"

Só ten sentido cando profanityAction é "Marked".

allowFallback

Tipo: boolean

Configúrase para false falle a tradución cando o teu categoryId non teña despregamento para unha localización obxectivo en vez de volver ao modelo xeral.

apiVersion

Tipo: string

Versión da API REST do tradutor. Por defecto é 3.0.

awsFormality

Tipo: "FORMAL" | "INFORMAL"

AWS Translate formality setting for supported target languages.

awsBrevity

Tipo: boolean

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

awsTerminologyNames / awsParallelDataNames

Tipo: string[]

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

googleModel

Tipo: string

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

googleApiEndpoint

Tipo: string

Optional Google Cloud Translation API endpoint override.

googleAutoRetry

Tipo: boolean

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

maxRetries

Tipo: integer

Máximo de intentos de reintento en respostas HTTP transitorias (408, 425, 429, 500, 502, 503, 504). Por defecto é 5. O total de chamadas HTTP por solicitude é 1 + maxRetries.

retryBackoffMs

Tipo: integer

Límite (ms) en calquera sono de retroceso individual. Por defecto é 30000. A cabeceira Retry-After de Azure honrase exactamente cando está presente; doutra maneira, utilízase un retroceso exponencial con jitter, limitado a este valor.

protectPlaceholders

Tipo: boolean

Por defecto é true. Cando están activados, tokens como {{name}}, ${var}, {0}, {0:N2}, %s, %1$s e HTML substitúense por tokens sentinel antes da tradución e restabrávanse despois. Desactiva só cando a fonte contén intencionadamente literais en forma de marcador de posición.

customPlaceholderPatterns

Tipo: string[]

Patróns regex adicionais (sen delimitadores) engadidos ao conxunto predeterminado de marcadores, por exemplo, <<.+?>> para sintaxe personalizada de tokens. Ignóranse as regex inválidas.

noTranslatePatterns

Tipo: string[]

Os patróns glob coincidían con claves a nivel de analizador (camiño punteado JSON, name RESX, msgid PO, id da unidade XLIFF, clave INI/restext). As claves coincidentes pérdense da solicitude e pasan mantendo o seu valor de orixe.

changeDetection

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

Tipo: string

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

Orde de carga

A acción le entradas explícitas do fluxo de traballo.
Carga a configuración YAML desde configPath.
Para cada campo compartido, a entrada gaña; se non, úsase o valor YAML.
Os valores combinados son validados. Enums inválidos (por exemplo, profanityAction: Mask) fan que a acción falle rapidamente cunha mensaxe clara.

Ton e industria, en termos claros

A API Azure AI Translator v3 non ten un único botón de ton. Dúas configuracións combinadas che dan a maior parte do mesmo control:

Industria / dominio: usa categoryId para sinalar unha categoría de Azure Custom Translator adestrada co teu propio corpus — legal, técnico, médico, de marketing ou calquera outra cousa. Esta é a palanca máis forte para o ton, a voz da marca e o vocabulario.
Texto superficial: Usa o Glosario para bloquear nomes de marcas e termos de produto literalmente, e usa profanityAction para eliminar termos profanes cando se dirixe á localización para públicos máis novos.

Elixe a túa lingua

Configuración do repositorio

Esquema

Referencia de campo

Orde de carga

Ton e industria, en termos claros