Перевіряйте переклади зі скриптів Make або npm

Makefile

Встановіть перевіряльник один раз за допомогою pip install kaeris. Рядок рецепту починається з табуляції. Зробивши test залежним від i18n-check, ви виконаєте перевірку перед тестами.

.PHONY: i18n-check test

i18n-check:
	kaeris check --source locales/en.json --langs de,fr --ci

test: i18n-check
	./run-tests.sh

npm скрипти

Скрипт лише викликає kaeris з вашого PATH, тому перевіряльник — це пакет Python з pip install kaeris. pretest виконується перед test і зупиняє його, якщо перевірка не вдається.

{
  "scripts": {
    "i18n:check": "kaeris check --source locales/en.json --langs de,fr --ci",
    "pretest": "npm run i18n:check",
    "test": "jest"
  }
}

npm test

Вивід npm test з наведеними вище скриптами (скрипт test у цьому запуску був echo). Ліворуч: файли, які в порядку. Праворуч: de.json з {nam} замість {name} та відсутнім ключем checkout; npm зупиняється перед test.

$ npm test

> [email protected] pretest
> npm run i18n:check


> [email protected] i18n:check
> kaeris check --source locales/en.json --langs de,fr --ci

✓ de: complete & placeholder-safe
✓ fr: complete & placeholder-safe
✓ all locales complete & placeholder-safe

> [email protected] test
> echo tests would run here

tests would run here
exit code: 0

$ npm test

> [email protected] pretest
> npm run i18n:check


> [email protected] i18n:check
> kaeris check --source locales/en.json --langs de,fr --ci

✗ 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

Рядок рецепту Makefile

Та сама команда, яку виконує ціль i18n-check, та її код виходу.

$ kaeris check --source locales/en.json --langs de,fr --ci
✓ de: complete & placeholder-safe
✓ fr: complete & placeholder-safe
✓ all locales complete & placeholder-safe
exit code: 0

$ kaeris check --source locales/en.json --langs de,fr --ci
✗ 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

1. Встановіть перевіряльник

   Виконайте pip install kaeris на машині або в образі CI, де виконуються ваші тести.

2. Додайте ціль або скрипт

   Додайте ціль i18n-check до Makefile або скрипти i18n:check та pretest до package.json, вказавши власні --source та --langs.

3. Виконайте звичайну команду

   make test або npm test тепер спочатку виконує перевірку і зупиняється з ненульовим кодом виходу, коли переклад пошкоджений.

• Що виконалося

  npm test зі скриптами вище, за винятком того, що test був echo (npm 11.17, Node 24), а kaeris 0.2.35 з PyPI у PATH. Чисті файли: код виходу 0, тести виконано. Пошкоджений de.json: код виходу 1, тести не виконано.

• Що не виконалося

  make не встановлено на машині, де це перевірялося. Рядок рецепту було виконано через оболонку, що робить make, тому код виходу вище є реальним, але сам Makefile не був запущений make.

• npm

  Наразі немає пакету kaeris у реєстрі npm, тому ця сторінка не перенаправляє вас до npm. Node проєкти викликають пакет Python, як описано вище.

• Помилка також на застарілих ключах

  --strict також призводить до помилки, коли переклад містить ключі, яких більше немає у вихідному файлі.

• Зберігайте назви брендів як написано

  --glossary 'KAERIS,GitHub' призведе до помилки цільового файлу, який пропустив один із термінів. Той самий список може бути в keep у kaeris.json.

• Інший макет файлів

  --out — це папка з перекладами, а --pattern '{lang}/common.json' — їхні імена файлів. За замовчуванням: макет, який створює kaeris translate.

• Жодних прапорців

  За наявності файлу kaeris.json у проєкті (його записує kaeris init), kaeris check бере вихідний файл, мови та папку з нього.

Інші рецепти: GitHub Actions · GitLab CI · pre-commit

Довідник CLI · Довідник Check · Довідник GitHub Action · Безкоштовна перевірка в браузері · Переклад у браузері