Preservação de chaves

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

Obsoleto

Esta documentação cobre o CLI legado (v0). O CLI atual é o v1. Veja a documentação atual da CLI

As chaves preservadas são inicializadas uma única vez com os valores de origem e depois ficam protegidas contra atualizações automáticas. A CLI nunca as sobrescreve — elas funcionam como placeholders para conteúdo que exige tradução manual, como textos jurídicos, 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 arquivo 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 como estão e traduz todo o restante:

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 que você traduz manualmente a seção jurídica, as execuções seguintes da CLI mantêm suas traduções intactas.

Preservação de chaves vs. Key Locking#

Preservação de chavesKey Locking
Valor inicialValor de origem como placeholderValor de origem (sempre)
Edições manuaisPreservadas permanentementeSobrescritas pelo valor de origem em cada execução
Caso de usoJurídico, conformidade, tradução manualNomes de marca, IDs técnicos

Notação de caminho de chave#

Use barra (/) para chaves aninhadas e asterisco (*) para curingas:

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

Próximos passos#