backendtea/architect

Architectural checks for your codebase

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

MIT

• Gert de Pagter

README

Architect helps enforce architectural decisions in your PHP projects.

For example, you can enforce that the src/ folder does not use the test/ folder, or you can enforce a layered architecture, where you split up your code in a Domain, Application, and Infrastructure layer, where layers can only have dependencies inward.

Architect is currently very much in beta, so any provided feedback is really helpful.

Installation

composer require backendtea/architect --dev

Usage

Config

Architect uses a php config file, by default it uses architect.php in the current directory. You can pass another file with the -c flag if so desired.

A basic configuration file, which checks the src and tests folder files, and has the layered architecture and no src to test rulesets.

<?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(),
    )
;

Running Architect

When you have a configuration, you can run architect with:

vendor/bin/architect