PHPackages malaxitlmax/anchor-docs - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Testing & Quality](/categories/testing) 4. / 5. malaxitlmax/anchor-docs ActiveLibrary[Testing & Quality](/categories/testing) malaxitlmax/anchor-docs ======================= Documentation coverage analyzer for PHP projects v1.0.5(10mo ago)03MITPHPPHP >=8.0 Since Aug 19Pushed 10mo agoCompare [ Source](https://github.com/malaxitlmax/anchor-docs)[ Packagist](https://packagist.org/packages/malaxitlmax/anchor-docs)[ Docs](https://github.com/malaxitlmax/anchor-docs)[ RSS](/packages/malaxitlmax-anchor-docs/feed)WikiDiscussions main Synced today READMEChangelogDependencies (7)Versions (7)Used By (0) Anchor Documentation Coverage Analyzer ====================================== [](#anchor-documentation-coverage-analyzer) PHP инструмент для анализа покрытия кода документацией, работающий аналогично PHPStan, но проверяющий наличие и актуальность документации в Markdown файлах. Возможности ----------- [](#возможности) - 📊 **Анализ покрытия документацией**: Проверяет, какие классы, методы и функции задокументированы - 🔍 **Поиск ссылок**: Находит ссылки на код в Markdown документации и проверяет их актуальность - 📈 **Детальные отчеты**: Генерирует отчеты в консольном, JSON и HTML форматах - ⚙️ **Настраиваемость**: Гибкая конфигурация через YAML файлы и параметры командной строки - 🎯 **Интеграция в CI/CD**: Возвращает код ошибки при недостаточном покрытии - 📋 **Baseline поддержка**: Игнорирование известных проблем, как в PHPStan Установка --------- [](#установка) ``` # Клонируйте репозиторий git clone anchor-docs cd anchor-docs # Установите зависимости composer install # Сделайте исполняемым chmod +x bin/anchor-docs ``` Быстрый старт ------------- [](#быстрый-старт) ``` # Базовый анализ текущего проекта php bin/anchor-docs analyze # Анализ с минимальным покрытием 90% php bin/anchor-docs analyze --min-coverage=90 # Генерация HTML отчета php bin/anchor-docs analyze --format=html --output=coverage-report.html # Анализ конкретных директорий php bin/anchor-docs analyze --source=app/ --docs=documentation/ # Создание baseline для legacy кода php bin/anchor-docs analyze --generate-baseline --baseline=docs-baseline.yml # Анализ с использованием baseline php bin/anchor-docs analyze --baseline=docs-baseline.yml --min-coverage=80 ``` Конфигурация ------------ [](#конфигурация) Создайте файл `anchor-docs.yml` в корне проекта: ``` source_paths: - "src/" docs_paths: - "docs/" exclude_paths: - "vendor/" - "tests/" minimum_coverage: 80.0 baseline_file: "docs-baseline.yml" # Игнорировать известные проблемы output_format: "console" ``` Пример работы ------------- [](#пример-работы) В проекте есть пример класса `UserService` и его документация. Запустите анализ: ``` php bin/anchor-docs analyze ``` Анализатор найдет: - ✅ Задокументированные методы: `getUserById()`, `createUser()`, `deleteUser()`, `getAllUsers()` - ❌ Недокументированные методы: `updateUser()`, `getUsersByName()` - 🔗 Проверит ссылки на исходный код в документации Интеграция в CI/CD ------------------ [](#интеграция-в-cicd) ``` # GitHub Actions - name: Check documentation coverage run: php bin/anchor-docs analyze --min-coverage=80 ``` ``` # GitLab CI script: - php bin/anchor-docs analyze --min-coverage=80 ``` Форматы отчетов --------------- [](#форматы-отчетов) ### Консольный [](#консольный) ``` Documentation Coverage Report ================================================== Overall Coverage: 66.7% (4/6 elements) Minimum Required: 80.0% Coverage by Type: ------------------------------ Class : 100.0% (1/1) Method : 66.7% (4/6) Undocumented Elements: ------------------------------ src/Example/UserService.php Line 48: method updateUser Line 70: method getUsersByName ❌ FAILED Issues: Coverage 66.7% is below minimum 80.0% ``` ### HTML [](#html) Генерирует красивый веб-отчет с интерактивными элементами и детальной статистикой. ### JSON [](#json) Структурированные данные для интеграции с другими инструментами. Архитектура ----------- [](#архитектура) - **CodeAnalyzer**: Парсит PHP код с помощью nikic/php-parser - **DocumentationAnalyzer**: Анализирует Markdown с помощью league/commonmark - **CoverageAnalysisService**: Сопоставляет код и документацию - **ReportGenerator**: Создает отчеты в разных форматах Baseline (Игнорирование известных проблем) ------------------------------------------ [](#baseline-игнорирование-известных-проблем) Как и в PHPStan, вы можете создать baseline файл для игнорирования существующих проблем: ``` # Создать baseline из текущего состояния php bin/anchor-docs analyze --generate-baseline --baseline=docs-baseline.yml # Использовать baseline при анализе php bin/anchor-docs analyze --baseline=docs-baseline.yml # Обновить baseline (удалить недействительные записи) php bin/anchor-docs analyze --update-baseline --baseline=docs-baseline.yml ``` 📖 **Подробное руководство**: [docs/baseline-guide.md](docs/baseline-guide.md) Разработка ---------- [](#разработка) ``` # Запуск на собственном коде php bin/anchor-docs analyze --source=src/ --docs=docs/ # Проверка стиля кода vendor/bin/phpstan analyse src/ # Запуск тестов (когда будут добавлены) vendor/bin/phpunit ``` ### Health Score 29 — LowBetter than 57% of packages Maintenance54 Moderate activity, may be stable Popularity3 Limited adoption so far Community6 Small or concentrated contributor base Maturity46 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~0 days Total 6 Last Release 319d ago PHP version history (2 changes)v1.0.0PHP >=8.1 v1.0.2PHP >=8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/68462426?v=4)[Maksim](/maintainers/malaxitlmax)[@malaxitlmax](https://github.com/malaxitlmax) --- Top Contributors [![malaxitlmax](https://avatars.githubusercontent.com/u/68462426?v=4)](https://github.com/malaxitlmax "malaxitlmax (8 commits)") --- Tags phpPHPStancoveragedocumentationmarkdownanalysisbaseline ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/malaxitlmax-anchor-docs/health.svg) ``` [![Health](https://phpackages.com/badges/malaxitlmax-anchor-docs/health.svg)](https://phpackages.com/packages/malaxitlmax-anchor-docs) ``` ### Alternatives [behat/behat Scenario-oriented BDD framework for PHP 4.0k101.8M2.2k](/packages/behat-behat)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[infection/infection Infection is a Mutation Testing framework for PHP. The mutation adequacy score can be used to measure the effectiveness of a test set in terms of its ability to detect faults. 2.2k28.9M2.4k](/packages/infection-infection)[friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 103519.9k53](/packages/friendsoftypo3-content-blocks)[contao/core-bundle Contao Open Source CMS 1231.6M2.8k](/packages/contao-core-bundle)[jolicode/castor A lightweight and modern task runner. Automate everything. In PHP. 54743.1k4](/packages/jolicode-castor) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)