codespell-project/codespell

これは何？

主な機能

• 01網羅的な辞書ではなく、よくあるスペルミスを厳選したリストでファイルをチェックします。
• 02-wと-iを使って、修正候補を自動または対話的に適用できます。
• 03単語リスト、コマンドラインフラグ、インラインコメントで誤検出を回避できます。
• 04setup.cfg、.codespellrc、pyproject.tomlから設定を読み込みます。
• 05pre-commit hookとして動作し、修正が必要な場合にCIの実行を失敗させることもできます。

ユースケース

• 開発中に、ソースコードのコメント、識別子、ドキュメントにある誤字を検出する。
• CIパイプラインやpre-commit hookでスペルチェックを実行する。
• 対話的な修正を使って、既存の大規模なコードベース全体の誤字をまとめて修正する。

クイックスタート

1. 1

   pipでPyPIからcodespellをインストールします

   pip install codespell
2. 2

   現在のディレクトリでcodespellを実行します

   codespell

使う前に知っておきたいこと

• !GPL-2.0でライセンスされているコピーレフトライセンスのため、派生コードの配布方法が制限される場合があります。
• !辞書に登録された一般的なスペルミスのみを検出するため、珍しいタイプミスは見つかりません。

トピック

よくある質問

codespell とは？

厳選したスペルミス辞書を使い、ソースコードやテキストファイルのよくある誤字を検出・修正するCLIツールです。 codespellは、単語を網羅的な辞書と照合するのではなく、よくあるスペルミスを厳選したリストを使ってファイルをチェックします。そのため、コード内のニッチな用語による誤検出を抑えながら、「and」の代わりに「adn」と書くような誤字を検出できます。主にソースコード向けに設計されており、バックスラッシュによるエスケープは無視しますが、あらゆるテキストファイルで使用できます。

codespell は無料で使えますか？ライセンスは？

codespell は GPL-2.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

codespell は今もメンテナンスされていますか？

活発にメンテナンス中。codespell の最終コミットは 2026年11月6日 です。

codespell は何に使えますか？

開発中に、ソースコードのコメント、識別子、ドキュメントにある誤字を検出する。 CIパイプラインやpre-commit hookでスペルチェックを実行する。 対話的な修正を使って、既存の大規模なコードベース全体の誤字をまとめて修正する。

codespell のインストール方法は？

pipでPyPIからcodespellをインストールします: pip install codespell 現在のディレクトリでcodespellを実行します: codespell

codespell はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/codespell-project/codespell