SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration: New option "onlySingleLine"

Author: kukulich

README.md

@@ -843,6 +843,10 @@ This sniff provides the following setting:
 
 This sniff disallows trailing commas in multi-line declarations.
 
+This sniff provides the following setting:
+
+* `onlySingleLine`: to enable checks only for single-line declarations.
+
 #### SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration 🔧
 
 Commas after the last parameter in function or method declaration make adding a new parameter easier and result in a cleaner versioning diff.

SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniff.php

@@ -13,6 +13,9 @@ class DisallowTrailingCommaInDeclarationSniff implements Sniff
 
 public const CODE_DISALLOWED_TRAILING_COMMA = 'DisallowedTrailingComma';
 
+/** @var bool */
+public $onlySingleLine = false;
+
 /**
  * @return array<int, (int|string)>
  */
@@ -43,6 +46,10 @@ public function process(File $phpcsFile, $functionPointer): void
 return;
 }
 
+if ($this->onlySingleLine && $tokens[$parenthesisOpenerPointer]['line'] !== $tokens[$parenthesisCloserPointer]['line']) {
+return;
+}
+
 $fix = $phpcsFile->addFixableError(
 'Trailing comma after the last parameter in function declaration is disallowed.',
 $pointerBeforeParenthesisCloser,
@@ -55,6 +62,13 @@ public function process(File $phpcsFile, $functionPointer): void
 
 $phpcsFile->fixer->beginChangeset();
 $phpcsFile->fixer->replaceToken($pointerBeforeParenthesisCloser, '');
+
+if ($tokens[$pointerBeforeParenthesisCloser]['line'] === $tokens[$parenthesisCloserPointer]['line']) {
+for ($i = $pointerBeforeParenthesisCloser + 1; $i < $parenthesisCloserPointer; $i++) {
+$phpcsFile->fixer->replaceToken($i, '');
+}
+}
+
 $phpcsFile->fixer->endChangeset();
 }
 

tests/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniffTest.php

@@ -9,13 +9,17 @@ class DisallowTrailingCommaInDeclarationSniffTest extends TestCase
 
 public function testNoErrors(): void
 {
-$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInDeclarationNoErrors.php');
+$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInDeclarationNoErrors.php', [
+'onlySingleLine' => false,
+]);
 self::assertNoSniffErrorInFile($report);
 }
 
 public function testErrors(): void
 {
-$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInDeclarationErrors.php');
+$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInDeclarationErrors.php', [
+'onlySingleLine' => false,
+]);
 
 self::assertSame(4, $report->getErrorCount());
 
@@ -27,4 +31,17 @@ public function testErrors(): void
 self::assertAllFixedInFile($report);
 }
 
+public function testWithOnlySingleLineEnabledErrors(): void
+{
+$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInDeclarationWithOnlySingleLineEnabledErrors.php', [
+'onlySingleLine' => true,
+]);
+
+self::assertSame(1, $report->getErrorCount());
+
+self::assertSniffError($report, 10, DisallowTrailingCommaInDeclarationSniff::CODE_DISALLOWED_TRAILING_COMMA);
+
+self::assertAllFixedInFile($report);
+}
+
 }

tests/Sniffs/Functions/data/disallowTrailingCommaInDeclarationWithOnlySingleLineEnabledErrors.fixed.php

@@ -0,0 +1,12 @@
+<?php // lint >= 8.0
+
+function something(
+$a,
+$b,
+) {
+
+}
+
+function anything($a, $b) {
+
+}

tests/Sniffs/Functions/data/disallowTrailingCommaInDeclarationWithOnlySingleLineEnabledErrors.php

@@ -0,0 +1,12 @@
+<?php // lint >= 8.0
+
+function something(
+$a,
+$b,
+) {
+
+}
+
+function anything($a, $b, ) {
+
+}