SlevomatCodingStandard.Functions.DisallowTrailingCommaInCall: New option "onlySingleLine"

Author: kukulich

README.md

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

SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php

@@ -23,6 +23,9 @@ class DisallowTrailingCommaInCallSniff implements Sniff
 
 	public const CODE_DISALLOWED_TRAILING_COMMA = 'DisallowedTrailingComma';
 
+	/** @var bool */
+	public $onlySingleLine = false;
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -64,6 +67,10 @@ public function process(File $phpcsFile, $parenthesisOpenerPointer): void
 			return;
 		}
 
+		if ($this->onlySingleLine && $tokens[$parenthesisOpenerPointer]['line'] !== $tokens[$parenthesisCloserPointer]['line']) {
+			return;
+		}
+
 		$fix = $phpcsFile->addFixableError(
 			'Trailing comma after the last parameter in function call is disallowed.',
 			$pointerBeforeParenthesisCloser,
@@ -76,6 +83,13 @@ public function process(File $phpcsFile, $parenthesisOpenerPointer): 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/DisallowTrailingCommaInCallSniffTest.php

@@ -9,15 +9,19 @@ class DisallowTrailingCommaInCallSniffTest extends TestCase
 
 	public function testNoErrors(): void
 	{
-		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInCallNoErrors.php');
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInCallNoErrors.php', [
+			'onlySingleLine' => false,
+		]);
 		self::assertNoSniffErrorInFile($report);
 	}
 
 	public function testErrors(): void
 	{
-		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInCallErrors.php');
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInCallErrors.php', [
+			'onlySingleLine' => false,
+		]);
 
-		self::assertSame(14, $report->getErrorCount());
+		self::assertSame(15, $report->getErrorCount());
 
 		self::assertSniffError($report, 5, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
 		self::assertSniffError($report, 12, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
@@ -33,6 +37,20 @@ public function testErrors(): void
 		self::assertSniffError($report, 75, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
 		self::assertSniffError($report, 83, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
 		self::assertSniffError($report, 91, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
+		self::assertSniffError($report, 97, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testWithOnlySingleLineEnabledErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInCallWithOnlySingleLineEnabledErrors.php', [
+			'onlySingleLine' => true,
+		]);
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 8, DisallowTrailingCommaInCallSniff::CODE_DISALLOWED_TRAILING_COMMA);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -93,3 +93,5 @@ public static function createParent($a, $b)
 	}
 
 }
+
+doSomething(1, 2, 3);

tests/Sniffs/Functions/data/disallowTrailingCommaInCallErrors.php

@@ -93,3 +93,5 @@ public static function createParent($a, $b)
 	}
 
 }
+
+doSomething(1, 2, 3, );

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

@@ -0,0 +1,8 @@
+<?php // lint >= 7.3
+
+max(
+	0,
+	1,
+);
+
+doSomething(1, 2, 3);

tests/Sniffs/Functions/data/disallowTrailingCommaInCallWithOnlySingleLineEnabledErrors.php

@@ -0,0 +1,8 @@
+<?php // lint >= 7.3
+
+max(
+	0,
+	1,
+);
+
+doSomething(1, 2, 3, );