Übersetzungen mit pre-commit prüfen

Der Hook

Speichern Sie ihn als .pre-commit-config.yaml im Projekt-Root. Es ist ein lokaler Hook: pre-commit baut seine eigene Umgebung auf und installiert kaeris von PyPI darin, sodass nichts anderes installiert werden muss. files beschränkt ihn auf Commits, die etwas unter locales/ stagen.

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

Was ein Commit ausgibt

Links: ein Commit mit Dateien, die in Ordnung sind. Rechts: ein Commit mit de.json, das {nam} anstelle von {name} hat und den checkout-Schlüssel vermisst; der Commit wird abgewiesen.

$ 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

Ein Commit, der keine Locale-Datei berührt

Der Hook wird übersprungen, sodass nicht verwandte Commits schnell sind.

$ 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. Hook hinzufügen

   Speichern Sie die obige Konfiguration als .pre-commit-config.yaml und legen Sie Ihre eigenen --source und --langs fest. Behalten Sie die Versionsmarkierung bei und erhöhen Sie sie, wenn Sie ein Upgrade durchführen.

2. Git-Hook installieren

   Führen Sie pip install pre-commit und dann pre-commit install einmal pro Klon aus.

3. Wie gewohnt committen

   Ein Commit, der eine Datei unter locales/ staget, führt die Prüfung aus und wird bei einem Fehler abgelehnt. pre-commit run --all-files führt dieselbe Prüfung bei Bedarf aus, z. B. in CI.

• Was lief

  pre-commit 4.7.0 mit exakt der obigen Konfiguration in einem frischen Git-Repository: pre-commit install, dann echte git commit-Läufe. Die Hook-Umgebung wurde von PyPI (kaeris 0.2.35) erstellt. Gute Dateien: Der Commit wurde durchgeführt. Defekte de.json: Der Hook schlug mit Exit-Code 1 fehl und Git lehnte den Commit ab. Ein Commit ohne Locale-Datei: übersprungen.

• Was nicht lief

  Ein CI-Job, der pre-commit run --all-files aufruft, wurde auf keinem Runner ausgeführt. Es gibt kein veröffentlichtes Hook-Repository für kaeris, daher verwendet das Rezept einen lokalen Hook; es gibt keine Zeile repo: https://github.com/… zum Hinzufügen.

• Auch bei veralteten Schlüsseln fehlschlagen

  --strict schlägt auch fehl, wenn eine Übersetzung Schlüssel hat, die die Quelle nicht mehr hat.

• Markennamen beibehalten, wie sie geschrieben sind

  --glossary 'KAERIS,GitHub' führt dazu, dass ein Ziel fehlschlägt, das einen der Begriffe fallen gelassen hat. Dieselbe Liste kann unter keep in kaeris.json stehen.

• Anderes Dateilayout

  --out ist der Ordner mit den Übersetzungen und --pattern '{lang}/common.json' deren Dateinamen. Standard: das Layout, das kaeris translate schreibt.

• Gar keine Flags

  Mit einer kaeris.json im Projekt (kaeris init schreibt eine) nimmt kaeris check Quelle, Sprachen und Ordner daraus.

Andere Rezepte: GitHub Actions · GitLab CI · Make und npm Skripte

Referenz zur CLI · Referenz zur Prüfung · Referenz zur GitHub Action · Kostenlose Prüfung im Browser · Übersetzen im Browser