Download the PHP package v.chetkov/php-clean-architecture without Composer
On this page you can find all versions of the php package v.chetkov/php-clean-architecture. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download v.chetkov/php-clean-architecture
More information about v.chetkov/php-clean-architecture
Files in v.chetkov/php-clean-architecture
Package php-clean-architecture
Short Description PHP Clean Architecture
License MIT
Informations about the package php-clean-architecture
To continue in English go to README.en
PHP Clean Architecture
Инструмент для автоматизации контроля над качеством архитектуры приложений написанных на PHP, а также упрощения анализа и визуализации некоторых метрик.
Идея его создания была навеяна книгой "Чистая Архитектура" (Роберта Мартина). Если еще не читал, можешь ознакомиться с её ключевыми идеями, на которых базируется инструмент https://habr.com/ru/post/504590/
Установка
Конфигурация
Далее копируем образец конфига в корень проекта
Все детали конфигурации подробно описаны в образце конфига https://github.com/Chetkov/php-clean-architecture/blob/master/example.phpca-config.php, а также в статьях https://habr.com/ru/post/504590/ и https://habr.com/ru/post/686236/
Использование
- Формирование отчета для анализа.
Отчет визуализирует текущее состояние проекта, наглядно отображает взаимосвязи между компонентами, их силу, удалённость компонентов от главной последовательности, а также подсвечивает обнаруженные на основе конфига нежелательные зависимости и прочие архитектурные проблемы.
- Check для CI.
В случае нарушения кодом ограничений, заданных конфигом, информирует об обнаруженных проблемах и завершает выполнение с ошибкой. Рекомендуется добавить запуск этой команды в CI (это гарантирует соответствие кода, попавшего в сборку, настроенным ограничениям)
- Разрешенное состояние.
Команда сохранит текущее состояние проекта, взаимосвязи между существующими классами, в отдельный файл. При последующих запусках phpca-check, проблемы относящиеся к сохраненному состоянию будут проигнорированы.
Это дает возможность легко подключать php-clean-architecture не только к новым проектам, но и к уже существующим, и уже имеющим проблемы, устранение которых требует времени.
- Отчёт/Check по списку файлов
Если вы хотите осуществить проверку на наличие проблем или построить граф зависимостей и провести анализ не по всему проекту, а по некоторой его части (к примеру по списку изменённых файлов), вы можете установить значение переменной окружения PHPCA_ALLOWED_PATHS Пример использования: