deptrac

Дептрак

Deptrac — это инструмент статического анализа кода для PHP, который помогает вам общаться, визуализировать и реализовывать архитектурные решения в ваших проектах. Вы можете свободно определять свои архитектурные уровни над классами и правила, которые должны к ним применяться.

Например, вы можете использовать Deptrac, чтобы гарантировать, что пакеты/модули/расширения в вашем проекте действительно независимы друг от друга, чтобы упростить их повторное использование.

Deptrac можно использовать в конвейере CI, чтобы гарантировать, что запрос на включение не нарушает ни одного из определенных вами архитектурных правил. С помощью дополнительного форматтера Graphviz или Mermaidjs вы можете визуализировать слои, правила и нарушения.

Документация

Вы можете найти документацию в каталоге /docs или посетить страницу документации: https://qossmic.github.io/deptrac.

Начиная

Вы можете установить Deptrac через Composer. Мы рекомендуем для этого использовать пакет deptrac:

 composer require --dev qossmic/deptrac

После того, как вы загрузили/установили deptrac, вам нужно будет создать файл конфигурации, в котором вы определите свои уровни и набор правил связи. Этот файл конфигурации написан на YAML или php и по умолчанию хранится под именем deptrac.yaml в корневом каталоге вашего проекта.

Deptrac может сгенерировать для вас шаблон с помощью команды init .

 vendor/bin/deptrac init

Имея этот файл, вы можете проанализировать свой код, выполнив команду analyse :

 vendor/bin/deptrac

# which is equivalent to
vendor/bin/deptrac analyse --config-file=deptrac.yaml

Для запуска Deptrac вам потребуется PHP версии не ниже 8.1.

Вы можете анализировать проекты, для которых требуется более старая версия PHP, если nikic/php-parser может ее анализировать.

Как внести свой вклад

См. руководство по участию или перейдите в репозиторий разработки qossmic/deptrac-src.

Дополнительная документация

• Обратная совместимость — общая информация о том, как мы подходим к обратной совместимости.
• Руководство по обновлению — список обратных изменений, которые необходимо учесть при обновлении Deptrac до новой версии, и способы это сделать.
• Основные понятия — более подробно объясняет уровни, правила и нарушения.
• Конфигурация — ссылка на все доступные настройки в файле depfile.
• Коллекторы — ссылка на коллекторы, доступные в Deptrac для определения ваших слоев.
• Форматтеры — список различных выходных форматов, поддерживаемых Deptrac.
• Отладка — обзор команд отладки
• Кодекс поведения – наши общественные стандарты
• Внесение вклада — советы по внесению изменений в код, например, как запускать тесты или как создавать phar-файл с вашими изменениями, который вы можете использовать для анализа своих проектов.
• Руководство по безопасности – Как сообщить об уязвимостях безопасности