使用 codespell 在代码和文档中发现常见拼写错误(审查流之前)
快速对源文件和文档进行拼写检查,以便在审查和发布流程之前修复常见拼写错误。
前置条件
Python 3.9+ 以及已检出的仓库或文档树中安装有 codespell CLI。
安装
使用与您的环境匹配的上游安装或设置路径:
- 您可以使用 pip 安装 codespell,例如:
- pip install codespell
- pip install --upgrade pip setuptools setuptools_scm wheel
- pip install -e ".[dev]"
上游的要求和注意事项:
- 需要 Python 3.9 或更高版本。
- 忽略误报时,请注意拼写错误是大小写不敏感的,但忽略的词是大小写敏感的。例如,字典条目 wrod 也会匹配拼写错误 Wrod,但要忽略它您必须...
- 某些情况下可能需要忽略特定位置的特定单词。这可以通过在源代码中添加注释来实现。
基本用法或入门说明:
- .. code-block:: sh
- 来源:https://github.com/codespell-project/codespell
- 从上游文档中提取:https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst