コードとドキュメントのよくあるスペルミスをレビューの手間がかかる前にキャッチする

コードとドキュメントのよくあるスペルミスをレビューの手間がかかる前にキャッチする（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

ドキュメント

• https://github.com/codespell-project/codespell

ソース

• Agent Skill Exchange