qossmic / deptrac
Deptrac是一款静态代码分析工具，可以帮助强制实施软件层之间依赖关系的规则。
Requires
- php: ^8.1
- ext-json: *
Suggests
- ext-dom: For using the JUnit output formatter
- dev-main
- 3.0.x-dev
- 2.0.x-dev
- 2.0.1
- 2.0.0
- 2.0.0.beta
- 2.0.0-alpha
- 1.0.x-dev
- 1.0.3
- 1.0.2
- 1.0.1
- 1.0.0
- 0.24.0
- 0.23.0
- 0.22.1
- 0.22.0
- 0.21.1
- 0.21.0
- 0.20.0
- 0.19.3
- 0.19.2
- 0.19.1
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.2
- 0.15.1
- 0.15.0
- 0.14.1
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.1
- 0.11.0
- 0.10.3
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.0
- 0.8.2
- 0.8.1
- 0.8.0
- 0.7.1
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- dev-poc/scoped-deptrac-src
This package is auto-updated.
Last update: 2024-09-10 11:24:39 UTC
README
Deptrac是一款针对PHP的静态代码分析工具，可以帮助你在项目中传达、可视化和实施架构决策。你可以自由定义你的架构层以及应应用于它们的规则。
例如，你可以使用Deptrac来确保项目中捆绑/模块/扩展之间的真正独立，以便更容易重用。
Deptrac可以用于CI管道中，以确保拉取请求没有违反你定义的任何架构规则。通过可选的Graphviz或Mermaidjs格式化程序，你可以可视化你的层、规则和违规。
文档
您可以在/docs目录中找到文档或访问文档页面：[https://qossmic.github.io/deptrac](https://qossmic.github.io/deptrac)
入门
您可以通过Composer安装Deptrac。我们建议使用[deptrac](https://github.com/qossmic/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](https://github.com/nikic/PHP-Parser)可以解析它，您就可以分析需要较旧PHP版本的项目的代码。
如何贡献
请参阅贡献指南或前往开发仓库qossmic/deptrac-src。