Download the PHP package malaxitlmax/anchor-docs without Composer
On this page you can find all versions of the php package malaxitlmax/anchor-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download malaxitlmax/anchor-docs
More information about malaxitlmax/anchor-docs
Files in malaxitlmax/anchor-docs
Package anchor-docs
Short Description Documentation coverage analyzer for PHP projects
License MIT
Homepage https://github.com/malaxitlmax/anchor-docs
Informations about the package anchor-docs
Anchor Documentation Coverage Analyzer
PHP инструмент для анализа покрытия кода документацией, работающий аналогично PHPStan, но проверяющий наличие и актуальность документации в Markdown файлах.
Возможности
- 📊 Анализ покрытия документацией: Проверяет, какие классы, методы и функции задокументированы
- 🔍 Поиск ссылок: Находит ссылки на код в Markdown документации и проверяет их актуальность
- 📈 Детальные отчеты: Генерирует отчеты в консольном, JSON и HTML форматах
- ⚙️ Настраиваемость: Гибкая конфигурация через YAML файлы и параметры командной строки
- 🎯 Интеграция в CI/CD: Возвращает код ошибки при недостаточном покрытии
- 📋 Baseline поддержка: Игнорирование известных проблем, как в PHPStan
Установка
Быстрый старт
Конфигурация
Создайте файл anchor-docs.yml в корне проекта:
Пример работы
В проекте есть пример класса UserService и его документация. Запустите анализ:
Анализатор найдет:
- ✅ Задокументированные методы:
getUserById(),createUser(),deleteUser(),getAllUsers() - ❌ Недокументированные методы:
updateUser(),getUsersByName() - 🔗 Проверит ссылки на исходный код в документации
Интеграция в CI/CD
Форматы отчетов
Консольный
HTML
Генерирует красивый веб-отчет с интерактивными элементами и детальной статистикой.
JSON
Структурированные данные для интеграции с другими инструментами.
Архитектура
- CodeAnalyzer: Парсит PHP код с помощью nikic/php-parser
- DocumentationAnalyzer: Анализирует Markdown с помощью league/commonmark
- CoverageAnalysisService: Сопоставляет код и документацию
- ReportGenerator: Создает отчеты в разных форматах
Baseline (Игнорирование известных проблем)
Как и в PHPStan, вы можете создать baseline файл для игнорирования существующих проблем:
📖 Подробное руководство: docs/baseline-guide.md
Разработка
All versions of anchor-docs with dependencies
symfony/console Version ^5.2.0
symfony/finder Version ^5.2.0
symfony/yaml Version ^5.2.0
league/commonmark Version ^2.0
nikic/php-parser Version ^4.0