symplify / easy-coding-standard
Use Coding Standard with 0-knowledge of PHP-CS-Fixer and PHP_CodeSniffer.
Fund package maintenance!
tomasvotruba
www.paypal.me/rectorphp
Requires
- php: >=7.3
- composer/xdebug-handler: ^1.4
- friendsofphp/php-cs-fixer: ^2.18.5
- jean85/pretty-package-versions: ^1.6|^2.0.1
- nette/robot-loader: ^3.3
- nette/utils: ^3.2
- ocramius/package-versions: ^1.4
- psr/simple-cache: ^1.0
- squizlabs/php_codesniffer: ^3.5
- symfony/cache: ^4.4|^5.2
- symfony/config: ^4.4|^5.2
- symfony/console: ^4.4|^5.2
- symfony/dependency-injection: ^5.2
- symfony/finder: ^4.4|^5.2
- symfony/http-kernel: ^4.4|^5.2
- symplify/autowire-array-parameter: ^9.2.18
- symplify/coding-standard: ^9.2.18
- symplify/console-color-diff: ^9.2.18
- symplify/easy-testing: ^9.2.18
- symplify/package-builder: ^9.2.18
- symplify/set-config-resolver: ^9.2.18
- symplify/skipper: ^9.2.18
- symplify/smart-file-system: ^9.2.18
- symplify/symplify-kernel: ^9.2.18
Requires (Dev)
- phpunit/phpunit: ^9.5
- symplify/easy-coding-standard-tester: ^9.2.18
- symplify/php-config-printer: ^9.2.18
- dev-main / 9.3.x-dev
- v9.2.18
- v9.2.17
- v9.2.16
- v9.2.15
- v9.2.14
- v9.2.13
- v9.2.12
- v9.2.11
- v9.2.10
- v9.2.9
- v9.2.8
- v9.2.7
- v9.2.6
- v9.2.5
- v9.2.4
- v9.2.3
- v9.2.2
- 9.2.1
- 9.2.0
- 9.1.9
- 9.1.8
- 9.1.7
- 9.1.6
- 9.1.5
- 9.1.4
- 9.1.3
- 9.1.1
- 9.1.0
- 9.0.50
- 9.0.49
- 9.0.48
- 9.0.47
- 9.0.46
- 9.0.45
- 9.0.44
- 9.0.43
- 9.0.42
- 9.0.41
- 9.0.40
- 9.0.39
- 9.0.38
- 9.0.37
- 9.0.36
- 9.0.35
- 9.0.34
- 9.0.33
- 9.0.32
- 9.0.31
- 9.0.30
- 9.0.29
- 9.0.28
- 9.0.27
- 9.0.26
- 9.0.25
- 9.0.24
- 9.0.23
- 9.0.22
- 9.0.21
- 9.0.20
- 9.0.19
- 9.0.18
- 9.0.17
- 9.0.16
- 9.0.15
- 9.0.14
- 9.0.13
- 9.0.12
- 9.0.11
- 9.0.10
- 9.0.9
- 9.0.8
- 9.0.7
- 9.0.6
- 9.0.5
- 9.0.4
- 9.0.3
- 9.0.2
- 9.0.1
- 9.0.0
- 9.0.0-rc1
- 9.0.0-BETA9
- 9.0.0-BETA8
- 9.0.0-BETA7
- 9.0.0-BETA6
- 9.0.0-BETA5
- 9.0.0-BETA4
- 9.0.0-BETA3
- 9.0.0-BETA2
- 9.0.0-BETA1
- 8.3.48
- 8.3.47
- 8.3.46
- 8.3.45
- 8.3.44
- 8.3.43
- 8.3.42
- 8.3.41
- 8.3.40
- 8.3.39
- 8.3.38
- 8.3.37
- 8.3.36
- 8.3.35
- 8.3.34
- 8.3.33
- 8.3.32
- 8.3.31
- 8.3.30
- 8.3.29
- 8.3.28
- 8.3.27
- 8.3.26
- 8.3.25
- 8.3.24
- 8.3.23
- 8.3.22
- 8.3.21
- 8.3.20
- 8.3.19
- 8.3.18
- 8.3.17
- 8.3.16
- 8.3.15
- 8.3.14
- 8.3.13
- 8.3.12
- 8.3.11
- 8.3.10
- 8.3.7
- 8.3.6
- 8.3.5
- 8.3.4
- 8.3.3
- 8.3.2
- 8.3.1
- 8.3.0
- 8.2.27
- 8.2.26
- 8.2.25
- 8.2.24
- 8.2.22
- 8.2.21
- 8.2.20
- 8.2.19
- 8.2.18
- 8.2.17
- v8.2.16
- v8.2.15
- v8.2.14
- v8.2.13
- v8.2.12
- v8.2.11
- v8.2.10
- v8.2.9
- v8.2.8
- v8.2.7
- v8.2.6
- v8.2.5
- v8.2.4
- v8.2.3
- v8.2.2
- v8.2.1
- v8.2.0
- v8.1.20
- v8.1.19
- v8.1.18
- v8.1.17
- v8.1.16
- v8.1.15
- v8.1.14
- v8.1.13
- v8.1.12
- v8.1.11
- v8.1.10
- v8.1.9
- v8.1.8
- v8.1.7
- v8.1.6
- v8.1.4
- v8.1.3
- v8.1.2
- v8.1.1
- v8.1.0
- v8.0.1
- v8.0.0
- v8.0.0-beta4
- v8.0.0-beta3
- v8.0.0-beta2
- v8.0.0-beta1
- v7.3.18
- v7.3.17
- v7.3.16
- v7.3.15
- v7.3.14
- v7.3.13
- v7.3.11
- v7.3.10
- v7.3.9
- v7.3.8
- v7.3.7
- v7.3.6
- v7.3.5
- v7.3.4
- v7.3.3
- v7.3.2
- v7.3.1
- v7.3.0
- v7.2.20
- v7.2.19
- v7.2.18
- v7.2.17
- v7.2.16
- v7.2.15
- v7.2.14
- v7.2.13
- v7.2.12
- v7.2.11
- v7.2.10
- v7.2.8
- v7.2.7
- v7.2.6
- v7.2.5
- v7.2.4
- v7.2.3
- v7.2.2
- v7.2.1
- v7.2.0
- v7.1.3
- v7.1.2
- v7.1.1
- v7.1.0
- v7.0.2
- v7.0.1
- v7.0.0
- v6.1.0
- v6.0.5
- v6.0.4
- v6.0.3
- v6.0.2
- v6.0.1
- v6.0.0
- v5.4.16
- v5.4.15
- v5.4.14
- v5.4.13
- v5.4.12
- v5.4.11
- v5.4.10
- v5.4.9
- v5.4.8
- v5.4.7
- v5.4.6
- v5.4.5
- v5.4.4
- v5.4.3
- v5.4.2
- v5.4.1
- v5.4.0
- v5.3.12
- v5.3.11
- v5.3.10
- v5.3.9
- v5.3.8
- v5.3.7
- v5.3.6
- v5.3.5
- v5.3.4
- v5.3.2
- v5.3.1
- v5.3.0
- v5.2.22
- v5.2.20
- v5.2.19
- v5.2.18
- v5.2.17
- v5.2.16
- v5.2.15
- v5.2.14
- v5.2.13
- v5.2.12
- v5.2.11
- v5.2.10
- v5.2.9
- v5.2.8
- v5.2.7
- v5.2.6
- v5.2.5
- v5.2.4
- v5.2.3
- v5.2.2
- v5.2.1
- v5.2.0
- v5.1.4
- v5.1.3
- v5.1.2
- v5.1.1
- v5.1.0
- v5.0.2
- v5.0.1
- v5.0.0
- v4.8.0
- v4.7.0
- v4.6.1
- v4.6.0
- v4.5.1
- v4.5.0
- v4.4.2
- v4.4.1
- v4.4.0
- v4.3.0
- v4.2.3
- v4.2.2
- v4.2.1
- v4.2.0
- v4.1.2
- v4.1.1
- v4.1.0
- v4.0.4
- v4.0.3
- v4.0.2
- v4.0.1
- v4.0.0
- v4.0.0beta1
- v4.0.0alpha6
- v4.0.0alpha5
- v4.0.0alpha4
- v4.0.0alpha3
- v4.0.0alpha2
- v4.0.0alpha1
- v3.2.30
- v3.2.29
- v3.2.28
- v3.2.27
- v3.2.26
- v3.2.25
- v3.2.24
- v3.2.23
- v3.2.22
- v3.2.21
- v3.2.20
- v3.2.18
- v3.2.17
- v3.2.15
- v3.2.14
- v3.2.13
- v3.2.12
- v3.2.11
- v3.2.10
- v3.2.9
- v3.2.7
- v3.2.6
- v3.2.5
- v3.2.4
- v3.2.3
- v3.2.2
- v3.2.1
- v3.2.0
- v3.1.2
- v3.1.1
- v3.1.0
- v3.0.8
- v3.0.7
- v3.0.6
- v3.0.5
- v3.0.4
- v3.0.3
- v3.0.2
- v3.0.1
- v3.0.0
- v3.0.0-RC5
- v3.0.0-RC4
- v3.0.0-RC3
- v3.0.0-RC2
- v3.0.0-RC1
- v2.5.12
- v2.5.10
- v2.5.9
- v2.5.8
- v2.5.7
- v2.5.6
- v2.5.5
- v2.5.4
- v2.5.3
- v2.5.2
- v2.5.1
- v2.5.0
- v2.4.3
- v2.4.2
- v2.4.1
- v2.4.0
- v2.3.4
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.15
- v2.2.14
- v2.2.13
- v2.2.12
- v2.2.11
- v2.2.10
- v2.2.9
- v2.2.8
- v2.2.7
- v2.2.6
- v2.2.5
- v2.2.4
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.1
- v2.0.0
- v2.0.0-RC3
- v2.0.0-RC2
- v2.0.0-RC1
- v1.4.10
- v1.4.9
- v1.4.8
- v1.4.7
- v1.4.6
- v1.4.5
- v1.4.4
- v1.4.3
- v1.4.2
- v1.4.1
- v1.4.0
This package is auto-updated.
Last update: 2021-04-16 19:04:41 UTC
README
Features
- Use PHP_CodeSniffer || PHP-CS-Fixer - anything you like
- 2nd run under few seconds with un-changed file cache
- Skipping files for specific checkers
- Prepared sets - PSR12, Symfony, Common, Array, Symplify and more...
- Prefixed version in case of conflicts on install
Are you already using another tool?
- How to Migrate From PHP_CodeSniffer to EasyCodingStandard in 7 Steps
- How to Migrate From PHP CS Fixer to EasyCodingStandard in 6 Steps
Install
composer require symplify/easy-coding-standard --dev
Prefixed Version
Head over to the "Easy Coding Standard Prefixed" repository for more information.
Usage
1. Create Configuration and Setup Checkers
// ecs.php use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer; use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; use Symplify\EasyCodingStandard\ValueObject\Option; use Symplify\EasyCodingStandard\ValueObject\Set\SetList; return static function (ContainerConfigurator $containerConfigurator): void { // A. standalone rule $services = $containerConfigurator->services(); $services->set(ArraySyntaxFixer::class) ->call('configure', [[ 'syntax' => 'short', ]]); // B. full sets $parameters = $containerConfigurator->parameters(); $parameters->set(Option::SETS, [SetList::CLEAN_CODE, SetList::PSR_12]); };
2. Run in CLI
# dry vendor/bin/ecs check src # fix vendor/bin/ecs check src --fix
Features
How to load own config?
vendor/bin/ecs check src --config another-config.php
Configuration
Configuration can be extended with many options. Here is list of them with example values and little description what are they for:
use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer; use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator; use Symplify\EasyCodingStandard\ValueObject\Option; return static function (ContainerConfigurator $containerConfigurator): void { $parameters = $containerConfigurator->parameters(); // alternative to CLI arguments, easier to maintain and extend $parameters->set(Option::PATHS, [__DIR__ . '/src', __DIR__ . '/tests']); // run single rule only on specific path $parameters->set(Option::ONLY, [ ArraySyntaxFixer::class => [__DIR__ . '/src/NewCode'], ]); $parameters->set(Option::SKIP, [ // skip paths with legacy code __DIR__ . '/packages/*/src/Legacy', ArraySyntaxFixer::class => [ // path to file (you can copy this from error report) __DIR__ . '/packages/EasyCodingStandard/packages/SniffRunner/src/File/File.php', // or multiple files by path to match against "fnmatch()" __DIR__ . '/packages/*/src/Command', ], // skip rule completely ArraySyntaxFixer::class, // just single one part of the rule? ArraySyntaxFixer::class . '.SomeSingleOption', // ignore specific error message 'Cognitive complexity for method "addAction" is 13 but has to be less than or equal to 8.', ]); // scan other file extendsions; [default: [php]] $parameters->set(Option::FILE_EXTENSIONS, ['php', 'phpt']); // configure cache paths & namespace - useful for Gitlab CI caching, where getcwd() produces always different path // [default: sys_get_temp_dir() . '/_changed_files_detector_tests'] $parameters->set(Option::CACHE_DIRECTORY, '.ecs_cache'); // [default: \Nette\Utils\Strings::webalize(getcwd())'] $parameters->set(Option::CACHE_NAMESPACE, 'my_project_namespace'); // indent and tabs/spaces // [default: spaces] $parameters->set(Option::INDENTATION, 'tab'); // [default: PHP_EOL]; other options: "\n" $parameters->set(Option::LINE_ENDING, "\r\n"); };
Codings Standards in Markdown
How to correct PHP snippets in Markdown files?
vendor/bin/ecs check-markdown README.md
vendor/bin/ecs check-markdown README.md docs/rules.md
# to fix them, add --fix
vendor/bin/ecs check-markdown README.md docs/rules.md --fix
Do you have already paths defined in ecs.php
config? Drop them from CLI and let ECS use those:
vendor/bin/ecs check-markdown --fix
FAQ
How can I see all loaded checkers?
vendor/bin/ecs show vendor/bin/ecs show --config ...
How do I clear cache?
vendor/bin/ecs check src --clear-cache
Run on Git Diff Changed Files Only
Execution can be limited to changed files using the process
option --match-git-diff
:
vendor/bin/ecs check src --match-git-diff
This option will filter the files included by the configuration, creating an intersection with the files listed in git diff
.
Your IDE Integration
PHPStorm
ECS can be used as an External Tool
Go to Preferences
> Tools
> External Tools
and click +
to add a new tool.
- Name:
ecs
(Can be any value) - Description:
easyCodingStandard
(Can be any value) - Program:
$ProjectFileDir$/vendor/bin/ecs
(Path toecs
executable; On Windows path separators must be a\
) - Parameters:
check $FilePathRelativeToProjectRoot$
(append--fix
to auto-fix) - Working directory:
$ProjectFileDir$
Press Cmd/Ctrl
+ Shift
+ A
(Find Action), search for ecs
, and then hit Enter. It will run ecs
for the current file.
To run ecs
on a directory, right click on a folder in the project browser go to external tools and select ecs
.
You can also create a keyboard shortcut in Preferences > Keymap to run ecs
.
Visual Studio Code
EasyCodingStandard for Visual Studio Code extension adds support for running EasyCodingStandard inside the editor.
Tool Integration
Tool | Extension | Description |
---|---|---|
GrumPHP | ECS Task | Provides a new task for GrumPHP which runs ECS |
Report Issues
In case you are experiencing a bug or want to request a new feature head over to the Symplify monorepo issue tracker
Contribute
The sources of this package are contained in the Symplify monorepo. We welcome contributions for this package on symplify/symplify.