在crate-ci/typos项目中处理特殊缩写的拼写检查问题

问题背景

在软件开发和技术文档编写过程中，我们经常会遇到一些特殊的缩写形式，比如"CC-BY-ND"或"ND-JSON"这样的技术术语。这些术语在使用typos这样的拼写检查工具时可能会被误判为拼写错误，因为工具会将"ND"识别为"AND"的错误拼写。

技术挑战

typos作为一款代码拼写检查工具，默认会将标识符中的单词拆分检查。对于包含连字符的复合词，如"CC-BY-ND"，工具会将其拆分为"CC"、"BY"和"ND"三个部分分别检查。这就导致了"ND"被误判为拼写错误的问题。

解决方案探索

初步尝试：extend-words扩展

最初尝试使用extend-words配置将整个复合词加入白名单：

[default.extend-words]
CC-BY-ND = "CC-BY-ND"
ND-JSON = "ND-JSON"

这种方法虽然能解决问题，但副作用是全局允许"ND"作为有效单词，导致无法检测到真正的拼写错误如"chocolate ND strawberry"。

进阶方案：正则表达式忽略规则

更精确的解决方案是使用extend-ignore-re配置项，它允许通过正则表达式指定需要忽略检查的文本模式：

[default]
extend-ignore-re = [
    "CC-BY-ND",
    "ND-JSON"
]

与extend-ignore-identifiers-re不同，extend-ignore-re可以匹配任意文本模式，而不仅限于标识符。这使得我们能够精确地忽略特定上下文中的"ND"出现，而不影响其他地方的拼写检查。

技术原理深入

typos处理单词的机制是将文本拆分为token进行检查。对于代码中的标识符，默认只识别下划线_作为分隔符，而不识别连字符-。因此：

1. extend-ignore-identifiers-re只能匹配标识符形式的文本
2. extend-ignore-re则可以匹配任意文本模式，包括包含特殊字符的复合词

最佳实践建议

1. 对于包含特殊字符的技术术语，优先考虑使用extend-ignore-re进行精确匹配
2. 如果术语是纯字母组合且可能在其他上下文中出现拼写错误，可以使用大小写区分策略
3. 定期审查忽略规则，确保不会遗漏真正的拼写错误

总结

通过合理配置typos的忽略规则，我们可以在保持严格拼写检查的同时，灵活处理技术文档和代码中的特殊术语。extend-ignore-re提供了强大的模式匹配能力，是解决这类问题的理想选择。开发者应当根据具体场景选择最适合的配置方式，在代码质量和开发效率之间取得平衡。