Skip to content
ecsphpPublic

About

Checks Symfony in 3 seconds ⚡ PHP-CS-Fixer + PHP_CodeSniffer in one parallel tool, zero dependencies. PSR-12, PER-CS and Laravel sets ready to use. PHP 7.2–8.5.

Topics

Resources

Stars

1.6k stars

Watchers

19 watching

Forks

Latest commit

 

History

747 Commits

Folders and files

Repository files navigation

The Fastest Coding Standard for PHP

Downloads total

Easy Coding Standard (ECS) is a single tool that runs PHP_CodeSniffer and PHP-CS-Fixer rules together, configured through one simple PHP file.

Fixes all of Symfony in 3 seconds. php-cs-fixer and PHP_CodeSniffer take over 2 minutes.

--fix on a fresh clone Symfony src (13,103 files) Laravel src (1,749 files)
ECS 2.9 s 1.0 s
php-cs-fixer 141.6 s 25.8 s
PHP_CodeSniffer 133.7 s 26.7 s

See full benchmark.


Killer Features

  • Blazing fast - fixes all 13,103 files of Symfony in 2.9 s, 49x faster than php-cs-fixer (141.6 s)
  • Install on any PHP 7.2-PHP 8.5 project with any dependencies
  • Use 13 prepared sets to save time
  • Use PHP-CS-Fixer or PHP_CodeSniffer - anything you like

Install

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

Usage

vendor/bin/ecs

The first run creates an ecs.php config with your directories and a first rule. Run it again to see suggested diffs - then add --fix to apply them:

vendor/bin/ecs --fix

Check specific paths instead of the configured ones by passing them as arguments:

vendor/bin/ecs src tests

That's it!


Blazing fast with --blink

ECS bundles a Go engine ("blink") that applies the same rules as the PHP run, across all CPU cores. Pass --blink to use it:

vendor/bin/ecs check --blink          # report
vendor/bin/ecs check --blink --fix    # rewrite in place

When every rule in your ecs.php is covered by the Go engine, a plain vendor/bin/ecs check uses it automatically and falls back to the PHP engine otherwise.

Wall-clock --fix over a fresh clone, each tool with a representative rule set (ECS and phpcbf run across all cores; php-cs-fixer runs sequentially, as shipped):

engine symfony src (13,103 files) laravel src (1,749 files)
ECS 2.9 s 1.0 s
php-cs-fixer (@PER-CS, @Symfony) 141.6 s 25.8 s
PHP_CodeSniffer (phpcbf, PSR-12) 133.7 s 26.7 s

Different tools apply different rules, so this compares each at a representative job, not rule for rule. Numbers vary with hardware.


Configure

Most of the time, you'll be happy with the default configuration. The most relevant part is configuring paths and sets.

Prepared Sets

->withPreparedSets() bundles curated rule sets. Enable the whole common set, or pick single topics:

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withPreparedSets(
        arrays: true,
        spaces: true,
        namespaces: true,
        docblocks: true,
        controlStructures: true,
        comments: true,
        casing: true,
        cleanup: true,
    );

Standalone sets, not part of common:

Set What it covers
psr12 the PSR-12 coding style
perCs the PER Coding Style (PHP-CS-Fixer's @PER-CS)
standaloneLine each constructor param on its own line
laravel the Laravel Pint ruleset
use Symplify\EasyCodingStandard\Config\ECSConfig;

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

common: true enables all of these at once:

Set What it covers
arrays array syntax, spacing, trailing commas, indentation
spaces whitespace, operator/type spacing, blank lines
namespaces imports ordering, unused/needless-alias imports
docblocks phpdoc tags, types, alignment, cleanup
controlStructures control flow, casing, operators, class structure
comments comment style, spacing, empty-comment cleanup
casing native function/type, magic method, literal casing
cleanup dead statements, useless returns/casts, unused closure imports
cleanCode dead code, unused imports, redundant syntax

Single Rules

Prefer to start slow? Pick single rules, and configure them if needed:

use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withRules([
        ListSyntaxFixer::class,
    ])
    ->withConfiguredRule(
        ArraySyntaxFixer::class,
        ['syntax' => 'long']
    );

Check All Root Files

Do you want to check all *.php files in your root (ecs.php, rector.php etc.)? Instead of listing them one by one, use ->withRootFiles() method:

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withRootFiles();

Gradual Adoption with Levels

Want to adopt a coding standard step by step instead of all at once? Use with*Level() methods to start from the safest rules and raise the level as your codebase catches up:

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
    ->withSpacesLevel(0)
    ->withArrayLevel(0)
    ->withControlStructuresLevel(0)
    ->withDocblockLevel(0);

Each level enables the first N+1 rules from a curated list, ordered from safest to most invasive. Bump the number once your codebase is clean on the current level.


How to Skip Files/Rules?

Love the sets of rules, but want to skip single rule or some files?

use Symplify\EasyCodingStandard\Config\ECSConfig;

return ECSConfig::configure()
    ->withSkip([
        // skip single rule
        ArraySyntaxFixer::class,

        // skip single rule in specific paths
        ArraySyntaxFixer::class => [
            __DIR__ . '/src/ValueObject/',
        ],

        // skip directory by absolute or * mask
        __DIR__ . '/src/Migrations',

        // skip directories by mask
        __DIR__ . '/src/*/Legacy',
    ]);

Less Common Options

You probably won't use these, but they can give you more control over the internal process:

use Symplify\EasyCodingStandard\Config\ECSConfig;
use Symplify\EasyCodingStandard\ValueObject\Option;

return ECSConfig::configure()
    // file extensions to scan
    ->withFileExtensions(['php'])

    // configure cache paths and namespace - useful e.g. Gitlab CI caching, where getcwd() produces always different path
    ->withCache(
        directory: sys_get_temp_dir() . '/_changed_files_detector_tests',
        namespace: getcwd() // normalized to directory separator
    )

    // print contents with specific indent rules
    ->withSpacing(indentation: Option::INDENTATION_SPACES, lineEnding: PHP_EOL)

    // modify parallel run
    ->withParallel(timeoutSeconds: 120, maxNumberOfProcess: 32, jobSize: 20);

Mentioned values are default ones.


Controlling Output Format

You may want to use ECS to generate reports for third-party tooling.

We currently provide formatters for:

  • console: Human-oriented printing à la PHP CS Fixer.
  • json: A custom JSON blob for arbitrary tooling.

You can use the output format option as below

vendor/bin/ecs --output-format=json

FAQ

How do I clear cache?

vendor/bin/ecs --clear-cache

How can I see all used rules?

vendor/bin/ecs list-checkers

Do you look for json format?

vendor/bin/ecs list-checkers --output-format json

This is the deployed package. Development happens in the ecs-src repository - report issues and send pull requests there.

About

Checks Symfony in 3 seconds ⚡ PHP-CS-Fixer + PHP_CodeSniffer in one parallel tool, zero dependencies. PSR-12, PER-CS and Laravel sets ready to use. PHP 7.2–8.5.

Topics

Resources

Stars

1.6k stars

Watchers

19 watching

Forks

Releases

Used by

Contributors

Languages