Vérifier les traductions avec pre-commit

Le hook

Sauvegardez-le sous .pre-commit-config.yaml à la racine du projet. C'est un hook local : pre-commit construit son propre environnement et y installe kaeris depuis PyPI, donc rien d'autre n'a besoin d'être installé. files le limite aux commits qui mettent en scène quelque chose sous 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

Ce qu'un commit affiche

À gauche : un commit avec des fichiers qui sont corrects. À droite : un commit avec de.json qui a {nam} au lieu de {name} et la clé checkout manquante ; le commit est refusé.

$ 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

Un commit qui ne touche aucun fichier de langue

Le hook est ignoré, donc les commits non liés restent rapides.

$ 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. Ajouter le hook

   Enregistrez la configuration ci-dessus sous .pre-commit-config.yaml et définissez vos propres --source et --langs. Conservez la version épinglée et augmentez-la lors de la mise à niveau.

2. Installer le hook git

   Exécutez pip install pre-commit puis pre-commit install une fois par clone.

3. Commit comme d'habitude

   Un commit qui met en staging un fichier sous locales/ exécute la vérification et est refusé en cas d'échec. pre-commit run --all-files exécute la même vérification à la demande, par exemple dans CI.

• Ce qui a été exécuté

  pre-commit 4.7.0 avec exactement la configuration ci-dessus dans un dépôt git vierge : pre-commit install, puis un vrai git commit s'exécute. L'environnement du hook a été construit à partir de PyPI (kaeris 0.2.35). Fichiers valides : le commit a réussi. Fichier de.json corrompu : le hook a échoué avec le code de sortie 1 et git a refusé le commit. Un commit sans fichier de langue : ignoré.

• Ce qui n'a pas été exécuté

  Une tâche CI qui appelle pre-commit run --all-files n'a pas été exécutée sur un runner. Il n'y a pas de dépôt de hook publié pour kaeris, donc la recette utilise un hook local ; il n'y a pas de ligne repo: https://github.com/… à ajouter.

• Échouer aussi sur les clés obsolètes

  --strict échoue également lorsqu'une traduction a des clés que la source n'a plus.

• Conserver les noms de marque tels quels

  --glossary 'KAERIS,GitHub' fait échouer une cible qui a supprimé l'un des termes. La même liste peut se trouver sous keep dans kaeris.json.

• Disposition de fichiers différente

  --out est le dossier contenant les traductions et --pattern '{lang}/common.json' leurs noms de fichiers. Par défaut : la disposition que kaeris translate écrit.

• Aucun drapeau du tout

  Avec un fichier kaeris.json dans le projet (kaeris init en écrit un), kaeris check récupère la source, les langues et le dossier à partir de celui-ci.

Autres recettes : GitHub Actions · GitLab CI · Scripts Make et npm

Référence CLI · Référence Check · Référence GitHub Action · Vérification gratuite dans le navigateur · Traduction dans le navigateur