Verifique traduções com pre-commit

O hook

Salve como .pre-commit-config.yaml na raiz do projeto. É um hook local: pre-commit constrói seu próprio ambiente e instala kaeris do PyPI nele, então nada mais precisa ser instalado. files limita a commits que adicionam algo em locales/ ao stage.

repos:
  - repo: local
    hooks:
      - id: kaeris-check
        name: kaeris check (translations)
        entry: kaeris check --source locales/en.json --langs de,fr --ci
        language: python
        additional_dependencies: ["kaeris==0.2.35"]
        files: ^locales/
        pass_filenames: false

O que um commit imprime

À esquerda: um commit com arquivos corretos. À direita: um commit com de.json que tem {nam} em vez de {name} e a chave checkout ausente; o commit é recusado.

$ git commit -m "add locales"
kaeris check (translations)..............................................Passed
[main (root-commit) 96c8a87] add locales
 4 files changed, 25 insertions(+)
 create mode 100644 .pre-commit-config.yaml
 create mode 100644 locales/de.json
 create mode 100644 locales/en.json
 create mode 100644 locales/fr.json
exit code: 0

$ git commit -m "break de"
kaeris check (translations)..............................................Failed
- hook id: kaeris-check
- exit code: 1

✗ de: 1 missing key(s): checkout
✗ de: 1 placeholder mismatch(es):
    greeting: missing ['{name}'], added ['{nam}']
✗ de: 2 translation fault(s):
    greeting: lost placeholder {name}
    greeting: invented placeholder {nam} (not in source)
✓ fr: complete & placeholder-safe
✗ 1 missing key, 1 placeholder mismatch, 2 translation faults

exit code: 1

Um commit que não altera arquivo de localidade

O hook é ignorado, então commits não relacionados continuam rápidos.

$ git commit -m "readme"   # nothing under locales/ is staged
kaeris check (translations)..........................(no files to check)Skipped
[main e82b41d] readme
 1 file changed, 1 insertion(+)
 create mode 100644 README.md
exit code: 0

1. Adicione o hook

   Salve a configuração acima como .pre-commit-config.yaml e defina seu próprio --source e --langs. Mantenha a versão fixa e atualize-a quando fizer upgrade.

2. Instale o git hook

   Execute pip install pre-commit e depois pre-commit install uma vez por clone.

3. Faça commits normalmente

   Um commit que adiciona um arquivo dentro de locales/ executa a verificação e é recusado se falhar. pre-commit run --all-files executa a mesma verificação sob demanda, por exemplo, em CI.

• O que foi executado

  pre-commit 4.7.0 com exatamente a configuração acima em um repositório git novo: pre-commit install, depois execuções reais de git commit. O ambiente do hook foi construído a partir do PyPI (kaeris 0.2.35). Arquivos bons: o commit foi aceito. de.json com erro: o hook falhou com código de saída 1 e o git recusou o commit. Commit sem arquivo de localidade: ignorado.

• O que não foi executado

  Um job de CI que chama pre-commit run --all-files não foi executado em um runner. Não há repositório de hook publicado para kaeris, então a receita usa um hook local; não há linha repo: https://github.com/… para adicionar.

• Falhar também em chaves obsoletas

  --strict também falha quando uma tradução tem chaves que a fonte não possui mais.

• Mantenha nomes de marcas como estão

  --glossary 'KAERIS,GitHub' falha se um termo for removido no destino. A mesma lista pode ficar em keep no kaeris.json.

• Layout de arquivo diferente

  --out é a pasta com as traduções e --pattern '{lang}/common.json' seus nomes de arquivo. Padrão: o layout que kaeris translate gera.

• Sem flags

  Com um kaeris.json no projeto (kaeris init cria um), kaeris check usa a fonte, idiomas e pasta definidos nele.

Outras receitas: GitHub Actions · GitLab CI · Make e scripts npm

Referência CLI · Referência Check · Referência GitHub Action · Check gratuito no navegador · Traduzir no navegador