i18n-tasks 项目中 YAML 键值解析的注意事项

问题背景

在使用 i18n-tasks 工具进行国际化键值检查时，开发者可能会遇到一个看似奇怪的现象：明明在 YAML 文件中定义了某些键值，但工具却报告这些键值缺失。特别是当键名使用简单的单词如"yes"或"no"时，这种情况尤为常见。

根本原因分析

这个问题实际上源于 YAML 规范本身对某些特殊值的处理方式。YAML 1.1 规范中，"yes"、"no"、"true"、"false"、"on"、"off"等词会被自动解析为布尔值，而不是字符串。

当我们在 YAML 文件中这样定义：

en:
  yes: Yes
  no: No

YAML 解析器会将其转换为：

{"en" => {true => "Yes", false => "No"}}

这显然不是我们想要的结果，也解释了为什么 i18n-tasks 工具无法正确找到这些键值。

解决方案

要解决这个问题，我们需要确保这些特殊键名被正确识别为字符串，而不是布尔值。有两种推荐做法：

1. 引号包裹键名：使用单引号或双引号包裹键名

en:
  'yes': 'Yes'
  'no': 'No'

2. 修改键名：使用不会引起歧义的键名

en:
  affirmative: 'Yes'
  negative: 'No'

最佳实践建议

1. 始终引用可能产生歧义的键名：不仅是"yes"/"no"，还包括"true"/"false"、"on"/"off"等
2. 使用 YAML linter：在项目中集成 yamllint 等工具，自动检测潜在的键值解析问题
3. 测试键值解析：在 CI/CD 流程中加入键值解析测试，确保国际化文件按预期工作
4. 考虑升级到 YAML 1.2：新版本规范减少了这类自动类型转换的问题

对 i18n-tasks 工具的补充说明

虽然这个问题本质上是 YAML 解析的问题，但 i18n-tasks 作为国际化管理工具，可以更智能地处理这类情况。开发者可以考虑：

1. 在配置中添加对这类特殊键名的检查规则
2. 编写自定义任务自动检测和修复这类问题
3. 在项目文档中明确标注这类常见陷阱

总结

国际化管理中的键值定义看似简单，但细节决定成败。理解 YAML 解析规则对于正确使用 i18n-tasks 这类工具至关重要。通过正确引用键名和遵循最佳实践，可以避免许多看似神秘的问题，确保国际化工作流程顺畅无阻。