Preservação de Chaves

Max PrilutskiyCEO e cofundadorAtualizado em: há 3 meses · 1 min de leitura

Descontinuado

Esta documentação abrange a CLI antiga (v0). A versão atual da CLI é a v1. Ver a documentação atual da CLI

As chaves preservadas são inicializadas uma única vez com os valores de origem e depois protegidas contra atualizações automáticas. A CLI nunca as substitui — funcionam como marcadores de posição para conteúdo que exige tradução manual, como texto jurídico, conteúdo de conformidade ou slogans de marketing.

Configuração#

Adicione preservedKeys a um bucket em i18n.json:

json
{
  "buckets": {
    "json": {
      "include": ["locales/[locale].json"],
      "preservedKeys": ["legal/privacy", "legal/terms"]
    }
  }
}

Como funciona#

Considere este ficheiro de origem:

json
{
  "welcome": "Welcome to our platform",
  "legal": {
    "privacy": "We respect your privacy and protect your data.",
    "terms": "By using this service, you agree to our terms."
  }
}

Na primeira execução, a CLI copia as chaves preservadas tal como estão, enquanto traduz tudo o resto:

json
// locales/es.json (first run)
{
  "welcome": "Bienvenido a nuestra plataforma",
  "legal": {
    "privacy": "We respect your privacy and protect your data.",
    "terms": "By using this service, you agree to our terms."
  }
}

Depois de traduzir manualmente a secção jurídica, as execuções seguintes da CLI mantêm as suas traduções intactas.

Preservação de Chaves vs. Bloqueio de Chaves#

Preservação de ChavesBloqueio de Chaves
Valor inicialValor de origem como marcador de posiçãoValor de origem (sempre)
Edições manuaisPreservadas permanentementeSubstituídas pelo valor de origem em cada execução
Caso de usoConteúdo jurídico, conformidade, tradução manualNomes de marcas, IDs técnicos

Notação de caminho de chave#

Use a barra (/) para chaves aninhadas e o asterisco (*) para wildcards:

json
{ "preservedKeys": ["legal/*", "marketing/tagline"] }

Próximos passos#