Merge pull request #973 from ergebnis/feature/phpdoc-type-list-fixer

Enhancement: Enable `phpdoc_type_list` fixer
ergebnis · Jan 3, 2024 · 375cf17 · 375cf17
2 parents ebb5e51 + 616eb37
commit 375cf17
Show file tree

Hide file tree

Showing 28 changed files with 53 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ For a full diff see [`6.17.0...main`][6.17.0...main].
 
 - Updated `kubawerlos/php-cs-fixer-custom-fixers` ([#970]), by [@dependabot]
 - Updated `friendsofphp/php-cs-fixer` ([#971]), by [@dependabot]
+- Enabled the [`PhpCsFixerCustomFixers/phpdoc_type_list_fixer`](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/tree/v3.18.0#phpdoctypelistfixer) fixer ([#972]), by [@localheinz]
 
 ## [`6.17.0`][6.17.0]
 

diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php72.php b/src/RuleSet/Php72.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php74.php b/src/RuleSet/Php74.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php80.php b/src/RuleSet/Php80.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php81.php b/src/RuleSet/Php81.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php82.php b/src/RuleSet/Php82.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/src/RuleSet/Php83.php b/src/RuleSet/Php83.php
@@ -34,6 +34,7 @@ public static function create(): RuleSet
         return RuleSet::create(
             Fixers::fromFixers(
                 new Fixer\PhpdocArrayStyleFixer(),
+                new Fixer\PhpdocTypeListFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
             Name::fromString(\sprintf(
@@ -45,6 +46,7 @@ public static function create(): RuleSet
             Rules::fromArray([
                 'ErickSkrauch/line_break_after_statements' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
                 ],

diff --git a/test/Unit/RuleSet/AbstractRuleSetTestCase.php b/test/Unit/RuleSet/AbstractRuleSetTestCase.php
@@ -205,7 +205,6 @@ final protected static function fixersThatAreRegistered(): array
         $fixersThatAreBuiltIn = $fixerFactory->getFixers();
         $fixersThatShouldBeRegistered = static::createRuleSet()->customFixers()->toArray();
 
-        /** @var array<Fixer\FixerInterface> $fixers */
         $fixers = \array_merge(
             $fixersThatAreBuiltIn,
             $fixersThatShouldBeRegistered,

diff --git a/test/Unit/RuleSet/Php53Test.php b/test/Unit/RuleSet/Php53Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php54Test.php b/test/Unit/RuleSet/Php54Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php55Test.php b/test/Unit/RuleSet/Php55Test.php
@@ -40,6 +40,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php56Test.php b/test/Unit/RuleSet/Php56Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php70Test.php b/test/Unit/RuleSet/Php70Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php71Test.php b/test/Unit/RuleSet/Php71Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php72Test.php b/test/Unit/RuleSet/Php72Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php73Test.php b/test/Unit/RuleSet/Php73Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php74Test.php b/test/Unit/RuleSet/Php74Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php80Test.php b/test/Unit/RuleSet/Php80Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],

diff --git a/test/Unit/RuleSet/Php81Test.php b/test/Unit/RuleSet/Php81Test.php
@@ -45,6 +45,7 @@ protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
             new Fixer\PhpdocArrayStyleFixer(),
+            new Fixer\PhpdocTypeListFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
     }
@@ -68,6 +69,7 @@ protected function expectedRules(): Rules
         return Rules::fromArray([
             'ErickSkrauch/line_break_after_statements' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
+            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
             ],