spryker-sdk/architector

Spryker Architector - Spryker 架构内省工具

维护者

详细信息

github.com/spryker-sdk/architector

源代码

问题

安装数: 29,660

依赖项: 6

建议者: 0

安全: 0

星标: 0

关注者: 14

分叉: 0

开放问题: 1

dev-master / 0.1.x-dev 2023-03-02 14:57 UTC

Requires

Requires (Dev)

proprietary 30f22f9f8325c0ab7d4ac5eeab519f3aaa871162

This package is auto-updated.

Last update: 2024-09-23 04:23:31 UTC

README

CI Latest Stable Version Minimum PHP Version PHPStan

安装

composer require --dev spryker-sdk/architector

这是一个仅用于开发的 "require-dev" 库。请确保将其作为此类包含。

什么是 Architector

Architector 是一个支持您进行 Spryker 架构自动化重构并报告代码中问题的工具。

有关详细信息，请参阅 当前规则。

配置

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',
    ]);
};

如何使用 Architector

您可以通过两种方式运行 Architector

vendor/bin/rector process path/to/refactor --config architector.php

或

vendor/bin/rector process path/to/refactor --config architector.php --dry-run

后者仅显示 diff，而不实际更改您的代码。

有关更多详细信息，请参阅 vendor/bin/rector 的文档

如何生成文档

运行 composer docs 以在 docs/rules_overview.md 中生成文档。