在程式碼與文件中捕捉常見拼寫錯誤(使用 codespell) 是做什麼的?
對原始碼檔案和文件快速執行一次拼寫檢查,以便常見拼寫錯誤在進入審查和發布流程前就被修復。
先決條件
Python 3.9+ 和 codespell 命令列工具,安裝在已檢出的程式庫或文件目錄中。
安裝
使用符合您環境的上游安裝或設定方式:
- 您可以使用 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