Controlla le traduzioni con pre-commit

L'hook

Salvalo come .pre-commit-config.yaml nella root del progetto. È un hook locale: pre-commit costruisce il proprio ambiente e installa kaeris da PyPI al suo interno, quindi non è necessario installare altro. files lo limita ai commit che mettono in stage qualcosa sotto 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

Cosa stampa un commit

A sinistra: un commit con file corretti. A destra: un commit con de.json che ha {nam} invece di {name} e la chiave checkout mancante; il commit viene rifiutato.

$ 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 che non tocca alcun file di localizzazione

L'hook viene saltato, quindi i commit non correlati rimangono veloci.

$ 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. Aggiungi l'hook

   Salva la configurazione sopra come .pre-commit-config.yaml e imposta i tuoi --source e --langs. Mantieni il pin della versione e aumentalo quando aggiorni.

2. Installa l'hook git

   Esegui pip install pre-commit e poi pre-commit install una volta per clone.

3. Esegui il commit come al solito

   Un commit che aggiunge un file sotto locales/ esegue il controllo e viene rifiutato quando fallisce. pre-commit run --all-files esegue lo stesso controllo su richiesta, ad esempio in CI.

• Cosa è stato eseguito

  pre-commit 4.7.0 con esattamente la configurazione sopra in un repository git nuovo: pre-commit install, poi il vero git commit viene eseguito. L'ambiente dell'hook è stato creato da PyPI (kaeris 0.2.35). File corretti: il commit è andato a buon fine. de.json errato: l'hook è fallito con codice di uscita 1 e git ha rifiutato il commit. Un commit senza file di localizzazione: saltato.

• Cosa non è stato eseguito

  Un job CI che chiama pre-commit run --all-files non è stato eseguito su un runner. Non esiste un repository di hook pubblicato per kaeris, quindi la ricetta utilizza un hook locale; non c'è una riga repo: https://github.com/… da aggiungere.

• Fallisce anche per chiavi obsolete

  --strict fallisce anche quando una traduzione ha chiavi che la sorgente non ha più.

• Mantieni i nomi dei brand così come sono scritti

  --glossary 'KAERIS,GitHub' fa fallire un target che ha omesso uno dei termini. Lo stesso elenco può risiedere sotto keep in kaeris.json.

• Layout file diverso

  --out è la cartella con le traduzioni e --pattern '{lang}/common.json' i loro nomi file. Predefinito: il layout che kaeris translate scrive.

• Nessun flag

  Con un file kaeris.json nel progetto (scritto da kaeris init), kaeris check prende sorgente, lingue e cartella da esso.

Altre ricette: GitHub Actions · GitLab CI · Script Make e npm

Riferimento CLI · Riferimento Check · Riferimento GitHub Action · Controllo gratuito nel browser · Traduci nel browser