- Install on any PHP 7.2-PHP 8.3 project with any dependencies
- Blazing fast with parallel run out of the box
- Use PHP_CodeSniffer or PHP-CS-Fixer - anything you like
- Use prepared sets and PHP CS Fixer sets to save time
composer require symplify/easy-coding-standard --devvendor/bin/ecsOn the first run, ECS creates ecs.php config file with directories and first rule to kick off.
Then you can run again to see the suggested diffs:
vendor/bin/ecsTo actually fix your code, add --fix:
vendor/bin/ecs --fixThat's it!
Most of the time, you'll be happy with the default configuration. The most relevant part is configuring paths, checkers and sets:
use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
use PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer;
use Symplify\EasyCodingStandard\Config\ECSConfig;
return ECSConfig::configure()
->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
->withConfiguredRule(
ArraySyntaxFixer::class,
['syntax' => 'long']
)
->withRules([
ListSyntaxFixer::class,
])
->withPreparedSets(psr12: true);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();Do you want to include one of 44 sets from php-cs-fixer?
You can:
use Symplify\EasyCodingStandard\Config\ECSConfig;
return ECSConfig::configure()
->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
->withPhpCsFixerSets(perCS20: true, doctrineAnnotation: true);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',
]);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.
Do you use ECS across variety of project? Do you want to run them always the same way in each of those project? Let's make use of Composer scripts
This command adds 2 handy scripts to your composer.json:
vendor/bin/ecs scriptsRun them always the same way - to check the code:
composer check-csTo apply fixes, run:
composer fix-csYou 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.junit: JUnit format to be used in different CI environments.checkstyle: Useful for Github Action Reports.gitlab: For Gitlab code quality reports or Code Climate tooling.
For information on how each of these behave, refer to their respective implementations.
vendor/bin/ecs --clear-cachevendor/bin/ecs list-checkersDo you look for json format?
vendor/bin/ecs list-checkers --output-format jsonDo you use another tool and want to migrate? It's pretty straightforward - here is "how to":
- for PHP_CodeSniffer
- and PHP CS Fixer.
