SlevomatCodingStandard.Classes.PropertySpacing and SlevomatCodingStandard.Classes.ConstantSpacing: New options "minLinesCountBeforeMultiline" and "maxLinesCountBeforeMultiline"

Author: vojtech-dobes

SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyConstantAndEnumCaseSpacing.php

@@ -10,6 +10,8 @@
 use SlevomatCodingStandard\Helpers\TokenHelper;
 use function assert;
 use function in_array;
+use function max;
+use function min;
 use function str_repeat;
 use const T_ATTRIBUTE;
 use const T_COMMENT;
@@ -36,6 +38,10 @@ abstract class AbstractPropertyConstantAndEnumCaseSpacing implements Sniff
 
 	public int $maxLinesCountBeforeWithoutComment = 1;
 
+	public ?int $minLinesCountBeforeMultiline = null;
+
+	public ?int $maxLinesCountBeforeMultiline = null;
+
 	abstract protected function isNextMemberValid(File $phpcsFile, int $pointer): bool;
 
 	abstract protected function addError(File $phpcsFile, int $pointer, int $min, int $max, int $found): bool;
@@ -50,6 +56,8 @@ public function process(File $phpcsFile, $pointer): int
 		$this->maxLinesCountBeforeWithComment = SniffSettingsHelper::normalizeInteger($this->maxLinesCountBeforeWithComment);
 		$this->minLinesCountBeforeWithoutComment = SniffSettingsHelper::normalizeInteger($this->minLinesCountBeforeWithoutComment);
 		$this->maxLinesCountBeforeWithoutComment = SniffSettingsHelper::normalizeInteger($this->maxLinesCountBeforeWithoutComment);
+		$this->minLinesCountBeforeMultiline = SniffSettingsHelper::normalizeNullableInteger($this->minLinesCountBeforeMultiline);
+		$this->maxLinesCountBeforeMultiline = SniffSettingsHelper::normalizeNullableInteger($this->maxLinesCountBeforeMultiline);
 
 		$tokens = $phpcsFile->getTokens();
 
@@ -89,6 +97,23 @@ public function process(File $phpcsFile, $pointer): int
 			$maxExpectedLines = $this->maxLinesCountBeforeWithoutComment;
 		}
 
+		if (
+			$this->minLinesCountBeforeMultiline !== null
+			&& !$this instanceof EnumCaseSpacingSniff
+			&& $tokens[$pointer]['line'] !== $tokens[$endPointer]['line']
+		) {
+			$minExpectedLines = max($minExpectedLines, $this->minLinesCountBeforeMultiline);
+			$maxExpectedLines = max($minExpectedLines, $maxExpectedLines);
+		}
+
+		if (
+			$this->maxLinesCountBeforeMultiline !== null
+			&& !$this instanceof EnumCaseSpacingSniff
+			&& $tokens[$pointer]['line'] !== $tokens[$endPointer]['line']
+		) {
+			$maxExpectedLines = max($minExpectedLines, min($maxExpectedLines, $this->maxLinesCountBeforeMultiline));
+		}
+
 		if ($linesBetween >= $minExpectedLines && $linesBetween <= $maxExpectedLines) {
 			return $firstOnLinePointer;
 		}

doc/classes.md

@@ -113,6 +113,8 @@ Sniff provides the following settings:
 * `maxLinesCountBeforeWithComment`: maximum number of lines before constant with a documentation comment or attribute
 * `minLinesCountBeforeWithoutComment`: minimum number of lines before constant without a documentation comment or attribute
 * `maxLinesCountBeforeWithoutComment`: maximum number of lines before constant without a documentation comment or attribute
+* `minLinesCountBeforeMultiline` (default: `null`): minimum number of lines before multiline constant
+* `maxLinesCountBeforeMultiline` (default: `null`): maximum number of lines before multiline constant
 
 #### SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion
 
@@ -216,6 +218,8 @@ Sniff provides the following settings:
 * `maxLinesCountBeforeWithComment`: maximum number of lines before property with a documentation comment or attribute
 * `minLinesCountBeforeWithoutComment`: minimum number of lines before property without a documentation comment or attribute
 * `maxLinesCountBeforeWithoutComment`: maximum number of lines before property without a documentation comment or attribute
+* `minLinesCountBeforeMultiline` (default: `null`): minimum number of lines before multiline property
+* `maxLinesCountBeforeMultiline` (default: `null`): maximum number of lines before multiline property
 
 #### SlevomatCodingStandard.Classes.RequireAbstractOrFinal 🔧
 

tests/Sniffs/Classes/ConstantSpacingSniffTest.php

@@ -44,6 +44,22 @@ public function testErrorsWithModifiedLinesCount(): void
 		self::assertSniffError($report, 26, ConstantSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT);
 	}
 
+	public function testErrorsBasedOnMultiline(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/constantSpacingMultilineErrors.php', [
+			'minLinesCountBeforeMultiline' => 1,
+			'minLinesCountBeforeWithComment' => 2,
+			'maxLinesCountBeforeWithComment' => 2,
+		]);
+
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 4, ConstantSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT);
+		self::assertSniffError($report, 9, ConstantSpacingSniff::CODE_INCORRECT_COUNT_OF_BLANK_LINES_AFTER_CONSTANT);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testInGlobalNamespaceNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/constantSpacingInGlobalNamespaceNoErrors.php');

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

@@ -0,0 +1,23 @@
+<?php // lint >= 8.2
+
+abstract class Foo {
+	const ItemsA = [
+		'A',
+		'B',
+		'C',
+	];
+
+	const ItemsB = [
+		'A',
+		'B',
+		'C',
+	];
+
+
+	/** @var array<string> */
+	const ItemsC = [
+		'A',
+		'B',
+		'C',
+	];
+}

tests/Sniffs/Classes/data/constantSpacingMultilineErrors.php

@@ -0,0 +1,20 @@
+<?php // lint >= 8.2
+
+abstract class Foo {
+	const ItemsA = [
+		'A',
+		'B',
+		'C',
+	];
+	const ItemsB = [
+		'A',
+		'B',
+		'C',
+	];
+	/** @var array<string> */
+	const ItemsC = [
+		'A',
+		'B',
+		'C',
+	];
+}