nickg/misspell

镜像概述

nickg/misspell 是包含 misspell 工具的 Docker 镜像，用于快速检测和纠正文本中的常见英文拼写错误。该工具采用高效算法，支持多种文件格式（代码、Markdown、纯文本等），并提供美英拼写转换、批量处理等功能，适合集成到 CI/CD 流程或作为 pre-commit 钩子使用。

核心功能

• 高效检测: 同时匹配多个错误拼写，处理速度极快（100-1000倍于同类工具）。
• 多格式支持: 自动识别文件类型，代码文件仅检查注释内容。
• 区域适配: 支持美英拼写转换（如 colour→color、favorite→favourite）。
• 批量处理: 递归检查目录下所有文件，支持管道输入。
• 灵活输出: 提供 CSV、SQLite3 等格式，支持自定义模板。

使用场景

• 代码注释拼写检查与自动纠正。
• 文档（Markdown、纯文本）拼写优化。
• CI/CD 流程中自动检测拼写错误。
• 批量处理大量文本文件的拼写问题。

配置说明

Docker 运行示例

检查当前目录文件

bash
docker run --rm -v $(pwd):/workspace nickg/misspell .

自动纠正拼写错误

bash
docker run --rm -v $(pwd):/workspace nickg/misspell -w .

转换英国拼写为美国拼写

bash
docker run --rm -v $(pwd):/workspace nickg/misspell -locale US -w .

输出 CSV 格式结果

bash
docker run --rm -v $(pwd):/workspace nickg/misspell -f csv . > spelling_errors.csv

常用参数

• -w: 覆盖文件以应用纠正。
• -locale US/UK: 指定拼写区域。
• -f csv/sqlite/template: 设置输出格式。
• -i "rule1,rule2": 忽略特定纠正规则。
• -source go/text/auto: 强制指定文件类型。
• -q: 仅输出纠正后的文本（无日志）。