Deptrac
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
# 等同于
vendor/bin/deptrac analyse --config-file=deptrac.yaml
运行 Deptrac 至少需要 PHP 8.1。
只要 nikic/php-parser 可以解析,您就可以分析需要较旧 PHP 版本的项目。
如何贡献
请查看贡献指南或前往开发仓库 qossmic/deptrac-src。