Combine power of PHP_CodeSniffer and PHP CS Fixer in 3 lines

2017-05-03

Right to The Answer

Let's say we want to check arrays. We add first checker that requires short PHP 5.4 [] syntax:

// ecs.php
use Symplify\EasyCodingStandard\Config\ECSConfig;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\DisallowLongArraySyntaxSniff;

return ECSConfig::configure()
    ->withRules([
        DisallowLongArraySyntaxSniff::class,
    ]);

Great start. Then we want to check for trailing commas, so every line has them.

So add one more checker:

// ecs.php
use Symplify\EasyCodingStandard\Config\ECSConfig;
use PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\DisallowLongArraySyntaxSniff;
use PhpCsFixer\Fixer\ArrayNotation\TrailingCommaInMultilineArrayFixer;

return ECSConfig::configure()
    ->withRules([
        DisallowLongArraySyntaxSniff::class,
        TrailingCommaInMultilineArrayFixer::class,
    ]);

Great job! You have just combined PHP_CodeSniffer and PHP CS Fixer in 3 lines.

With a help of ECS. Now, when title promise is fulfilled, I will show how to install it, run it and how nice and clear reports it generates.

How to add ECS in 3 steps

1. Install Package

composer require symplify/easy-coding-standard --dev

2. Configure

Create a ecs.php file in your project and desired checkers as above.

You can add a comment to groups, so everyone can easily orientate when there are more checkers.

Be Lazy with PHP

Do you use PHPStorm? Just use PHP to autocomplete everything as you're used to since ECS 8.

No more looking to documentation, what string matches what sniff or fixer, if there are any checkers for arrays or debugging typos.

3. Run it

vendor/bin/ecs check src

4. Fix it

vendor/bin/ecs check src --fix

That's all for short ECS intro.

Do you want to know more? Learn how to write own sniff or even better - a fixer.

Happy coding!

---

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