Merge pull request #974 from ergebnis/feature/multiline-comment-openi…

…ng-closing-alone Enhancement: Enable `PhpCsFixerCustomFixers/multiline_comment_opening_closing_alone` fixer
ergebnis · Jan 4, 2024 · 7a9143a · 7a9143a
2 parents a3a83e7 + fc59191
commit 7a9143a
Show file tree

Hide file tree

Showing 27 changed files with 57 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 For a full diff see [`6.18.0...main`][6.18.0...main].
 
+### Changed
+
+- Enabled the `PhpCsFixerCustomFixers/multiline_comment_opening_closing_alone` fixer ([#974]), by [@localheinz]
+
 ## [`6.18.0`][6.18.0]
 
 For a full diff see [`6.17.0...6.18.0`][6.17.0...6.18.0].
@@ -1479,6 +1483,7 @@ For a full diff see [`d899e77...1.0.0`][d899e77...1.0.0].
 [#971]: https://github.com/ergebnis/php-cs-fixer-config/pull/971
 [#972]: https://github.com/ergebnis/php-cs-fixer-config/pull/972
 [#973]: https://github.com/ergebnis/php-cs-fixer-config/pull/973
+[#974]: https://github.com/ergebnis/php-cs-fixer-config/pull/974
 
 [@dependabot]: https://github.com/apps/dependabot
 [@linuxjuggler]: https://github.com/linuxjuggler

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

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

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

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

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

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

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

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

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

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

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

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

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

diff --git a/test/Unit/RuleSet/Php53Test.php b/test/Unit/RuleSet/Php53Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php54Test.php b/test/Unit/RuleSet/Php54Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php55Test.php b/test/Unit/RuleSet/Php55Test.php
@@ -39,6 +39,7 @@ final class Php55Test extends ExplicitRuleSetTestCase
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php56Test.php b/test/Unit/RuleSet/Php56Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php70Test.php b/test/Unit/RuleSet/Php70Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php71Test.php b/test/Unit/RuleSet/Php71Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php72Test.php b/test/Unit/RuleSet/Php72Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php73Test.php b/test/Unit/RuleSet/Php73Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php74Test.php b/test/Unit/RuleSet/Php74Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [

diff --git a/test/Unit/RuleSet/Php80Test.php b/test/Unit/RuleSet/Php80Test.php
@@ -44,6 +44,7 @@ protected static function createRuleSet(): RuleSet
     protected function expectedCustomFixers(): Fixers
     {
         return Fixers::fromFixers(
+            new Fixer\MultilineCommentOpeningClosingAloneFixer(),
             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/multiline_comment_opening_closing_alone' => true,
             'PhpCsFixerCustomFixers/phpdoc_array_style' => true,
             'PhpCsFixerCustomFixers/phpdoc_type_list' => true,
             'align_multiline_comment' => [