Feat: Reconfigure TrailingCommaInMultilineFixer in accordance with PER2.0 (part of #94)

Author: OndraM

Diff for: ecs.php

@@ -148,7 +148,6 @@
 use SlevomatCodingStandard\Sniffs\ControlStructures\RequireNullSafeObjectOperatorSniff;
 use SlevomatCodingStandard\Sniffs\Exceptions\ReferenceThrowableOnlySniff;
 use SlevomatCodingStandard\Sniffs\Functions\RequireTrailingCommaInCallSniff;
-use SlevomatCodingStandard\Sniffs\Functions\RequireTrailingCommaInDeclarationSniff;
 use SlevomatCodingStandard\Sniffs\TypeHints\ParameterTypeHintSniff;
 use SlevomatCodingStandard\Sniffs\TypeHints\PropertyTypeHintSniff;
 use SlevomatCodingStandard\Sniffs\TypeHints\ReturnTypeHintSniff;
@@ -233,8 +232,6 @@
             SingleLineEmptyBodyFixer::class, // Defined in PER 2.0
             // Values separated by a comma on a single line should not have a trailing comma.
             NoTrailingCommaInSinglelineFixer::class,
-            // Multi-line arrays, arguments list and parameters list must have a trailing comma
-            TrailingCommaInMultilineFixer::class,
             // Arrays should be formatted like function/method arguments
             TrimArraySpacesFixer::class,
             // In array declaration, there MUST be a whitespace after each comma
@@ -420,10 +417,8 @@
             ParameterTypeHintSniff::class,
             ReturnTypeHintSniff::class,
 
-            // Multi-line arguments list in function/method declaration must have a trailing comma
-            RequireTrailingCommaInDeclarationSniff::class,
             // Multi-line arguments list in function/method call must have a trailing comma
-            RequireTrailingCommaInCallSniff::class,
+            RequireTrailingCommaInCallSniff::class, // TODO: will be redundant after https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/pull/7989 is merged and released
 
             // Use `null-safe` operator `?->` where possible
             RequireNullSafeObjectOperatorSniff::class,
@@ -550,6 +545,11 @@
         FunctionDeclarationFixer::class,
         ['closure_fn_spacing' => 'none'], // Defined in PER 2.0
     )
+    // Multi-line arrays, arguments list and parameters list must have a trailing comma
+    ->withConfiguredRule(
+        TrailingCommaInMultilineFixer::class,
+        ['after_heredoc' => true, 'elements' => ['arguments', 'arrays', 'match', 'parameters']], // Defined in PER 2.0
+    )
     ->withSkip([
         // We allow empty catch statements (but they must have comment - see EmptyCatchCommentSniff)
         EmptyStatementSniff::class . '.DetectedCatch' => null,

Diff for: tests/Integration/Fixtures/Basic.correct.php.inc

@@ -108,4 +108,29 @@ class Basic
     public function emptyFunction2(
         $arg,
     ): void {} // SingleLineEmptyBodyFixer
+
+    // TrailingCommaInMultilineFixer
+    public function multiline(
+        $arg1,
+        $arg2,
+        $arg3,
+    ): void {
+        // TrailingCommaInMultilineFixer
+        $isSet = isset(
+            $arg1,
+            $arg2,
+            $arg3,
+        );
+
+        $sprintf = sprintf(
+            '%s%s',
+            'bar',
+            'baz',
+        );
+
+        foo(
+            1,
+            2,
+        );
+    }
 }

Diff for: tests/Integration/Fixtures/Basic.wrong.php.inc

@@ -107,4 +107,30 @@ class Basic
         $arg
     ): void {
     } // SingleLineEmptyBodyFixer
+
+    // TrailingCommaInMultilineFixer
+    public function multiline(
+        $arg1,
+            $arg2,
+        $arg3
+    ): void
+    {
+        // TrailingCommaInMultilineFixer
+        $isSet = isset(
+            $arg1,
+            $arg2,
+            $arg3
+        );
+
+        $sprintf = sprintf(
+            '%s%s',
+            'bar',
+            'baz'
+        );
+
+        foo(
+            1,
+            2
+        );
+    }
 }