README

PHP инструмент для анализа покрытия кода документацией, работающий аналогично PHPStan, но проверяющий наличие и актуальность документации в Markdown файлах.

Возможности

📊 Анализ покрытия документацией: Проверяет, какие классы, методы и функции задокументированы
🔍 Поиск ссылок: Находит ссылки на код в Markdown документации и проверяет их актуальность
📈 Детальные отчеты: Генерирует отчеты в консольном, JSON и HTML форматах
⚙️ Настраиваемость: Гибкая конфигурация через YAML файлы и параметры командной строки
🎯 Интеграция в CI/CD: Возвращает код ошибки при недостаточном покрытии
📋 Baseline поддержка: Игнорирование известных проблем, как в PHPStan

Установка

# Клонируйте репозиторий
git clone <repository-url> 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

# 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

Генерирует красивый веб-отчет с интерактивными элементами и детальной статистикой.

JSON

Структурированные данные для интеграции с другими инструментами.

Архитектура

CodeAnalyzer: Парсит PHP код с помощью nikic/php-parser
DocumentationAnalyzer: Анализирует Markdown с помощью league/commonmark
CoverageAnalysisService: Сопоставляет код и документацию
ReportGenerator: Создает отчеты в разных форматах

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

Разработка

# Запуск на собственном коде
php bin/anchor-docs analyze --source=src/ --docs=docs/

# Проверка стиля кода
vendor/bin/phpstan analyse src/

# Запуск тестов (когда будут добавлены)
vendor/bin/phpunit

malaxitlmax / anchor-docs

Maintainers

Package info

Statistics

Security