spryker-sdk / architector
Spryker Architector - tool for Spryker Architecture introspection
Installs: 29 940
Dependents: 6
Suggesters: 0
Security: 0
Stars: 0
Watchers: 14
Forks: 0
Open Issues: 1
Requires
- php: >=8.0
- rector/rector: ^0.15.19
- symplify/rule-doc-generator: ^10.0.0 || ^11.0.0
Requires (Dev)
- codeception/codeception: ^5.0.0
- spryker/code-sniffer: ^0.17.18
This package is auto-updated.
Last update: 2024-11-19 08:44:35 UTC
README
Installation
composer require --dev spryker-sdk/architector
This is a development only "require-dev" library. Please make sure you include it as such.
What is the Architector
The Architector is a tool that supports you in automated refactorings regarding Spryker architecture and reports issues in your code.
See current rules for details.
Configuration
architector.php
<?php
use Rector\Config\RectorConfig;
use Rector\Set\ValueObject\SetList;
use Architector\Set\ValueObject\ArchitectorSetList;
return static function (RectorConfig $rectorConfig) {
// Import RuleSets provided by Rector or by the Architector
$rectorConfig->import(SetList::DEAD_CODE);
$rectorConfig->import(SetList::EARLY_RETURN);
$rectorConfig->import(SetList::PHP_74);
$rectorConfig->import(SetList::NAMING);
$rectorConfig->import(ArchitectorSetList::RENAME);
$rectorConfig->import(ArchitectorSetList::CODECEPTION);
// Defining rules or paths to skip
$rectorConfig->skip([
RuleClassNameToSkip::class,
__DIR__ . '/src/Path/To/Exclude/Something.php',
]);
};
How to use the Architector
You can run the Architector in two ways
vendor/bin/rector process path/to/refactor --config architector.php
or
vendor/bin/rector process path/to/refactor --config architector.php --dry-run
The latter one only shows a diff without actually changing your code.
For more details see documentation of vendor/bin/rector
How to generate documentation
Run composer docs
to generate documentation in docs/rules_overview.md
.