SlevomatCodingStandard.Classes.RequireMultiLineMethodSignature: New option "minParameterCount"

Author: janedbal

SlevomatCodingStandard/Sniffs/Classes/RequireMultiLineMethodSignatureSniff.php

@@ -9,6 +9,7 @@
 use SlevomatCodingStandard\Helpers\IndentationHelper;
 use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
+use UnexpectedValueException;
 use function count;
 use function preg_match;
 use function sprintf;
@@ -19,9 +20,13 @@ class RequireMultiLineMethodSignatureSniff extends AbstractMethodSignature
 {
 
 	public const CODE_REQUIRED_MULTI_LINE_SIGNATURE = 'RequiredMultiLineSignature';
+	private const DEFAULT_MIN_LINE_LENGTH = 121;
 
-	/** @var int */
-	public $minLineLength = 121;
+	/** @var int|null */
+	public $minLineLength = null;
+
+	/** @var int|null */
+	public $minParametersCount = null;
 
 	/** @var string[] */
 	public $includedMethodPatterns = [];
@@ -41,7 +46,17 @@ class RequireMultiLineMethodSignatureSniff extends AbstractMethodSignature
 	 */
 	public function process(File $phpcsFile, $methodPointer): void
 	{
-		$this->minLineLength = SniffSettingsHelper::normalizeInteger($this->minLineLength);
+		$this->minLineLength = SniffSettingsHelper::normalizeNullableInteger($this->minLineLength);
+		$this->minParametersCount = SniffSettingsHelper::normalizeNullableInteger($this->minParametersCount);
+
+		if ($this->minLineLength !== null && $this->minParametersCount !== null) {
+			throw new UnexpectedValueException('Either minLineLength or minParametersCount can be set.');
+		}
+
+		// Maintain backward compatibility if no configuration provided
+		if ($this->minLineLength === null && $this->minParametersCount === null) {
+			$this->minLineLength = self::DEFAULT_MIN_LINE_LENGTH;
+		}
 
 		if (!FunctionHelper::isMethod($phpcsFile, $methodPointer)) {
 			return;
@@ -56,7 +71,8 @@ public function process(File $phpcsFile, $methodPointer): void
 		}
 
 		$parameters = $phpcsFile->getMethodParameters($methodPointer);
-		if (count($parameters) === 0) {
+		$parametersCount = count($parameters);
+		if ($parametersCount === 0) {
 			return;
 		}
 
@@ -78,7 +94,11 @@ public function process(File $phpcsFile, $methodPointer): void
 			return;
 		}
 
-		if ($this->minLineLength !== 0 && strlen($signatureWithoutTabIndentation) < $this->minLineLength) {
+		if ($this->minLineLength !== null && $this->minLineLength !== 0 && strlen($signatureWithoutTabIndentation) < $this->minLineLength) {
+			return;
+		}
+
+		if ($this->minParametersCount !== null && $parametersCount < $this->minParametersCount) {
 			return;
 		}
 

doc/classes.md

@@ -213,6 +213,7 @@ Enforces method signature to be split to more lines so each parameter is on its
 Sniff provides the following settings:
 
 * `minLineLength`: specifies min line length to enforce signature to be split. Use 0 value to enforce for all methods, regardless of length.
+* `minParametersCount`: specifies min parameters count to enforce signature to be split.
 
 * `includedMethodPatterns`: allows to configure which methods are included in sniff detection. This is an array of regular expressions (PCRE) with delimiters. You should not use this with `excludedMethodPatterns`, as it will not work properly.
 

tests/Sniffs/Classes/RequireMultiLineMethodSignatureSniffTest.php

@@ -23,6 +23,16 @@ public function testThrowExceptionForInvalidPattern(): void
 		);
 	}
 
+	public function testThrowExceptionOnInvalidSetup(): void
+	{
+		$this->expectException(Throwable::class);
+
+		self::checkFile(
+			__DIR__ . '/data/requireMultiLineMethodSignatureNoErrors.php',
+			['minLineLength' => 100, 'minParametersCount' => 2]
+		);
+	}
+
 	public function testNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/requireMultiLineMethodSignatureNoErrors.php');
@@ -42,6 +52,22 @@ public function testErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testErrorsBasedOnParamCount(): void
+	{
+		$report = self::checkFile(
+			__DIR__ . '/data/requireMultiLineMethodSignatureBasedOnParamCountErrors.php',
+			[
+				'minParametersCount' => 2,
+			]
+		);
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 8, RequireMultiLineMethodSignatureSniff::CODE_REQUIRED_MULTI_LINE_SIGNATURE);
+		self::assertSniffError($report, 14, RequireMultiLineMethodSignatureSniff::CODE_REQUIRED_MULTI_LINE_SIGNATURE);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testForAllMethods(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/requireMultiLineMethodSignatureAllMethodsErrors.php', ['minLineLength' => 0]);

tests/Sniffs/Classes/data/requireMultiLineMethodSignatureBasedOnParamCountErrors.fixed.php

@@ -0,0 +1,24 @@
+<?php // lint >= 8.0
+
+class A
+{
+	public function __construct(public int $single) {
+	}
+
+	public function tooManyParams(
+		int $one,
+		string $two
+	) {
+	}
+}
+
+interface B
+{
+	public function tooManyParams(
+		int $one,
+		string $two,
+		string $three
+	) : void;
+
+	public function noParam();
+}

tests/Sniffs/Classes/data/requireMultiLineMethodSignatureBasedOnParamCountErrors.php

@@ -0,0 +1,17 @@
+<?php // lint >= 8.0
+
+class A
+{
+	public function __construct(public int $single) {
+	}
+
+	public function tooManyParams(int $one, string $two) {
+	}
+}
+
+interface B
+{
+	public function tooManyParams(int $one, string $two, string $three) : void;
+
+	public function noParam();
+}