Enhancement: Enable PhpCsFixerCustomFixers/phpdoc_array_style fixer

ergebnis · Sep 19, 2023 · 2fcb5a5 · 2fcb5a5
1 parent 3fcabe6
commit 2fcb5a5
Show file tree

Hide file tree

Showing 26 changed files with 151 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 For a full diff see [`6.1.0...main`][6.1.0...main].
 
+### Changed
+
+- Required [`kubawerlos/php-cs-fixer-custom-fixers`](https://github.com/kubawerlos/php-cs-fixer-custom-fixers) and enabled the `PhpCsFixerCustomFixers/phpdoc_array_style` fixer ([#894]), by [@localheinz]
+
+
 ## [`6.1.0`][6.1.0]
 
 For a full diff see [`6.0.0...6.1.0`][6.0.0...6.1.0].
@@ -1225,6 +1230,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#891]: https://github.com/ergebnis/php-cs-fixer-config/pull/891
 [#892]: https://github.com/ergebnis/php-cs-fixer-config/pull/892
 [#893]: https://github.com/ergebnis/php-cs-fixer-config/pull/893
+[#894]: https://github.com/ergebnis/php-cs-fixer-config/pull/894
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

diff --git a/README.md b/README.md
@@ -328,6 +328,7 @@ This package is inspired by and also replaces [`localheinz/php-cs-fixer-config`]
 This package requires and enables custom fixers from the following packages:
 
 - [`erickskrauch/php-cs-fixer-custom-fixers`](https://github.com/erickskrauch/php-cs-fixer-custom-fixers)
+- [`kubawerlos/php-cs-fixer-custom-fixers`](https://github.com/kubawerlos/php-cs-fixer-custom-fixers)
 
 ## Social
 

diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php53
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php54
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php55
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php56
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php70
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php71
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php72.php b/src/RuleSet/Php72.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php72
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php73
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php74.php b/src/RuleSet/Php74.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php74
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php80.php b/src/RuleSet/Php80.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php80
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php81.php b/src/RuleSet/Php81.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php81
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php82.php b/src/RuleSet/Php82.php
@@ -19,6 +19,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 
 final class Php82
 {
@@ -31,7 +32,10 @@ public static function create(): RuleSet
         );
 
         return RuleSet::create(
-            Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer()),
+            Fixers::fromFixers(
+                new Fixer\PhpdocArrayStyleFixer(),
+                new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+            ),
             Name::fromString(\sprintf(
                 'ergebnis (PHP %d.%d)',
                 $phpVersion->major()->toInt(),
@@ -40,6 +44,7 @@ public static function create(): RuleSet
             $phpVersion,
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
+                'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/test/Unit/RuleSet/Php53Test.php b/test/Unit/RuleSet/Php53Test.php
@@ -20,6 +20,7 @@
 use Ergebnis\PhpCsFixer\Config\Rules;
 use Ergebnis\PhpCsFixer\Config\RuleSet;
 use ErickSkrauch\PhpCsFixer;
+use PhpCsFixerCustomFixers\Fixer;
 use PHPUnit\Framework;
 
 #[Framework\Attributes\CoversClass(RuleSet\Php53::class)]
@@ -41,7 +42,10 @@ protected static function createRuleSet(): RuleSet
 
     protected function expectedCustomFixers(): Fixers
     {
-        return Fixers::fromFixers(new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer());
+        return Fixers::fromFixers(
+            new Fixer\PhpdocArrayStyleFixer(),
+            new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
+        );
     }
 
     protected function expectedName(): Name
@@ -53,6 +57,7 @@ protected function expectedRules(): Rules
     {
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
+            'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],