#realitylint — Public Fediverse posts

README врёт: как я сделал open‑source линтер, который сверяет документацию с реальным репозиторием

README редко ломается в один момент. Обычно он просто постепенно перестаёт соответствовать проекту: переименовали команду, перенесли файл, удалили .env.example , сменили package manager — а инструкция осталась прежней. В итоге новый пользователь копирует команду из README и получает ошибку. Разработчик же часто узнаёт об устаревшей документации только после issue, сообщения коллеги или неудачного деплоя. Мне стало интересно: можно ли автоматически находить хотя бы часть таких расхождений, не выполняя команды из README и не отправляя исходный код в LLM? Так появился RealityLint — open‑source CLI, который статически сверяет проверяемые утверждения из README с реальным состоянием репозитория.

https://habr.com/ru/articles/1072076/

#RealityLint #README #Python #GitHubActions #CICD #opensource #статическийанализ #документация #тестирование #линтер