SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse: New option "onlySingleLine"

Author: kukulich

README.md

@@ -821,6 +821,10 @@ This sniff provides the following setting:
 
 This sniff disallows trailing commas in multi-line `use` of closure declaration.
 
+This sniff provides the following setting:
+
+* `onlySingleLine`: to enable checks only for single-line `use` declarations.
+
 #### SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse 🔧
 
 Commas after the last inherited variable in multi-line `use` of closure declaration make adding a new variable easier and result in a cleaner versioning diff.

SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php

@@ -15,6 +15,9 @@ class DisallowTrailingCommaInClosureUseSniff implements Sniff
 
 	public const CODE_DISALLOWED_TRAILING_COMMA = 'DisallowedTrailingComma';
 
+	/** @var bool */
+	public $onlySingleLine = false;
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -41,19 +44,24 @@ public function process(File $phpcsFile, $functionPointer): void
 			return;
 		}
 
-		$useParenthesisOpener = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
+		$useParenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
+		$useParenthesisCloserPointer = $tokens[$useParenthesisOpenerPointer]['parenthesis_closer'];
 
 		$pointerBeforeUseParenthesisCloser = TokenHelper::findPreviousExcluding(
 			$phpcsFile,
 			T_WHITESPACE,
-			$tokens[$useParenthesisOpener]['parenthesis_closer'] - 1,
-			$useParenthesisOpener
+			$tokens[$useParenthesisOpenerPointer]['parenthesis_closer'] - 1,
+			$useParenthesisOpenerPointer
 		);
 
 		if ($tokens[$pointerBeforeUseParenthesisCloser]['code'] !== T_COMMA) {
 			return;
 		}
 
+		if ($this->onlySingleLine && $tokens[$useParenthesisOpenerPointer]['line'] !== $tokens[$useParenthesisCloserPointer]['line']) {
+			return;
+		}
+
 		$fix = $phpcsFile->addFixableError(
 			'Trailing comma after the last inherited variable in "use" of closure declaration is disallowed.',
 			$pointerBeforeUseParenthesisCloser,
@@ -66,6 +74,13 @@ public function process(File $phpcsFile, $functionPointer): void
 
 		$phpcsFile->fixer->beginChangeset();
 		$phpcsFile->fixer->replaceToken($pointerBeforeUseParenthesisCloser, '');
+
+		if ($tokens[$pointerBeforeUseParenthesisCloser]['line'] === $tokens[$useParenthesisCloserPointer]['line']) {
+			for ($i = $pointerBeforeUseParenthesisCloser + 1; $i < $useParenthesisCloserPointer; $i++) {
+				$phpcsFile->fixer->replaceToken($i, '');
+			}
+		}
+
 		$phpcsFile->fixer->endChangeset();
 	}
 

tests/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniffTest.php

@@ -9,17 +9,35 @@ class DisallowTrailingCommaInClosureUseSniffTest extends TestCase
 
 	public function testNoErrors(): void
 	{
-		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseNoErrors.php');
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseNoErrors.php', [
+			'onlySingleLine' => false,
+		]);
 		self::assertNoSniffErrorInFile($report);
 	}
 
 	public function testErrors(): void
 	{
-		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseErrors.php');
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseErrors.php', [
+			'onlySingleLine' => false,
+		]);
 
-		self::assertSame(1, $report->getErrorCount());
+		self::assertSame(2, $report->getErrorCount());
 
 		self::assertSniffError($report, 5, DisallowTrailingCommaInClosureUseSniff::CODE_DISALLOWED_TRAILING_COMMA);
+		self::assertSniffError($report, 10, DisallowTrailingCommaInClosureUseSniff::CODE_DISALLOWED_TRAILING_COMMA);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testErrorsWithOnlySingleLineEnabled(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseWithOnlySingleLineEnabledErrors.php', [
+			'onlySingleLine' => true,
+		]);
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 10, DisallowTrailingCommaInClosureUseSniff::CODE_DISALLOWED_TRAILING_COMMA);
 
 		self::assertAllFixedInFile($report);
 	}

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

@@ -6,3 +6,7 @@ function () use (
 ) {
 
 };
+
+function () use ($a, $b) {
+
+};

tests/Sniffs/Functions/data/disallowTrailingCommaInClosureUseErrors.php

@@ -6,3 +6,7 @@ function () use (
 ) {
 
 };
+
+function () use ($a, $b, ) {
+
+};

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

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

tests/Sniffs/Functions/data/disallowTrailingCommaInClosureUseWithOnlySingleLineEnabledErrors.php

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