Merge pull request #59 from OndraM/feature/readme-update

 Update README to reflect PHP configuration in ECS 9

Author: OndraM

CHANGELOG.md

@@ -5,9 +5,9 @@
 <!-- There is always Unreleased section on the top. Subsections (Added, Changed, Fixed, Removed) should be added as needed. -->
 
 ## Unreleased
+- **[BC break]** Change YAML config to PHP. See [UPGRADE-3.0.md](UPGRADE-3.0.md) for step-by-step upgrade howto.
 - Replace `Symplify\CodingStandard\Sniffs\Naming\[AbstractClassNameSniff, ClassNameSuffixByParentSniff, InterfaceNameSniff and TraitNameSniff]` with equivalent versions backported to this repository.
 - Drop PHP 7.2 support.
-- **[BC break]** Change YAML config to PHP.
 - Upgrade to easy-coding-standard 9.
 
 ## 2.1.0 - 2020-11-25

README.md

@@ -17,11 +17,16 @@ composer require --dev lmc/coding-standard
 
 ## Usage
 
-1. Create `easy-coding-standard.yaml` file in root directory of your project and import the LMC code-style rules:
+1. Create `ecs.php` file in the root directory of your project and import the LMC code-style rules:
 
-```yaml
-imports:
-    - { resource: 'vendor/lmc/coding-standard/easy-coding-standard.yaml' }
+```php
+<?php declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
+};
 ```
 
 2. Run the check command (for `src/` and `tests/` directories):
@@ -37,19 +42,88 @@ vendor/bin/ecs check src/ tests/
         "analyze": [
             "vendor/bin/ecs check src/ tests/ --ansi",
             "[... other scripts, like PHPStan etc.]"
-        ]
+        ],
+        "fix": [
+            "...",
+            "vendor/bin/ecs check ./src/ ./tests/ --ansi --fix"
+        ],
     }
 ```
 
-### Exclude (skip) some checks or files
+Now you will be able to run the fix using `composer analyze` and execute automatic fixes with `composer fix`.
+
+### Add custom checks or override default settings
+
+On top of default code-style rules you are free to add any rules from [PHP-CS-Fixer] or [PHP_CodeSniffer].
+If needed, you can also override some default settings.
+
+Be aware you must add these settings **after** import of the base LMC code-style:
+
+```php
+<?php declare(strict_types=1);
+
+use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitTestAnnotationFixer;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
+
+    $services = $containerConfigurator->services();
+
+    // Enforce line-length to 120 characters
+    $services->set(LineLengthSniff::class)
+        ->property('absoluteLineLimit', 120);
+
+    // Tests must have @test annotation
+    $services->set(PhpUnitTestAnnotationFixer::class)
+        ->call('configure', [['style' => 'annotation']]);
+};
+```
+
+See [EasyCodingStandard docs](https://github.com/symplify/easy-coding-standard#configuration) for more configuration options.
+
+
+### Exclude (skip) checks or files
+
+You can configure your `ecs.php` to entirely skip some files, disable specific checks of suppress specific errors.
+
+Unlike adding/modifying checks, skips must be added **before** import of the base LMC code-style.
+
+```php
+<?php declare(strict_types=1);
+
+use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff;
+use PHP_CodeSniffer\Standards\Squiz\Sniffs\Arrays\ArrayDeclarationSniff;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $parameters = $containerConfigurator->parameters();
+
+    $parameters->set(
+        Option::SKIP,
+        [
+            // Ignore specific check only in specific files
+            ForbiddenFunctionsSniff::class => [__DIR__ . '/src-tests/bootstrap.php'],
+            // Disable check entirely
+            ArrayDeclarationSniff::class,
+            // Skip one file
+            __DIR__ . '/file/to/be/skipped.php',
+            // Skip entire directory
+            __DIR__ . '/ignored/directory/*',
+        ]
+    );
+
+    $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
+};
+```
 
-You can configure EasyCodingStandard via `parameters` section of your `easy-coding-standard.yaml` to:
- - exclude a specific file from all checks (via [`exclude_files`](https://github.com/Symplify/EasyCodingStandard#ignore-what-you-cant-fix))
- - disable specific check completely or for some file(s) or directories (via [`skip`](https://github.com/Symplify/EasyCodingStandard#ignore-what-you-cant-fix))
+See [EasyCodingStandard docs](https://github.com/symplify/easy-coding-standard#configuration) for more configuration options.
 
 ### IDE integration
 
-For integration with PHPStorm etc. follow instructions in EasyCodingStandard [README](https://github.com/Symplify/EasyCodingStandard#your-ide-integration).
+For integration with PHPStorm etc. follow instructions in EasyCodingStandard [README](https://github.com/symplify/easy-coding-standard#your-ide-integration).
 
 ## Changelog
 For latest changes see [CHANGELOG.md](CHANGELOG.md) file. We follow [Semantic Versioning](http://semver.org/).
@@ -59,5 +133,4 @@ This library is open source software licensed under the [MIT license](LICENCE.md
 
 [PHP-CS-Fixer]: https://github.com/FriendsOfPHP/PHP-CS-Fixer
 [PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer
-[EasyCodingStandard]: https://github.com/Symplify/EasyCodingStandard
-[easy-coding-standard.yml]: https://github.com/lmc-eu/php-coding-standard/blob/main/easy-coding-standard.yml
+[EasyCodingStandard]: https://github.com/symplify/easy-coding-standard

UPGRADE-3.0.md

@@ -35,7 +35,8 @@ composer remove symplify/config-transformer --dev # the migration tool can now b
 Because of the nature of how ECS process the configuration (which is, in fact, the behavior of underlying
 symfony/dependency-injection), you must follow the order in which you add your customizations.
 
-In your `ecs.php` add import of the lmc/coding-standard **after** you add `skip` parameter but **before** your custom code-style ajdustements:
+In your `ecs.php` add import of the lmc/coding-standard **after** you add `skip` parameter but **before** your custom
+code-style adjustments:
 
 ```diff
 // ...
@@ -46,7 +47,7 @@ return static function (ContainerConfigurator $containerConfigurator): void {
     $parameters = $containerConfigurator->parameters();
     $parameters->set(Option::SKIP, [__DIR__ . '/foo/bar']);
 
-+    $containerConfigurator->import(__DIR__. '/vendor/lmc/coding-standard/ecs.php');
++    $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
 
     // Your code style customizations and overrides of the default code-style must be placed AFTER the import
     $services->set(PhpUnitExpectationFixer::class)
@@ -66,16 +67,17 @@ return static function (ContainerConfigurator $containerConfigurator): void {
     $parameters = $containerConfigurator->parameters();
 
 -    $parameters->set('skip', [ForbiddenFunctionsSniff::class => ['src-tests/bootstrap.php']]);
--    $parameters->set('exclude_files', ['src/foo/bar.php']);
-+    $parameters->set(Option::SKIP, [
-+            ForbiddenFunctionsSniff::class => ['src-tests/bootstrap.php'],
-+            'src/foo/bar.php',
+-    $parameters->set('exclude_files', [__DIR__ . '/src/foo/bar.php']);
++    $parameters->set(
++        Option::SKIP,
++        [
++            ForbiddenFunctionsSniff::class => [__DIR__ . '/src-tests/bootstrap.php'],
++            __DIR__ . '/src/foo/bar.php',
 +        ]
 +    );
 
     $containerConfigurator->import(__DIR__ . '/vendor/lmc/coding-standard/ecs.php');
 };
-
 ```
 
 See [ECS documentation](https://github.com/symplify/easy-coding-standard/tree/master#configuration) for more configuration options.

composer.json

@@ -48,6 +48,7 @@
         ],
         "analyze": [
             "vendor/bin/ecs check src/ tests/ ecs.php --ansi",
+            "vendor/bin/ecs check-markdown README.md --ansi",
             "vendor/bin/phpstan analyze -c phpstan.neon --ansi"
         ],
         "fix": [