feat: add rules for trailing commas in function calls and closure use

doctrine · Jul 8, 2022 · 1e3c90e · 1e3c90e
1 parent cd23eb3
commit 1e3c90e
Show file tree

Hide file tree

Showing 4 changed files with 72 additions and 0 deletions.
diff --git a/lib/Doctrine/ruleset.xml b/lib/Doctrine/ruleset.xml
@@ -291,12 +291,28 @@
             <property name="spacesCountAfterArrow" value="1"/>
         </properties>
     </rule>
+    <!-- Disallow trailing commas in single line function calls -->
+    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall">
+        <properties>
+            <property name="onlySingleLine" value="true" />
+        </properties>
+    </rule>
+    <!-- Disallow trailing commas in single line closure use -->
+    <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse">
+        <properties>
+            <property name="onlySingleLine" value="true" />
+        </properties>
+    </rule>
     <!-- Disallow trailing commas in single line function declarations -->
     <rule ref="SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration">
         <properties>
             <property name="onlySingleLine" value="true" />
         </properties>
     </rule>
+    <!-- Require trailing commas in multiline function calls -->
+    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
+    <!-- Require trailing commas in multiline closure use -->
+    <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse"/>
     <!-- Require trailing commas in multiline function declarations -->
     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
     <!-- Require closures not referencing $this be static -->

diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -12,6 +12,7 @@
 
     <!-- Show progress of the run -->
     <arg value="p"/>
+    <arg value="s"/>
 
     <rule ref="Doctrine"/>
 

diff --git a/tests/fixed/TrailingCommaOnFunctions.php b/tests/fixed/TrailingCommaOnFunctions.php
@@ -4,6 +4,10 @@
 
 namespace Doctrine;
 
+use function var_dump;
+
+// phpcs:disable PSR1.Files.SideEffects
+
 class TrailingCommaOnFunctions
 {
     public function a(int $arg): void
@@ -14,4 +18,27 @@ public function b(
         int $arg
     ): void {
     }
+
+    public function uses(): void
+    {
+        $var = null;
+
+        $singleLine = static function (int $arg) use ($var): void {
+            var_dump($var);
+        };
+
+        $multiLine = static function (int $arg) use (
+            $var
+        ): void {
+            var_dump($var);
+        };
+    }
 }
+
+$class = new TrailingCommaOnFunctions();
+
+$class->a(1);
+
+$class->a(
+    1
+);
diff --git a/tests/input/TrailingCommaOnFunctions.php b/tests/input/TrailingCommaOnFunctions.php
@@ -4,6 +4,10 @@
 
 namespace Doctrine;
 
+use function var_dump;
+
+// phpcs:disable PSR1.Files.SideEffects
+
 class TrailingCommaOnFunctions
 {
     public function a(int $arg): void
@@ -14,4 +18,28 @@ public function b(
         int $arg
     ): void {
     }
+
+    public function uses(): void
+    {
+        $var = null;
+
+        $singleLine = static function (int $arg) use ($var): void {
+            var_dump($var);
+        };
+
+        $multiLine = static function (int $arg) use (
+            $var
+        ): void {
+            var_dump($var);
+        };
+    }
 }
+
+$class = new TrailingCommaOnFunctions();
+
+$class->a(1);
+
+$class->a(
+    1
+);
+