deptrac

项目介绍

Deptrac 是一个用于 PHP 的静态代码分析工具，它的主要目的是帮助开发者在项目中沟通、可视化并执行架构决策。通过 Deptrac，开发者可以自由定义架构层，并制定相应的规则。例如，Deptrac 可以用于确保项目中的包、模块或扩展是真正独立的，从而便于重用。

功能与特点

Deptrac 能够在持续集成（CI）管道中使用，以确保拉取请求不违反您已定义的架构规则。通过可选的 Graphviz 或 Mermaidjs 格式器，Deptrac 还可以可视化项目中的层、规则和违反情况。这使得开发者能够更直观地理解和维护代码的架构。

快速上手

要开始使用 Deptrac，只需通过 Composer 安装即可。推荐使用 qossmic/deptrac 此包进行安装：

composer require --dev qossmic/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。同时，也可以分析需要旧版本 PHP 的项目，只要 nikic/php-parser 能够解析。

贡献指南

如果有兴趣为 Deptrac 做出贡献，请参见贡献指南或访问开发库 qossmic/deptrac-src。贡献指南提供关于如何进行代码更改、测试运行和构建 phar 文件来分析项目的建议。

深入文档

Deptrac 提供了详细的文档来帮助开发者更好地使用和理解工具：

• 向后兼容性：介绍我们处理向后兼容的方法。
• 升级指南：列出升级时需要注意的向后不兼容改变及其解决方法。
• 核心概念：详细解释层、规则和违规情况。
• 配置：提供所有可用设置的参考。
• 收集器：介绍可用于定义层的收集器。
• 格式器：列出支持的各种输出格式。
• 调试：调试命令的概览。
• 行为准则：我们的社区标准。

通过 Deptrac 的强大功能和丰富文档，开发者可以更高效地管理 PHP 项目的架构。