Misspell Fixer

用于修复源代码中常见拼写错误和错别字的工具。程序代码中存在许多典型拼写错误，这些错误在活跃代码中较易发现，但在注释、示例、样本、说明和文档中容易隐藏。使用此工具可快速修复大量此类错误。

注意：工具不检查或修复文件名。代码中引用的文件名若被修复，实际文件不会被重命名。修复公共API时需格外谨慎！始终需要手动检查以确保未破坏任何内容。

概要

misspell-fixer [OPTION] target[s]

选项与参数

target[s] 可以是任何文件或目录。

主要选项

• -r：真实运行模式。用修复后的文件覆盖原始文件。不使用此选项时，原始文件保持不变。
• -n：禁用备份。（默认情况下，修改后的文件原始版本将以 .$$.BAK 后缀保存。）
• -P n：启用 n 个进程并行处理。例如：-P 4 表示使用4个线程处理文件。（不支持 -s 选项）
• -f：快速模式。（等同于 -P4）
• -h：显示帮助信息。

性能说明：-s、-v 选项，或未使用 -n、-r 时，会使用较慢的内部处理循环。通常 -frn（不配合 -s 和 -v）是性能最高的组合。

输出控制选项

• -s：显示修改的差异（diff）。
• -v：详细模式。显示迭代的文件（不包含预过滤步骤）。
• -o：进度显示模式。每个扫描的文件打印一个点，每个修复的文件打印一个逗号。
• -d：调试模式。显示核心逻辑的所有步骤。

修复规则选项

默认仅启用部分规则（约100条）。可通过以下选项启用更多规则：

• -u：启用安全性较低的规则（需更严格的手动检查）（约10条）。
• -g：启用将英式英语转换为美式英语的规则（非严格拼写错误，但有时有用）（约10条）。
• -R：启用罕见规则（约数百条）。
• -V：启用极罕见规则（主要来自***文章）（超过4000条）。
• -D：启用基于 lintian.debian.org 的规则（git:ebac9a7，约2300条）。

性能影响：启用更多规则会降低处理速度，但新版本 grep 对此优化显著。

文件过滤选项

• -G：遵循 .gitignore 文件。（需要可执行的 git 命令）（实验性）
• -N：启用文件名过滤。例如：-N '*.cpp' -N '*.h'
• -i：遍历源代码管理系统的内部目录。（不忽略 .git、.svn、.hg、CVS）
• -b：处理二进制文件和生成文件。（不忽略 *.gif、*.jpg、*.jpeg、*.png、*.zip、*.gz、*.bz2、*.xz、*.rar、*.po、*.pdf、*.woff、yarn.lock、package-lock.json、composer.lock、*.mo、*.mov、*.mp4、*.jar）
• -m：禁用文件大小检查。默认忽略大于1MB的文件（通常是csv、压缩JS等）。

白名单设置

Misspell-fixer 会自动忽略 .misspell-fixer.ignore 或 .github/.misspell-fixer.ignore 文件中列出的匹配模式。该文件格式遵循预过滤临时结果格式：

^filename:line number:matched word

• -W：将发现的问题追加到白名单文件，而非根据其他设置修复。
• -w filename：覆盖白名单文件名称。

白名单文件被解释为 grep 排除列表，在预过滤步骤后应用。可排除特定前缀或文件：

• 排除文件：^filename
• 排除目录：^directory

注意：白名单条目基于当前调用路径。从同一工作目录以不同路径访问同一目标时，其他调用生成的白名单条目不适用。

返回值

脚本通常返回 0 表示未发现拼写错误或错误：

• 0：未发现拼写错误
• 1-5：发现拼写错误。返回值表示执行的迭代次数。
• 10：成功打印帮助信息
• 11：成功保存白名单
• 100-：参数错误（无效、缺失、冲突）

示例用法

无参数时，脚本不修改任何内容，输出最少。返回值可用于检测是否发现拼写错误：

bash
$ misspell-fixer target

修复文件并显示每个被修复的文件：

bash
$ misspell-fixer -rv target

仅显示差异而不修改原始文件：

bash
$ misspell-fixer -sv target

显示差异、进度并修复发现的拼写错误：

bash
$ misspell-fixer -rsv target

快速模式示例，无备份（最高性能）：

bash
$ misspell-fixer -frn target

启用所有规则的快速模式：

bash
$ misspell-fixer -frunRVD target

Docker 使用

在某些环境（Mac、Windows、旧版Linux）中，依赖可能导致问题。此时可使用Docker容器镜像。

拉取镜像

bash
$ docker pull vlajos/misspell-fixer

修复目录内容

bash
$ docker run -ti --rm -v targetdir:/work vlajos/misspell-fixer -frunRVD .

其他使用场景示例

直接通过Docker执行：

bash
$ docker run -ti --rm -v targetdir:/work vlajos/misspell-fixer [arguments]

targetdir 会成为容器中的当前工作目录，因此可在参数中用 . 引用。

使用源码仓库中的 dockered-fixer 包装器：

bash
$ dockered-fixer [arguments]

若shell支持函数，可定义函数简化命令：

bash
$ function misspell-fixer { docker run -ti --rm -v $(pwd):/work vlajos/misspell-fixer "$@"; }

使用函数修复：

bash
$ misspell-fixer [arguments]

通过包装器和函数仅能访问当前工作目录下的文件夹，因为只有该目录作为卷挂载到容器中。

本地构建容器

通常无需本地构建，但可执行以下命令：

bash
$ docker build . -t misspell-fixer

GitHub Actions 集成

存在 GitHub Action 可运行 misspell-fixer，甚至能自动发送包含修复的PR。

依赖项

脚本本质是一个拼写错误数据库，通过 bash 连接 grep 和 sed 实现功能。grep 的 -F 选项结合 sed 的行定位使其高效，-F 启用基于 Aho–Corasick算法 的并行模式匹配。注意：仅较新版本（2.28+）的 grep 正确支持 -w 选项。

完整依赖列表：

• bash
• find
• sed
• grep
• diff
• sort
• tee
• cut
• rm, cp, mv
• xargs
• git（用于支持 .gitignore 文件）

作者

• Veres Lajos
• ka7

原始来源

[***]

欢迎使用！