Check translations with pre-commit

The hook

Save it as .pre-commit-config.yaml in the project root. It is a local hook: pre-commit builds its own environment and installs kaeris from PyPI into it, so nothing else has to be installed. files limits it to commits that stage something under locales/.

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

What a commit prints

Left: a commit with files that are fine. Right: a commit with de.json that has {nam} instead of {name} and the checkout key missing; the commit is refused.

$ 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

A commit that touches no locale file

The hook is skipped, so unrelated commits stay fast.

$ 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. Add the hook

   Save the config above as .pre-commit-config.yaml and set your own --source and --langs. Keep the version pin and raise it when you upgrade.

2. Install the git hook

   Run pip install pre-commit and then pre-commit install once per clone.

3. Commit as usual

   A commit that stages a file under locales/ runs the check and is refused when it fails. pre-commit run --all-files runs the same check on demand, for example in CI.

• What ran

  pre-commit 4.7.0 with exactly the config above in a fresh git repository: pre-commit install, then real git commit runs. The hook environment was built from PyPI (kaeris 0.2.35). Good files: the commit went through. Broken de.json: the hook failed with exit code 1 and git refused the commit. A commit with no locale file: skipped.

• What did not run

  A CI job that calls pre-commit run --all-files was not run on a runner. There is no published hook repository for kaeris, so the recipe uses a local hook; there is no repo: https://github.com/… line to add.

• Fail on stale keys too

  --strict also fails when a translation has keys that the source no longer has.

• Keep brand names as written

  --glossary 'KAERIS,GitHub' fails a target that dropped one of the terms. The same list can live under keep in kaeris.json.

• Different file layout

  --out is the folder with the translations and --pattern '{lang}/common.json' their file names. Default: the layout kaeris translate writes.

• No flags at all

  With a kaeris.json in the project (kaeris init writes one), kaeris check takes the source, languages and folder from it.

Other recipes: GitHub Actions · GitLab CI · Make and npm scripts

CLI reference · Check reference · GitHub Action reference · Free check in the browser · Translate in the browser