SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse: N…

…ew sniff

README.md

@@ -817,6 +817,10 @@ This sniff provides the following setting:
 
 * `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 7.3 or higher.
 
+#### SlevomatCodingStandard.Functions.DisallowTrailingCommaInClosureUse 🔧
+
+This sniff disallows trailing commas in multi-line `use` of closure declaration.
+
 #### SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration 🔧
 
 This sniff disallows trailing commas in multi-line declarations.

SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php

@@ -0,0 +1,72 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Functions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+use const T_CLOSURE;
+use const T_COMMA;
+use const T_USE;
+use const T_WHITESPACE;
+
+class DisallowTrailingCommaInClosureUseSniff implements Sniff
+{
+
+	public const CODE_DISALLOWED_TRAILING_COMMA = 'DisallowedTrailingComma';
+
+	/**
+	 * @return array<int, (int|string)>
+	 */
+	public function register(): array
+	{
+		return [
+			T_CLOSURE,
+		];
+	}
+
+	/**
+	 * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
+	 * @param int $functionPointer
+	 */
+	public function process(File $phpcsFile, $functionPointer): void
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		$parenthesisCloserPointer = $tokens[$functionPointer]['parenthesis_closer'];
+
+		$usePointer = TokenHelper::findNextEffective($phpcsFile, $parenthesisCloserPointer + 1);
+
+		if ($tokens[$usePointer]['code'] !== T_USE) {
+			return;
+		}
+
+		$useParenthesisOpener = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
+
+		$pointerBeforeUseParenthesisCloser = TokenHelper::findPreviousExcluding(
+			$phpcsFile,
+			T_WHITESPACE,
+			$tokens[$useParenthesisOpener]['parenthesis_closer'] - 1,
+			$useParenthesisOpener
+		);
+
+		if ($tokens[$pointerBeforeUseParenthesisCloser]['code'] !== T_COMMA) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError(
+			'Trailing comma after the last inherited variable in "use" of closure declaration is disallowed.',
+			$pointerBeforeUseParenthesisCloser,
+			self::CODE_DISALLOWED_TRAILING_COMMA
+		);
+
+		if (!$fix) {
+			return;
+		}
+
+		$phpcsFile->fixer->beginChangeset();
+		$phpcsFile->fixer->replaceToken($pointerBeforeUseParenthesisCloser, '');
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

tests/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniffTest.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Functions;
+
+use SlevomatCodingStandard\Sniffs\TestCase;
+
+class DisallowTrailingCommaInClosureUseSniffTest extends TestCase
+{
+
+	public function testNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseNoErrors.php');
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/disallowTrailingCommaInClosureUseErrors.php');
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 5, DisallowTrailingCommaInClosureUseSniff::CODE_DISALLOWED_TRAILING_COMMA);
+
+		self::assertAllFixedInFile($report);
+	}
+
+}

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

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

tests/Sniffs/Functions/data/disallowTrailingCommaInClosureUseErrors.php

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

tests/Sniffs/Functions/data/disallowTrailingCommaInClosureUseNoErrors.php

@@ -0,0 +1,10 @@
+<?php
+
+function () use (
+	$a,
+	$b
+) {
+
+};
+
+function () {};