README

本软件包为Craft CMS插件和项目提供Easy Coding Standard配置。

一般来说，我们遵循PSR-12编码风格指南，略有改动

不强制执行多行函数参数规则。（第4.4条）
不强制执行关键字function后面的空格。（第7条）
对于Craft 3项目，不强制执行常量的可见性。

要安装，请在您的插件或项目中运行以下命令

composer config minimum-stability dev

composer config prefer-stable true

composer require craftcms/ecs:dev-main --dev

然后，在您的插件或项目的根目录中添加一个ecs.php文件

<?php

declare(strict_types=1);

use craft\ecs\SetList;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return static function(ECSConfig $ecsConfig): void {
    $ecsConfig->parallel();
    $ecsConfig->paths([
        __DIR__ . '/src',
        __FILE__,
    ]);

    $ecsConfig->sets([SetList::CRAFT_CMS_3]); // for Craft 3 projects
    $ecsConfig->sets([SetList::CRAFT_CMS_4]); // for Craft 4 projects
};

调整PATHS值以包括所有源代码/测试代码位置，并根据是Craft 3还是Craft 4，删除适当的SetList选项。

设置完成后，您可以使用以下命令检查您的插件/项目的代码

vendor/bin/ecs check

并且要自动修复它，请传递--fix参数

vendor/bin/ecs check --fix

您还可能需要在composer.json中定义check-cs和fix-cs脚本

{
  "...": "...",
  "scripts": {
    "check-cs": "ecs check --ansi",
    "fix-cs": "ecs check --ansi --fix"
  }
}

然后，您可以使用composer run-script执行ECS

composer run-script check-cs
composer run-script fix-cs

craftcms / ecs

维护者

详细信息

README