backendtea / architect
针对您的代码库进行架构检查
0.0.1
2024-08-17 08:51 UTC
Requires
- php: ^8.1
- nikic/php-parser: ^4.18|^5.1
- psr/container: ^2.0
- roave/better-reflection: ^6.25
- symfony/console: ^6.4||^7.1
- symfony/filesystem: ^6.4||^7.1
- symfony/finder: ^6.4||^7.1
Requires (Dev)
- doctrine/coding-standard: ^12.0
- phpstan/extension-installer: ^1.4
- phpstan/phpstan: ^1.11
- phpstan/phpstan-phpunit: ^1.4
- phpunit/phpunit: ^10.0||^11.0
README
Architect 帮助您在 PHP 项目中强制执行架构决策。
例如,您可以强制 src/
文件夹不使用 test/
文件夹,或者您可以强制执行分层架构,将代码分割为 Domain
、Application
和 Infrastructure
层,其中层只能有向内的依赖。
Architect 目前正处于测试阶段,所以任何反馈都非常有帮助。
安装
composer require backendtea/architect --dev
使用
配置
Architect 使用 php 配置文件,默认情况下使用当前目录下的 architect.php
。如果您希望使用其他文件,可以使用 -c
标志。
一个基本的配置文件,用于检查 src
和 tests
文件夹中的文件,并包含 分层架构
和 无 src 到 test
规则集。
<?php use BackEndTea\Architect\Domain\Config\ConfigurationBuilder; use BackEndTea\Architect\Domain\Rule\RuleFactory; use Symfony\Component\Finder\Finder; return ConfigurationBuilder::create() ->paths(Finder::create() ->in('src') ->in('tests') ->name('*.php') ->files()) ->addRule( RuleFactory::layeredArchitecture(), RuleFactory::noSrcToTest(), ) ;
运行 Architect
当您有配置文件时,可以使用以下命令运行 architect:
vendor/bin/architect