README

Deptrac 是一个 PHP 静态代码分析工具，有助于您在项目中传达、可视化和实施架构决策。您可以在类上自由定义您的架构层及其应应用的规则。

例如，您可以使用 Deptrac 确保项目中的束/模块/扩展真正相互独立，以便更容易重用。

Deptrac 可以用于 CI 流水中，确保合并请求没有违反您定义的任何架构规则。使用可选的 Graphviz 或 Mermaidjs 格式化程序，您可以可视化您的层、规则和违规。

文档

您可以在 /docs 目录中找到文档或访问文档页面： https://qossmic.github.io/deptrac

您可以通过 Composer 安装 Deptrac。我们建议使用 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。

只要 nikic/php-parser 可以解析它，您就可以分析需要较旧 PHP 版本的项目。