SlevomatCodingStandard.Functions.RequireTrailingCommaInClosureUse: New sniff

Author: kukulich

README.md

@@ -821,6 +821,16 @@ This sniff provides the following setting:
 
 This sniff disallows trailing commas in multi-line `use` of closure declaration.
 
+#### 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.
+
+This sniff enforces trailing commas in multi-line declarations.
+
+This sniff provides the following setting:
+
+* `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 8.0 or higher.
+
 #### SlevomatCodingStandard.Functions.DisallowTrailingCommaInDeclaration 🔧
 
 This sniff disallows trailing commas in multi-line declarations.
@@ -835,8 +845,6 @@ This sniff provides the following setting:
 
 * `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 8.0 or higher.
 
-#### SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses 🔧
-
 Checks whether uses at the top of a file are alphabetically sorted. Follows natural sorting and takes edge cases with special symbols into consideration. The following code snippet is an example of correctly sorted uses:
 
 ```php

SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInClosureUseSniff.php

@@ -0,0 +1,85 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Functions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
+use SlevomatCodingStandard\Helpers\TokenHelper;
+use const T_CLOSURE;
+use const T_COMMA;
+use const T_USE;
+use const T_WHITESPACE;
+
+class RequireTrailingCommaInClosureUseSniff implements Sniff
+{
+
+	public const CODE_MISSING_TRAILING_COMMA = 'MissingTrailingComma';
+
+	/** @var bool|null */
+	public $enable = null;
+
+	/**
+	 * @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
+	{
+		$this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000);
+
+		if (!$this->enable) {
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$parenthesisCloserPointer = $tokens[$functionPointer]['parenthesis_closer'];
+
+		$usePointer = TokenHelper::findNextEffective($phpcsFile, $parenthesisCloserPointer + 1);
+
+		if ($tokens[$usePointer]['code'] !== T_USE) {
+			return;
+		}
+
+		$useParenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1);
+		$useParenthesisCloserPointer = $tokens[$useParenthesisOpenerPointer]['parenthesis_closer'];
+
+		if ($tokens[$useParenthesisOpenerPointer]['line'] === $tokens[$useParenthesisCloserPointer]['line']) {
+			return;
+		}
+
+		$pointerBeforeUseParenthesisCloser = TokenHelper::findPreviousExcluding(
+			$phpcsFile,
+			T_WHITESPACE,
+			$useParenthesisCloserPointer - 1,
+			$useParenthesisOpenerPointer
+		);
+
+		if ($tokens[$pointerBeforeUseParenthesisCloser]['code'] === T_COMMA) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError(
+			'Multi-line "use" of closure declaration must have a trailing comma after the last inherited variable.',
+			$pointerBeforeUseParenthesisCloser,
+			self::CODE_MISSING_TRAILING_COMMA
+		);
+
+		if (!$fix) {
+			return;
+		}
+
+		$phpcsFile->fixer->beginChangeset();
+		$phpcsFile->fixer->addContent($pointerBeforeUseParenthesisCloser, ',');
+		$phpcsFile->fixer->endChangeset();
+	}
+
+}

tests/Sniffs/Functions/RequireTrailingCommaInClosureUseSniffTest.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types = 1);
+
+namespace SlevomatCodingStandard\Sniffs\Functions;
+
+use SlevomatCodingStandard\Sniffs\TestCase;
+
+class RequireTrailingCommaInClosureUseSniffTest extends TestCase
+{
+
+	public function testNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireTrailingCommaInClosureUseNoErrors.php', [
+			'enable' => true,
+		]);
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireTrailingCommaInClosureUseErrors.php', [
+			'enable' => true,
+		]);
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 6, RequireTrailingCommaInClosureUseSniff::CODE_MISSING_TRAILING_COMMA);
+
+		self::assertAllFixedInFile($report);
+	}
+
+	public function testShouldNotReportIfSniffIsDisabled(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/requireTrailingCommaInClosureUseErrors.php', [
+			'enable' => false,
+		]);
+
+		self::assertNoSniffErrorInFile($report);
+	}
+
+}

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

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

tests/Sniffs/Functions/data/requireTrailingCommaInClosureUseErrors.php

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

tests/Sniffs/Functions/data/requireTrailingCommaInClosureUseNoErrors.php

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