描述

typos-git-commit 是一个命令行工具，它处理由 typos 生成的 json 文件，以便

1. 通过 sed 在检测到的文件中更正拼写错误
2. 为每个更正创建一个提交（通过简单的 git commit 命令），将每个受影响的文件及其更正组合在一个提交中。

它是为一次性项目编写的，但有人可能会发现它很有用。使用 typos-git-commit --help 获取使用帮助。

用法

您可以使用选项 --noop 打印将要执行的内容，而不实际执行任何操作。

如果您需要所有拼写错误的摘要，可以使用 --only-list-typos 选项。您可以使用 --details 选项添加一些详细信息到此摘要。

您可以使用 --exclude-file、--exclude-typo 和 --exclude-correction（选项可以多次调用）来排除特定的文件、拼写错误或更正，使其不被考虑。

按照以下步骤更正项目中所有文件（Python 和 Javascript 脚本除外）中发现的拼写错误

• 使用 typos 生成一个 json 文件，例如：typos doc/ -exclude *.py --exclude *.js --format json >typos.json
• 在存储库目录中使用 typos-git-commit：typos-git-commit --filename typos.json。此命令将只更正长度超过 5 个字符（默认值）并且只有一个更正建议的拼写错误。要修改最小长度，可以使用 --minlen。
• 仔细审查生成的提交，即使已经采取一切措施来减轻替换错误时的错误，仍有情况这种更正是真正的错误。
• --message 选项允许更改您的提交信息。可以使用特殊符号 {typo} 和 {correction}，它们将分别被要更正的拼写错误及其更正所替换。提示：使用 --noop 查看应用前 git 消息的格式。