Integração com Frameworks
Configuração passo a passo do champollion com frameworks populares.
- Hugo
- Next.js (next-intl)
- React (react-i18next)
Hugo (TOML / YAML / Markdown)
Estrutura do Projeto
Hugo usa i18n/ para traduções de strings e content/ para conteúdo de páginas:
my-hugo-site/
├── i18n/
│ ├── en.toml ← source of truth
│ ├── fr.toml
│ └── ja.toml
├── content/
│ ├── posts/
│ │ ├── hello.md ← source (English)
│ │ ├── hello.fr.md
│ │ └── hello.ja.md
│ └── about.md
└── .env.local
Configuração
npm install --save-dev champollion
{
"version": 3,
"inputLocale": "en",
"localesDir": "./i18n",
"contentDir": "./content",
"format": "auto",
"languages": ["fr", "de", "ja", "es", "ko", "zh"]
}
champollion sync # sync i18n string files + content files
champollion sync --dry # preview changes without writing
Detalhes da Tradução de Conteúdo
Front matter: Suporta delimitadores YAML (---) e TOML (+++). Traduz title, description, summary, subtitle, caption e linkTitle por padrão. Todos os outros campos (date, draft, tags, weight, slug, etc.) são preservados. Personalize com translatableFields na sua configuração.
Proteção de blocos: Blocos de código, shortcodes do Hugo, código inline e HTML bruto são automaticamente protegidos usando placeholders sentinela Unicode. Eles passam intactos.
Convenção de nome de arquivo: Segue o padrão de tradução por nome de arquivo do Hugo:
my-post.md→my-post.fr.mdmy-post.en.md→my-post.fr.md(remove sufixo de origem)
Pular existentes: Arquivos traduzidos existentes nunca são sobrescritos. Delete um arquivo de destino para forçar uma retradução.
Formas Plurais
Locales TOML e YAML suportam formas plurais CLDR:
[items]
one = "{{ .Count }} item"
other = "{{ .Count }} items"
Representadas internamente como items.one e items.other para diff, depois re-serializadas para o formato seccionado correto na escrita.
next-intl (JSON)
Estrutura do Projeto
my-app/
├── messages/
│ └── en.json ← source of truth
├── src/
│ ├── i18n/
│ │ ├── routing.ts
│ │ └── request.ts
│ └── middleware.ts
└── .env.local
Configuração
npm install --save-dev champollion
{
"version": 3,
"inputLocale": "en",
"localesDir": "./messages",
"languages": ["fr", "de", "ja", "es", "ko", "zh", "pt", "ar"]
}
npx champollion sync
Cria messages/fr.json, messages/ja.json, etc. — totalmente traduzidos, preservando sua estrutura de chaves aninhadas. next-intl os detecta automaticamente.
Fluxo de Trabalho de Desenvolvimento
{
"scripts": {
"dev": "champollion watch & next dev",
"i18n:sync": "champollion sync",
"i18n:audit": "champollion audit"
}
}
react-i18next (JSON)
Estrutura de Arquivo Plano (recomendado)
locales/
├── en.json
├── fr.json
└── ja.json
{
"version": 3,
"inputLocale": "en",
"localesDir": "./locales",
"languages": ["fr", "de", "ja"]
}
npx champollion sync
Estrutura de Diretório Aninhado
Se você usar a estrutura {locale}/{namespace}.json, crie um script de sincronização para achatar → traduzir → desachatar. Veja a documentação do react-i18next para detalhes.