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

Enhancement: Enable `phpdoc_list_type` fixer
ergebnis · Feb 2, 2024 · 4f20299 · 4f20299
2 parents 6adcd0f + 16c0acc
commit 4f20299
Show file tree

Hide file tree

Showing 27 changed files with 27 additions and 78 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ For a full diff see [`6.20.0...main`][6.20.0...main].
 
 - Updated `kubawerlos/php-cs-fixer-custom-fixers` ([#996]), by [@dependabot]
 - Updated `friendsofphp/php-cs-fixer` ([#1005]), by [@dependabot]
+- Enabled the `phpdoc_list_type` instead of the `PhpCsFixerCustomFixers/phpdoc_type_list` fixer ([#1006]), by [@localheinz]
 
 ### Fixed
 

diff --git a/src/RuleSet/Php53.php b/src/RuleSet/Php53.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -590,7 +588,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php54.php b/src/RuleSet/Php54.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -591,7 +589,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php55.php b/src/RuleSet/Php55.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php56.php b/src/RuleSet/Php56.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php70.php b/src/RuleSet/Php70.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -595,7 +593,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php71.php b/src/RuleSet/Php71.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php72.php b/src/RuleSet/Php72.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php73.php b/src/RuleSet/Php73.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php74.php b/src/RuleSet/Php74.php
@@ -38,7 +38,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -57,7 +56,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -597,7 +595,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php80.php b/src/RuleSet/Php80.php
@@ -39,7 +39,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -62,7 +61,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -607,7 +605,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php81.php b/src/RuleSet/Php81.php
@@ -39,7 +39,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -62,7 +61,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -609,7 +607,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php82.php b/src/RuleSet/Php82.php
@@ -39,7 +39,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -62,7 +61,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -609,7 +607,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/src/RuleSet/Php83.php b/src/RuleSet/Php83.php
@@ -39,7 +39,6 @@ public static function create(): RuleSet
                 new Fixer\NoDuplicatedImportsFixer(),
                 new Fixer\NoImportFromGlobalNamespaceFixer(),
                 new Fixer\PhpdocArrayStyleFixer(),
-                new Fixer\PhpdocTypeListFixer(),
                 new Fixer\PhpdocTypesCommaSpacesFixer(),
                 new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
             ),
@@ -62,7 +61,6 @@ public static function create(): RuleSet
                 'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
                 'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
                 'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-                'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
                 'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
                 'align_multiline_comment' => [
                     'comment_type' => 'all_multiline',
@@ -609,7 +607,7 @@ public static function create(): RuleSet
                     'method' => 'multi',
                     'property' => 'multi',
                 ],
-                'phpdoc_list_type' => false,
+                'phpdoc_list_type' => true,
                 'phpdoc_no_access' => true,
                 'phpdoc_no_alias_tag' => [
                     'replacements' => [

diff --git a/test/Unit/RuleSet/Php53Test.php b/test/Unit/RuleSet/Php53Test.php
@@ -49,7 +49,6 @@ protected function expectedCustomFixers(): Fixers
             new Fixer\NoDuplicatedImportsFixer(),
             new Fixer\NoImportFromGlobalNamespaceFixer(),
             new Fixer\PhpdocArrayStyleFixer(),
-            new Fixer\PhpdocTypeListFixer(),
             new Fixer\PhpdocTypesCommaSpacesFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
@@ -80,7 +79,6 @@ protected function expectedRules(): Rules
             'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
             'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
@@ -613,7 +611,7 @@ protected function expectedRules(): Rules
                 'method' => 'multi',
                 'property' => 'multi',
             ],
-            'phpdoc_list_type' => false,
+            'phpdoc_list_type' => true,
             'phpdoc_no_access' => true,
             'phpdoc_no_alias_tag' => [
                 'replacements' => [

diff --git a/test/Unit/RuleSet/Php54Test.php b/test/Unit/RuleSet/Php54Test.php
@@ -49,7 +49,6 @@ protected function expectedCustomFixers(): Fixers
             new Fixer\NoDuplicatedImportsFixer(),
             new Fixer\NoImportFromGlobalNamespaceFixer(),
             new Fixer\PhpdocArrayStyleFixer(),
-            new Fixer\PhpdocTypeListFixer(),
             new Fixer\PhpdocTypesCommaSpacesFixer(),
             new PhpCsFixer\Whitespace\LineBreakAfterStatementsFixer(),
         );
@@ -80,7 +79,6 @@ protected function expectedRules(): Rules
             'PhpCsFixerCustomFixers/no_duplicated_imports' => true,
             'PhpCsFixerCustomFixers/no_import_from_global_namespace' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
-            'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'PhpCsFixerCustomFixers/phpdoc_types_comma_spaces' => true,
             'align_multiline_comment' => [
                 'comment_type' => 'all_multiline',
@@ -614,7 +612,7 @@ protected function expectedRules(): Rules
                 'method' => 'multi',
                 'property' => 'multi',
             ],
-            'phpdoc_list_type' => false,
+            'phpdoc_list_type' => true,
             'phpdoc_no_access' => true,
             'phpdoc_no_alias_tag' => [
                 'replacements' => [