SlevomatCodingStandard.Classes.PropertyDeclaration: New option "enableMultipleSpacesBetweenModifiersCheck" to enable check of spaces between property modifiers

Author: kukulich

README.md

@@ -548,6 +548,7 @@ Sniff provides the following settings:
 
 * `modifiersOrder`: allows to configurure order of modifiers.
 * `checkPromoted`: will check promoted properties too.
+* `enableMultipleSpacesBetweenModifiersCheck`: checks multiple spaces between modifiers.
 
 #### SlevomatCodingStandard.Classes.PropertySpacing 🔧
 

SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php

@@ -49,12 +49,17 @@ class PropertyDeclarationSniff implements Sniff
 
 	public const CODE_INCORRECT_ORDER_OF_MODIFIERS = 'IncorrectOrderOfModifiers';
 
+	public const CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS = 'MultipleSpacesBetweenModifiers';
+
 	/** @var string[]|null */
 	public $modifiersOrder = [];
 
 	/** @var bool */
 	public $checkPromoted = false;
 
+	/** @var bool */
+	public $enableMultipleSpacesBetweenModifiersCheck = false;
+
 	/** @var array<int, array<int, (int|string)>>|null */
 	private $normalizedModifiersOrder = null;
 
@@ -106,6 +111,7 @@ public function process(File $phpcsFile, $modifierPointer): void
 		} while (true);
 
 		$this->checkModifiersOrder($phpcsFile, $propertyPointer, $firstModifierPointer, $modifierPointer);
+		$this->checkSpacesBetweenModifiers($phpcsFile, $propertyPointer, $firstModifierPointer, $modifierPointer);
 		$this->checkTypeHintSpacing($phpcsFile, $propertyPointer, $modifierPointer);
 	}
 
@@ -189,6 +195,68 @@ private function checkModifiersOrder(File $phpcsFile, int $propertyPointer, int
 		$phpcsFile->fixer->endChangeset();
 	}
 
+	private function checkSpacesBetweenModifiers(
+		File $phpcsFile,
+		int $propertyPointer,
+		int $firstModifierPointer,
+		int $lastModifierPointer
+	): void
+	{
+		if (!$this->enableMultipleSpacesBetweenModifiersCheck) {
+			return;
+		}
+
+		$modifiersPointers = TokenHelper::findNextAll(
+			$phpcsFile,
+			TokenHelper::$propertyModifiersTokenCodes,
+			$firstModifierPointer,
+			$lastModifierPointer + 1
+		);
+
+		if (count($modifiersPointers) < 2) {
+			return;
+		}
+
+		$tokens = $phpcsFile->getTokens();
+
+		$error = false;
+		for ($i = 0; $i < count($modifiersPointers) - 1; $i++) {
+			$whitespace = TokenHelper::getContent($phpcsFile, $modifiersPointers[$i] + 1, $modifiersPointers[$i + 1] - 1);
+			if ($whitespace !== ' ') {
+				$error = true;
+				break;
+			}
+		}
+
+		if (!$error) {
+			return;
+		}
+
+		$fix = $phpcsFile->addFixableError(
+			sprintf('There must be exactly one space between modifiers of property %s.', $tokens[$propertyPointer]['content']),
+			$firstModifierPointer,
+			self::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS
+		);
+		if (!$fix) {
+			return;
+		}
+
+		$expectedModifiers = array_map(static function (int $modifierPointer) use ($tokens): string {
+			return $tokens[$modifierPointer]['content'];
+		}, $modifiersPointers);
+		$expectedModifiersFormatted = implode(' ', $expectedModifiers);
+
+		$phpcsFile->fixer->beginChangeset();
+
+		$phpcsFile->fixer->replaceToken($firstModifierPointer, $expectedModifiersFormatted);
+
+		for ($i = $firstModifierPointer + 1; $i <= $lastModifierPointer; $i++) {
+			$phpcsFile->fixer->replaceToken($i, '');
+		}
+
+		$phpcsFile->fixer->endChangeset();
+	}
+
 	private function checkTypeHintSpacing(File $phpcsFile, int $propertyPointer, int $lastModifierPointer): void
 	{
 		$typeHintEndPointer = TokenHelper::findPrevious(

tests/Sniffs/Classes/PropertyDeclarationSniffTest.php

@@ -78,6 +78,55 @@ public function testPromotedErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testDisabledMultipleSpacesBetweenModifiersNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/propertyDeclarationDisabledMultipleSpacesBetweenModifiersNoErrors.php', [
+			'checkPromoted' => true,
+			'enableMultipleSpacesBetweenModifiersCheck' => false,
+		], [PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS]);
+
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testEnabledMultipleSpacesBetweenModifiersNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/propertyDeclarationEnabledMultipleSpacesBetweenModifiersNoErrors.php', [
+			'checkPromoted' => true,
+			'enableMultipleSpacesBetweenModifiersCheck' => true,
+		], [PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS]);
+
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testEnabledMultipleSpacesBetweenModifiersErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/propertyDeclarationEnabledMultipleSpacesBetweenModifiersErrors.php', [
+			'checkPromoted' => true,
+			'enableMultipleSpacesBetweenModifiersCheck' => true,
+		], [PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS]);
+
+		self::assertSame(6, $report->getErrorCount());
+
+		self::assertSniffError($report, 6, PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS);
+		self::assertSniffError($report, 8, PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS);
+		self::assertSniffError(
+			$report,
+			10,
+			PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS,
+			'There must be exactly one space between modifiers of property $three.'
+		);
+		self::assertSniffError(
+			$report,
+			10,
+			PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS,
+			'There must be exactly one space between modifiers of property $four.'
+		);
+		self::assertSniffError($report, 20, PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS);
+		self::assertSniffError($report, 21, PropertyDeclarationSniff::CODE_MULTIPLE_SPACES_BETWEEN_MODIFIERS);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testModifiedModifiersOrderNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/propertyDeclarationModifiedModifiersOrderNoErrors.php', [
@@ -86,6 +135,7 @@ public function testModifiedModifiersOrderNoErrors(): void
 				'var, public, protected, private',
 			],
 		]);
+
 		self::assertNoSniffErrorInFile($report);
 	}
 

tests/Sniffs/Classes/data/propertyDeclarationDisabledMultipleSpacesBetweenModifiersNoErrors.php

@@ -0,0 +1,14 @@
+<?php // lint >= 8.1
+
+class Whatever
+{
+
+	public   readonly int $one;
+
+	static  public string|bool $two = false;
+
+	public function __construct(public   readonly Foo|Bar $three)
+	{
+	}
+
+}

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

@@ -0,0 +1,26 @@
+<?php // lint >= 8.1
+
+class Whatever
+{
+
+	public readonly int $one;
+
+	static public string|bool $two = false;
+
+	public function __construct(public readonly ?Foo $three, readonly public Foo|Bar|null $four)
+	{
+	}
+
+}
+
+class Anything
+{
+
+	public function __construct(
+		public readonly ?Foo $five,
+		readonly protected Foo|Bar|null $six,
+	)
+	{
+	}
+
+}

tests/Sniffs/Classes/data/propertyDeclarationEnabledMultipleSpacesBetweenModifiersErrors.php

@@ -0,0 +1,26 @@
+<?php // lint >= 8.1
+
+class Whatever
+{
+
+	public  readonly int $one;
+
+	static   public string|bool $two = false;
+
+	public function __construct(public  readonly ?Foo $three, readonly  public Foo|Bar|null $four)
+	{
+	}
+
+}
+
+class Anything
+{
+
+	public function __construct(
+		public  readonly ?Foo $five,
+		readonly  protected Foo|Bar|null $six,
+	)
+	{
+	}
+
+}

tests/Sniffs/Classes/data/propertyDeclarationEnabledMultipleSpacesBetweenModifiersNoErrors.php

@@ -0,0 +1,16 @@
+<?php // lint >= 8.1
+
+class Whatever
+{
+
+	public int $zero;
+
+	public readonly int $one;
+
+	static public string|bool $two = false;
+
+	public function __construct(public readonly Foo|Bar $three)
+	{
+	}
+
+}