Typos 源码拼写检查器
将以下提示词粘贴到你的 AI 对话框中:
请根据官方安装指南 https://skillhub.cn/install/skillhub.md,将 @user_3c6cb52e/typos-source-code-spell-checker 安装到当前 AI 助手中。
技能介绍
它解决什么问题
代码评审中最磨人的一类问题往往不是逻辑错误,而是拼写:一个叫 futer 的变量、注释里的 recieve、文档中的 occured。这类错误编译器不报错,测试照样通过,却在长期维护中持续制造认知负担,还会影响搜索命中率和 API 文档质量。typos 就是为这类问题而生的——它不追求理解代码语义,只专注于一件事:在源代码里找出拼写可疑的单词,并给出修正建议。
它如何工作
typos 是一个用 Rust 编写的工具,启动快、单遍扫描即可覆盖整个代码库,因此可以直接跑在 monorepo 上。其工作方式可以概括为三步:
- 扫描:按项目结构遍历源码,默认只读,不会改动任何文件;
- 识别与建议:对标识符、注释、字符串做拼写分析,依靠内置词典与纠错规则尽量压低误报;
- 修复:确认问题后,可用
--write-changes参数把修正写回文件。
行为可通过配置文件细调,支持 TOML、JSON、YAML 三种格式,例如忽略特定单词、排除目录、追加自定义词典。覆盖范围也很广:从 Rust、Python、Go 等主流语言,到 SQL、YAML、TOML、JSON 等数据格式,再到 Makefile、CMakeLists.txt、package.json、CI 配置文件,都在检查之列。
适用边界与注意点
- 它只做拼写检查,不替代 linter 或类型检查;语法正确但拼错的名字才是它的领地;
- 默认不写文件,启用自动修复前建议先跑一次干跑模式确认输出;
- 命中结果未必是错误——领域术语、专有名词可能被标记,需要靠忽略列表或自定义词典处理;
- 它按语言和文件类型工作,对代码语义一无所知,不要指望它发现命名风格问题。
使用场景
- 在 CI 流水线中运行 `typos --write-changes`,拦截 PR 里的注释与标识符拼写错误
- 提交前通过 Git Hook 扫描变更文件,避免 `futer` 这类拼写进入主分支
- 在 monorepo 中统一检查 Rust、Python、Go 与配置文件的拼写,减少逐语言配置
- 当领域术语被误报时,在配置文件的忽略列表中补充单词或追加自定义词典
适合人员
- 维护多语言开源仓库的开发者,需要在 CI 中低成本拦截拼写错误
- 搭建 pre-commit 与 CI 质量门禁的平台工程师,关注误报率和执行速度
- 编写 SDK 与 API 文档的技术作者,需要保证标识符、注释和示例中的英文拼写一致
- 处理 monorepo 构建配置的基础设施工程师,需要检查 TOML、YAML 与 CI 文件中的拼写