Download the PHP package symplify/easy-coding-standard without Composer
On this page you can find all versions of the php package symplify/easy-coding-standard. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download symplify/easy-coding-standard
More information about symplify/easy-coding-standard
Files in symplify/easy-coding-standard
Package easy-coding-standard
Short Description Use Coding Standard with 0-knowledge of PHP-CS-Fixer and PHP_CodeSniffer
License MIT
Informations about the package easy-coding-standard
The Easiest way to use Coding Standard
Easy Coding Standard (ECS) is a single tool that runs PHP_CodeSniffer and PHP-CS-Fixer rules together, configured through one simple PHP file.
[!NOTE] This is the deployed package. Development happens in the ecs-src repository - report issues and send pull requests there.
Killer Features
- Install on any PHP 7.2-PHP 8.5 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 to save time
Install
Usage
On 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:
Want to check specific paths instead of the configured ones? Pass them as arguments:
To actually fix your code, add --fix:
That's it!
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:
| 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 |
Or enable everything at once with ->withPreparedSets(common: true).
Standalone presets are also available: psr12: true, perCs: true, cleanCode: true (dead code, unused imports, redundant syntax), standaloneLine: true (each constructor param on its own line), and laravel: true (the Laravel Pint ruleset):
Single Rules
Prefer to start slow? Pick single rules, and configure them if needed:
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:
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:
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?
Less Common Options
You probably won't use these, but they can give you more control over the internal process:
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
FAQ
How do I clear cache?
How can I see all used rules?
Do you look for json format?
How to Migrate from another coding standard tool?
Do you use another tool and want to migrate? It's pretty straightforward - here is "how to":
- for PHP_CodeSniffer
- and PHP CS Fixer.