codespell-project/codespell

Что это?

Ключевые возможности

• 01Проверяет файлы по тщательно составленному списку распространённых опечаток, а не по полному словарю.
• 02Может автоматически применять предложенные исправления с помощью -w или предлагать их в интерактивном режиме с помощью -i.
• 03Позволяет исключать ложные срабатывания с помощью списков слов, флагов командной строки или встроенных комментариев.
• 04Читает настройки из setup.cfg, .codespellrc или pyproject.toml.
• 05Работает как pre-commit hook и может завершать сборку CI с ошибкой, если были внесены исправления.

Сценарии использования

• Поиск опечаток в комментариях к исходному коду, идентификаторах и документации во время разработки.
• Проверка орфографии в CI-пайплайне или с помощью pre-commit hook.
• Исправление опечаток в большой существующей кодовой базе с просмотром каждого изменения в интерактивном режиме.

Быстрый старт

1. 1

   Установите codespell из PyPI с помощью pip

   pip install codespell
2. 2

   Запустите codespell в текущем каталоге

   codespell

Что важно знать

• !Распространяется по лицензии GPL-2.0 — лицензии с авторским левом, которая может ограничивать способы распространения производного кода.
• !Утилита выявляет только распространённые орфографические ошибки из своего словаря, поэтому необычные опечатки она не найдёт.

Темы

Частые вопросы

Что такое codespell?

Консольная утилита, которая находит и исправляет распространённые опечатки в исходном коде и текстовых файлах по тщательно составленному словарю. codespell проверяет файлы на наличие распространённых опечаток из специально составленного списка, а не сверяет слова с полным словарём. Благодаря этому реже возникают ложные срабатывания на редкие термины в коде, но при этом обнаруживаются опечатки вроде «adn» вместо «and». Утилита в первую очередь предназначена для исходного кода и пропускает экранированные обратной косой чертой символы, но работает с любыми текстовыми файлами.

codespell можно использовать бесплатно? Какая у него лицензия?

codespell распространяется с открытым исходным кодом под лицензией GPL-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

codespell всё ещё поддерживается?

Активно поддерживается. Последний коммит в codespell — 6 нояб. 2026 г..

Для чего можно использовать codespell?

Поиск опечаток в комментариях к исходному коду, идентификаторах и документации во время разработки. Проверка орфографии в CI-пайплайне или с помощью pre-commit hook. Исправление опечаток в большой существующей кодовой базе с просмотром каждого изменения в интерактивном режиме.

Как установить codespell?

Установите codespell из PyPI с помощью pip: pip install codespell Запустите codespell в текущем каталоге: codespell

Где скачать codespell?

Исходный код и инструкции по установке — на GitHub: https://github.com/codespell-project/codespell