New in Symplify 3: 4 Improvements in EasyCodingStandard

Found a typo? Edit me
This post was updated at August 2020 with fresh know-how.
What is new?

Updated with ECS 5, Neon to YAML migration and new simplified skip parameter syntax.
Updated ECS YAML to PHP configuration since ECS 8.


What is new in Easy Coding Standard 3? Nice diffs for fixable sniffs, smart excluding, support for sniff warnings and one more...

1. Exclude Files or Dirs

Do you have src/Migrations that you need to skip from your vendor/bin/ecs check src command?

use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\EasyCodingStandard\ValueObject\Option;

return function (ContainerConfigurator $containerConfigurator): void {
    $parameters = $containerConfigurator->parameters();

    $parameters->set(Option::EXCLUDE_PATHS, [
        __DIR__ . '/src/Migrations/*Migration.php',
    ]);
};

With favorite fnmatch() function on board.

2. Warnings are Reported for Specific Sniffs

Check the PR #481

Sniff warnings are skipped by default, because it doesn't make sense to differentiate errors vs warnings. Yet some official Sniffs only produce warnings and that made them useless. Like PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\CommentedOutCodeSniff.

That changed. New property $reportWarningsSniffs in Symplify\EasyCodingStandard\SniffRunner\File\File now lists all sniffs, that report warnings in ECS as well.

Do you miss useful Sniff that reports only warnings? Send PR to add it.

3. Nice and Clear Diff over Boring Table Report

Check the PR #474

Inspired by PHP CS Fixer we've decided to use files diffs everywhere wherever it saves user daunting reading.

When a fixable sniff found an error, ECS reported it like this:

 ------ --------------------------------------------------------------------------------------------
  Line   src/Posts/Year2017/Ast/SomeClass.php
 ------ --------------------------------------------------------------------------------------------
  10     Property $someProperty should use doc block instead of one liner
         (SomeSniff)

But why bother with such detailed text information, if the ECS will fix it to better form anyway?

From now on, it is reported the PHP CS Fixer-way like all the fixers:

@@ -1,14 +1,13 @@
 final class SomeClass
 {
+    /**
+     * @var SomeType
+     */
-    /** @var SomeType */
     private $someProperty;
 }

    ----------- end diff -----------

Applied checkers:

 - SomeSniff

Which one do you prefer?

4. Skip Sniff Codes instead of Whole Sniffs

Check the PR #388

If you wanted to skip specific part of sniff, you had to exclude whole sniff via "skip" option. But what if you liked all the other codes? Now you can:

use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseTypeSniff;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\EasyCodingStandard\ValueObject\Option;

return function (ContainerConfigurator $containerConfigurator): void {
    $parameters = $containerConfigurator->parameters();

    $parameters->set(Option::SKIP, [
        // old in Symplify 2
        LowerCaseTypeSniff::class => null,

        // new in Symplify 3
        LowerCaseTypeSniff::class . '.SpecificCode' => null,

        // new in Symplify 3 - only some files
        LowerCaseTypeSniff::class . '.SpecificCode' => [
            __DIR__ . '/src/Command/*'
        ]
    ]);
};

Thanks @ostrolucky for taking adding fnmatch() skip of files.

Enjoy the news and thanks to the people who push these tools further by every single PR or issue report!


Happy coding!


Have you find this post useful? Do you want more?

Follow me on Twitter, RSS or support me on GitHub Sponsors.