Updated ECS to commit 4ceffb16a07f40f0d107ad4e4a6e230b1e13dea3

Author: TomasVotruba

README.md

@@ -1 +1,249 @@
-override
+# The Easiest way to use Coding Standard
+
+[![Downloads total](https://img.shields.io/packagist/dt/symplify/easy-coding-standard.svg?style=flat-square)](https://packagist.org/packages/symplify/easy-coding-standard/stats)
+
+Easy Coding Standard (ECS) is a single tool that runs [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) and [PHP-CS-Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) rules together, configured through one simple PHP file.
+
+> [!NOTE]
+> This is the **deployed** package. Development happens in the [symplify/easy-coding-standard](https://github.com/easy-coding-standard/easy-coding-standard) repository - report issues and send pull requests there.
+
+<br>
+
+## 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](https://tomasvotruba.com/blog/2017/05/03/combine-power-of-php-code-sniffer-and-php-cs-fixer-in-3-lines/) - anything you like
+- Use **prepared sets** and [PHP CS Fixer sets](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/index.rst) to save time
+
+<br>
+
+## Install
+
+```bash
+composer require symplify/easy-coding-standard --dev
+```
+
+<br>
+
+## Usage
+
+```bash
+vendor/bin/ecs
+```
+
+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:
+
+```bash
+vendor/bin/ecs
+```
+
+To actually **fix your code**, add `--fix`:
+
+```bash
+vendor/bin/ecs --fix
+```
+
+That's it!
+
+<br>
+
+## Configure
+
+Most of the time, you'll be happy with the default configuration. The most relevant part is configuring paths, checkers and sets:
+
+```php
+use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
+use PhpCsFixer\Fixer\ListNotation\ListSyntaxFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return ECSConfig::configure()
+    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
+
+    // start slow with sole rules
+    ->withRules([
+        ListSyntaxFixer::class,
+    ])
+    ->withConfiguredRule(
+        ArraySyntaxFixer::class,
+        ['syntax' => 'long']
+    )
+
+    // apply full set
+    ->withPreparedSets(psr12: true);
+```
+
+<br>
+
+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:
+
+```php
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return ECSConfig::configure()
+    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
+    ->withRootFiles();
+```
+
+<br>
+
+Do you want to include one of sets from [php-cs-fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/ruleSets/index.rst)?
+
+You can:
+
+```php
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+
+return ECSConfig::configure()
+    ->withPaths([__DIR__ . '/src', __DIR__ . '/tests'])
+    ->withPhpCsFixerSets(perCS20: true, doctrineAnnotation: true);
+```
+
+<br>
+
+### 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:
+
+```php
+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.
+
+<br>
+
+### How to Skip Files/Rules?
+
+Love the sets of rules, but want to skip single rule or some files?
+
+```php
+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',
+    ]);
+```
+
+<br>
+
+### Less Common Options
+
+You probably won't use these, but they can give you more control over the internal process:
+
+```php
+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.
+
+<br>
+
+### 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.
+- `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.
+
+You can use the output format option as below
+
+```bash
+vendor/bin/ecs --output-format=checkstyle
+```
+
+<br>
+
+## FAQ
+
+### How do I clear cache?
+
+```bash
+vendor/bin/ecs --clear-cache
+```
+
+### How can I see all used rules?
+
+```bash
+vendor/bin/ecs list-checkers
+```
+
+Do you look for json format?
+
+```bash
+vendor/bin/ecs list-checkers --output-format json
+```
+
+<br>
+
+### Can I Use My [`.editorconfig`](https://editorconfig.org/)?
+
+Mostly! By using `->withEditorConfig()` in `ecs.php`, ECS will automatically discover
+the `.editorconfig` file in the project's root directory. It will use any
+rules under `[*]` or `[*.php]` (the latter taking priority) and respect the
+settings for:
+
+-   `indent_style`
+-   `end_of_line`
+-   `max_line_length`
+-   `trim_trailing_whitespace`
+-   `insert_final_newline`
+-   [`quote_type`](https://github.com/jednano/codepainter#quote_type-single-double-auto)
+    -   Only `single` and `auto` are respected.
+    -   Warning: this is a proposed field, but not fully standard.
+
+These settings will take precedence over similar rules configured through sets
+like PSR12, to avoid conflicting with other tooling using your `.editorconfig`.
+
+<br>
+
+## 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](https://tomasvotruba.com/blog/2018/06/04/how-to-migrate-from-php-code-sniffer-to-easy-coding-standard)
+* and [PHP CS Fixer](https://tomasvotruba.com/blog/2018/06/07/how-to-migrate-from-php-cs-fixer-to-easy-coding-standard).

bin/ecs

@@ -1,5 +1,5 @@
 #!/usr/bin/env php
 <?php 
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 require __DIR__ . '/ecs.php';

bin/ecs.php

@@ -1,12 +1,12 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 // decoupled in own "*.php" file, so ECS, Rector and PHPStan works out of the box here
 use PHP_CodeSniffer\Util\Tokens;
-use ECSPrefix202605\Symfony\Component\Console\Command\Command;
-use ECSPrefix202605\Symfony\Component\Console\Input\ArgvInput;
+use ECSPrefix202606\Symfony\Component\Console\Command\Command;
+use ECSPrefix202606\Symfony\Component\Console\Input\ArgvInput;
 use Symplify\EasyCodingStandard\Console\EasyCodingStandardConsoleApplication;
 use Symplify\EasyCodingStandard\Console\Style\SymfonyStyleFactory;
 use Symplify\EasyCodingStandard\DependencyInjection\EasyCodingStandardContainerFactory;
@@ -119,7 +119,7 @@ public function loadIfNotLoadedYet(string $file): void
 /**
  * Inspired by https://github.com/rectorphp/rector/pull/2373/files#diff-0fc04a2bb7928cac4ae339d5a8bf67f3
  */
-\class_alias('ECSPrefix202605\ECSAutoloadIncluder', 'ECSAutoloadIncluder', \false);
+\class_alias('ECSPrefix202606\ECSAutoloadIncluder', 'ECSAutoloadIncluder', \false);
 try {
     $input = new ArgvInput();
     $ecsContainerFactory = new EasyCodingStandardContainerFactory();

bin/generate-php-cs-fixer-tests.php

@@ -1,24 +1,24 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use PhpCsFixer\RuleSet\RuleSets;
-use ECSPrefix202605\PhpParser\Modifiers;
-use ECSPrefix202605\PhpParser\Node\Expr\ArrayDimFetch;
-use ECSPrefix202605\PhpParser\Node\Expr\Assign;
-use ECSPrefix202605\PhpParser\Node\Expr\ConstFetch;
-use ECSPrefix202605\PhpParser\Node\Expr\PropertyFetch;
-use ECSPrefix202605\PhpParser\Node\Expr\Variable;
-use ECSPrefix202605\PhpParser\Node\Identifier;
-use ECSPrefix202605\PhpParser\Node\Name;
-use ECSPrefix202605\PhpParser\Node\Param;
-use ECSPrefix202605\PhpParser\Node\Scalar\String_;
-use ECSPrefix202605\PhpParser\Node\Stmt\ClassMethod;
-use ECSPrefix202605\PhpParser\Node\Stmt\Expression;
-use ECSPrefix202605\PhpParser\Node\Stmt\If_;
-use ECSPrefix202605\PhpParser\Node\Stmt\Return_;
-use ECSPrefix202605\PhpParser\PrettyPrinter\Standard;
+use ECSPrefix202606\PhpParser\Modifiers;
+use ECSPrefix202606\PhpParser\Node\Expr\ArrayDimFetch;
+use ECSPrefix202606\PhpParser\Node\Expr\Assign;
+use ECSPrefix202606\PhpParser\Node\Expr\ConstFetch;
+use ECSPrefix202606\PhpParser\Node\Expr\PropertyFetch;
+use ECSPrefix202606\PhpParser\Node\Expr\Variable;
+use ECSPrefix202606\PhpParser\Node\Identifier;
+use ECSPrefix202606\PhpParser\Node\Name;
+use ECSPrefix202606\PhpParser\Node\Param;
+use ECSPrefix202606\PhpParser\Node\Scalar\String_;
+use ECSPrefix202606\PhpParser\Node\Stmt\ClassMethod;
+use ECSPrefix202606\PhpParser\Node\Stmt\Expression;
+use ECSPrefix202606\PhpParser\Node\Stmt\If_;
+use ECSPrefix202606\PhpParser\Node\Stmt\Return_;
+use ECSPrefix202606\PhpParser\PrettyPrinter\Standard;
 // this helper script generates the withPhpCsFixerSets() method for ECSConfigBuilder class
 require __DIR__ . '/../vendor/autoload.php';
 $setsDirectory = __DIR__ . '/../vendor/friendsofphp/php-cs-fixer/src/RuleSet/Sets/';

config/config.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use Symplify\EasyCodingStandard\Application\Version\StaticVersionResolver;
 use Symplify\EasyCodingStandard\Config\ECSConfig;

config/set/clean-code.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use PhpCsFixer\Fixer\ArrayNotation\ArraySyntaxFixer;
 use PhpCsFixer\Fixer\ClassNotation\ProtectedToPrivateFixer;

config/set/common.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;

config/set/common/array.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\Config\Level\ArrayLevel;

config/set/common/comments.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use PHP_CodeSniffer\Standards\Generic\Sniffs\VersionControl\GitMergeConflictSniff;
 use Symplify\EasyCodingStandard\Config\ECSConfig;

config/set/common/control-structures.php

@@ -1,7 +1,7 @@
 <?php
 
 declare (strict_types=1);
-namespace ECSPrefix202605;
+namespace ECSPrefix202606;
 
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\Config\Level\ControlStructuresLevel;