[CS] update README and prepare for split

deprecated-packages · Aug 18, 2020 · 018d5aa · 018d5aa
1 parent d39c27c
commit 018d5aa
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 0 deletions.
diff --git a/packages/coding-standard/docs/php_code_sniffer_sniffs.md b/packages/coding-standard/docs/php_code_sniffer_sniffs.md
diff --git a/packages/coding-standard/docs/phpcs_fixer_fixers.md b/packages/coding-standard/docs/phpcs_fixer_fixers.md
@@ -0,0 +1,36 @@
+# PHP CS Fixer - Fixers
+
+### Indent nested Annotations to Newline
+
+- class: [`Symplify\CodingStandard\Fixer\Annotation\NewlineInNestedAnnotationFixer`](packages/coding-standard/src/Fixer/Annotation/NewlineInNestedAnnotationFixer.php)
+
+```php
+<?php
+
+// ecs.php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(Symplify\CodingStandard\Fixer\Annotation\NewlineInNestedAnnotationFixer::class);
+};
+```
+
+```diff
+ use Doctrine\ORM\Mapping as ORM;
+
+ /**
+- * @ORM\Table(name="user", indexes={@ORM\Index(name="user_id", columns={"another_id"})})
++ * @ORM\Table(name="user", indexes={
++ *     @ORM\Index(name="user_id", columns={"another_id"})
++ * })
+  */
+ class SomeEntity
+ {
+ }
+```
+
+<br>
diff --git a/packages/coding-standard/docs/phpstan_rules.md b/packages/coding-standard/docs/phpstan_rules.md