Easy Coding Standard config for Craft CMs
This package provides Easy Coding Standard configurations for Craft CMS plugins and projects.
In general, we follow the PSR-12 coding style guide, with a couple alterations:
- Multi-line function argument rules aren’t enforced. (¶4.4)
- Spaces after the
functionkeyword aren’t enforced. (¶7) - Visibility is not enforced for constants, for Craft 3 projects.
To install, run the following commands within your plugin or project:
composer config minimum-stability dev
composer config prefer-stable true
composer require craftcms/ecs:dev-main --dev
Then add an ecs.php file to the root of your plugin or project:
<?php
declare(strict_types=1);
use craft\ecs\SetList;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\EasyCodingStandard\ValueObject\Option;
return static function (ContainerConfigurator $containerConfigurator): void {
$parameters = $containerConfigurator->parameters();
$parameters->set(Option::PARALLEL, true);
$parameters->set(Option::PATHS, [
__DIR__ . '/src',
__FILE__,
]);
$containerConfigurator->import(SetList::CRAFT_CMS_3); // for Craft 3 projects
$containerConfigurator->import(SetList::CRAFT_CMS_4); // for Craft 4 projects
};
Adjust the PATHS value to include all source/test code locations, and remove the appropriate SetList option, depending on whether this is for Craft 3 or Craft 4.
With that in place, you can check your plugin/project’s code with the following command:
vendor/bin/ecs check
And to automatically fix it as well, pass the --fix argument:
vendor/bin/ecs check --fix
You might also want to define check-cs and fix-cs scripts in composer.json:
{
"...": "...",
"scripts": {
"check-cs": "ecs check --ansi",
"fix-cs": "ecs check --ansi --fix"
}
}
Then you could execute ECS using composer run-script:
composer run-script check-cs
composer run-script fix-cs
3 Mar 20, 2022
462 Dec 22, 2022
157 Dec 5, 2022
727 Dec 21, 2022
214 Nov 21, 2022
9.9k Jan 5, 2023
9 Aug 15, 2022
102 Oct 24, 2022
3 Dec 2, 2022
7 Nov 29, 2022
3 Nov 24, 2022
224 Nov 29, 2022
1 Feb 21, 2022
240 Jul 18, 2022
84 Dec 14, 2022
393 Feb 25, 2022
474 Dec 31, 2022
50 Jan 6, 2023