SlevomatCodingStandard.Functions.RequireMultiLineCall: Add "minParametersCount" option

Author: parth391

SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php

@@ -7,6 +7,7 @@
 use SlevomatCodingStandard\Helpers\IndentationHelper;
 use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
 use SlevomatCodingStandard\Helpers\TokenHelper;
+use UnexpectedValueException;
 use function array_unique;
 use function count;
 use function in_array;
@@ -27,12 +28,25 @@ class RequireMultiLineCallSniff extends AbstractLineCall
 {
 
 	public const CODE_REQUIRED_MULTI_LINE_CALL = 'RequiredMultiLineCall';
+	private const DEFAULT_MIN_LINE_LENGTH = 121;
 
-	public int $minLineLength = 121;
+	public ?int $minLineLength = null;
+
+	public ?int $minParametersCount = null;
 
 	public function process(File $phpcsFile, int $stringPointer): 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.');
+		}
+
+		// Backward compatibility if no configuration provided
+		if ($this->minLineLength === null && $this->minParametersCount === null) {
+			$this->minLineLength = self::DEFAULT_MIN_LINE_LENGTH;
+		}
 
 		if (!$this->isCall($phpcsFile, $stringPointer)) {
 			return;
@@ -228,7 +242,11 @@ private function shouldReportError(
 			return true;
 		}
 
-		if ($lineLength < $this->minLineLength) {
+		if ($this->minLineLength !== null && $lineLength < $this->minLineLength) {
+			return false;
+		}
+
+		if ($this->minParametersCount !== null && $parametersCount < $this->minParametersCount) {
 			return false;
 		}
 

doc/functions.md

@@ -43,6 +43,7 @@ Enforces function call to be split to more lines so each parameter is on its own
 Sniff provides the following settings:
 
 * `minLineLength`: specifies min line length to enforce call to be split. Use 0 value to enforce for all calls, regardless of length.
+* `minParametersCount`: specifies min parameters count to enforce call to be split.
 
 #### SlevomatCodingStandard.Functions.RequireSingleLineCall 🔧
 

tests/Sniffs/Functions/RequireMultiLineCallSniffTest.php

@@ -3,6 +3,7 @@
 namespace SlevomatCodingStandard\Sniffs\Functions;
 
 use SlevomatCodingStandard\Sniffs\TestCase;
+use Throwable;
 
 class RequireMultiLineCallSniffTest extends TestCase
 {
@@ -135,4 +136,30 @@ public function testAllCallsErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testThrowExceptionOnInvalidSetup(): void
+	{
+		$this->expectException(Throwable::class);
+
+		self::checkFile(
+			__DIR__ . '/data/requireMultiLineCallAllCallsNoErrors.php',
+			['minLineLength' => 100, 'minParametersCount' => 2],
+		);
+	}
+
+	public function testErrorsBasedOnParamCount(): void
+	{
+		$report = self::checkFile(
+			__DIR__ . '/data/requireMultiLineCallParamCountErrors.php',
+			[
+				'minParametersCount' => 2,
+			],
+		);
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 8, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
+		self::assertSniffError($report, 14, RequireMultiLineCallSniff::CODE_REQUIRED_MULTI_LINE_CALL);
+
+		self::assertAllFixedInFile($report);
+	}
+
 }

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

@@ -0,0 +1,21 @@
+<?php
+
+class Whatever
+{
+	public function __construct()
+	{
+		$this->doAnything('false');
+		$this->doAnything(
+			'true',
+			false
+		);
+	}
+}
+
+function ($text) {
+	sprintf(_('one parameter'));
+	return sprintf(
+		_('one parameter'),
+		$text
+	);
+};

tests/Sniffs/Functions/data/requireMultiLineCallParamCountErrors.php

@@ -0,0 +1,15 @@
+<?php
+
+class Whatever
+{
+	public function __construct()
+	{
+		$this->doAnything('false');
+		$this->doAnything('true', false);
+	}
+}
+
+function ($text) {
+	sprintf(_('one parameter'));
+	return sprintf(_('one parameter'), $text);
+};