使用 pre-commit 检查翻译

钩子

将其另存为项目根目录下的 .pre-commit-config.yaml。它是一个本地钩子：pre-commit 构建自己的环境并将 kaeris 从 PyPI 安装到其中，因此无需安装其他任何东西。files 将其限制为暂存 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

提交打印的内容

左侧：一个文件正常的提交。右侧：一个提交，其中 de.json 有 {nam} 而不是 {name}，并且 checkout 键丢失；提交被拒绝。

$ 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

一个不触及区域设置文件的提交

钩子被跳过，因此不相关的提交保持快速。

$ 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. 添加钩子

   将上面的配置另存为 .pre-commit-config.yaml，并设置你自己的 --source 和 --langs。保留版本号，并在升级时提高它。

2. 安装 git 钩子

   运行 pip install pre-commit，然后每个克隆只需运行一次 pre-commit install。

3. 像往常一样提交

   暂存 locales/ 下文件的提交会运行检查，并在失败时被拒绝。pre-commit run --all-files 会按需运行相同的检查，例如在 CI 中。

• 运行了什么

  pre-commit 4.7.0 在一个全新的 git 仓库中使用上面完全相同的配置：pre-commit install，然后是实际的 git commit 运行。钩子环境是从 PyPI (kaeris 0.2.35) 构建的。有效文件：提交成功。损坏的 de.json：钩子以退出码 1 失败，git 拒绝了提交。没有 locale 文件的提交：跳过。

• 未运行什么

  调用 pre-commit run --all-files 的 CI 作业未在运行器上运行。KAERIS 没有已发布的钩子仓库，因此该配方使用本地钩子；没有 repo: https://github.com/… 行可添加。

• 对过时的密钥也失败

  当翻译包含源文件中已不再存在的密钥时，--strict 也会失败。

• 保留品牌名称不变

  --glossary 'KAERIS,GitHub' 会使丢失其中一个术语的目标失败。相同的列表可以放在 kaeris.json 的 keep 下。

• 不同的文件布局

  --out 是包含翻译的文件夹，--pattern '{lang}/common.json' 是它们的文件名。默认：kaeris translate 写入的布局。

• 完全没有标志

  在项目中有一个 kaeris.json 文件（kaeris init 会写入一个），kaeris check 会从中获取源文件、语言和文件夹。

其他配方：GitHub Actions · GitLab CI · Make 和 npm 脚本

CLI 参考 · 检查参考 · GitHub Action 参考 · 浏览器中的免费检查 · 浏览器中的翻译