Zen Config in ECS 12

2024-01-14

In the previous ECS version, you could run the vendor/bin/ecs command at the very start. If there were no ecs.php config, it would generate it for you:

use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Set\SetList;

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

    $ecsConfig->rules([
        NoUnusedImportsFixer::class,
    ]);

    $ecsConfig->sets([
        SetList::PSR_12,
        SetList::ARRAY,
    ]);
};

So this would be the contents of the generated ecs.php. As you can see, there is some closure, some return of the void, and some SetList enum that contains some constants.

There's quite a lot of code clutter, that makes it hard to see the actual configuration. Inspired by Amazon buy-with-single-click and Laravel 11 single-file config, I decided to simplify the config even more.

Introducing ECSConfig::configure()

In the ECS 12.1 version, we're introducing a simple way to set configuration with the static method ECSConfig::configure(). Type only what you need, and you're done:

use PhpCsFixer\Fixer\Import\NoUnusedImportsFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withRules([
        NoUnusedImportsFixer::class,
    ])
    ->withPreparedSets(psr12: true, arrays: true);

• no constant enum list
• no closure
• no void
• only what you want to configure

The new method withPreparedSets() contains all prepared sets that come with ECS. You can enable them with autocomplete in your IDE. No more copy-pasting from README or looking for the right *Set class.

php-cs-fixer sets? We got you covered

One of the most popular questions we get in the issue tracker is: "How can I use sets from PHP-CS-Fixer in ECS?"

We've added withPhpCsFixerSets() that contains all sets from PHP-CS-Fixer. You can enable them with autocomplete in your IDE:

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withPhpCsFixerSets(perCS20: true, doctrineAnnotation: true);

No more searching documentation for the set names and copy-pasting them to the ECS config. Stay in the config file and enable sets you like.

We actually generate parameters for this method from PHP-CS-Fixer code, so it's always up to date.

Include Root Files

What are the paths we apply coding standards to? Usually, it's the /src and /tests directories. But more often, we also need to apply them to the root files. Then we'll end up with such a long file list:

return ECSConfig::configure()
    ->withPaths([
        __DIR__ . '/src',
        __DIR__ . '/tests',
        __DIR__ . '/ecs.php',
        __DIR__ . '/rector.php',
        __DIR__ . '/scoper.php',
        __DIR__ . '/composer-unused.php',
    ]);

When we add new PHP files to the root and forget... ECS forgets it, too.

In ECS 12, we've added a way to automate this for the future and save you work:

 return ECSConfig::configure()
     ->withPaths([
         __DIR__ . '/src',
         __DIR__ . '/tests',
-        __DIR__ . '/ecs.php',
-        __DIR__ . '/rector.php',
-        __DIR__ . '/scoper.php',
-        __DIR__ . '/composer-unused.php',
-    ]);
+    ])
+    ->withRootFiles();

One more thing...

Do you use ECS across a variety of projects? Do you want to run the coding standard the same way in each project so you don't have to check which tool you're using?

Then you'll probably use composer scripts. Then, we can always run 2 same commands regardless of the tool or project:

composer check-cs

And to fix coding standards:

composer fix-cs

We make this simple with a new command that updates your composer.json for you - just run:

vendor/bin/ecs scripts

It will add these 2 scripts for you:

 {
+    "scripts": {
+        "check-cs": "vendor/bin/ecs check --ansi",
+        "fix-cs": "vendor/bin/ecs check --fix --ansi"
+    }
 }

Including --ansi so we can see pretty colors in CI.

That's it for today. I hope you've enjoyed the new ECS config features - update and try them today.

Happy coding!

---

Do you learn from my contents or use open-souce packages like Rector every day?
Consider supporting it on GitHub Sponsors. I'd really appreciate it!