Häufige Rechtschreibfehler in Code und Doku vor Review-Churn erkennen mit codespell
Führe einen schnellen Tippfehler-Durchlauf über Quelldateien und Dokumentationen durch, damit häufige Rechtschreibfehler korrigiert werden, bevor sie sich über Reviews und Releases verbreiten.
Voraussetzungen
Python 3.9+ und die codespell CLI in einem ausgecheckten Repository oder Dokumentationsbaum.
Installation
Verwende den offiziellen Installations- oder Setup-Pfad, der deiner Umgebung entspricht:
- Du kannst
codespellmit pip installieren, z.B.: - pip install codespell
- pip install --upgrade pip setuptools setuptools_scm wheel
- pip install -e ".[dev]"
Anforderungen und Hinweise aus dem offiziellen Repository:
- Python 3.9 oder höher.
- Beim Ignorieren von False Positives beachten: Rechtschreibfehler sind case-insensitive, aber zu ignorierende Wörter sind case-sensitive. Beispiel: Der Wörterbucheintrag
wroderkennt auch den TippfehlerWrod, aber um ihn zu ignorieren, musst du ... - In manchen Situationen kann es erforderlich sein, ein bestimmtes Wort an einer bestimmten Stelle zu ignorieren. Dies kann durch Hinzufügen eines Kommentars im Quellcode erreicht werden.
Grundlegende Nutzung bzw. Einstiegsnotizen:
- .. code-block:: sh
- Quelle: https://github.com/codespell-project/codespell
- Auszug aus der offiziellen Dokumentation: https://raw.githubusercontent.com/codespell-project/codespell/HEAD/README.rst