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

# 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 文件
• 安全指南 - 如何报告安全漏洞