add 'allowOnSameLine' option to AttributeAndTargetSpacingSniff

Author: stlrnz

SlevomatCodingStandard/Sniffs/Attributes/AttributeAndTargetSpacingSniff.php

@@ -22,6 +22,9 @@ class AttributeAndTargetSpacingSniff implements Sniff
 	/** @var int */
 	public $linesCount = 0;
 
+	/** @var bool */
+	public $allowOnSameLine = false;
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -58,6 +61,10 @@ public function process(File $phpcsFile, $attributeOpenerPointer): void
 		$areOnSameLine = $tokens[$pointerAfter]['line'] === $tokens[$attributeCloserPointer]['line'];
 
 		if ($areOnSameLine) {
+			if ($this->allowOnSameLine) {
+				return;
+			}
+
 			$errorMessage = $this->linesCount === 1
 				? 'Expected 1 blank line between attribute and its target, both are on same line.'
 				: sprintf('Expected %1$d blank lines between attribute and its target, both are on same line.', $this->linesCount);

doc/attributes.md

@@ -6,6 +6,7 @@ Checks lines count between attribute and its target (or target's documentation c
 
 Sniff provides the following settings:
 
+* `allowOnSameLine`: allow attribute and its target to be placed on the same line (default value is false)
 * `linesCount`: lines count between attribute and its target
 
 #### SlevomatCodingStandard.Attributes.AttributesOrder 🔧

tests/Sniffs/Attributes/AttributeAndTargetSpacingSniffTest.php

@@ -53,6 +53,28 @@ public function testModifiedSettingsErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testAllowOnSameLineNoErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/attributeAndTargetSpacingAllowOnSameLineNoErrors.php', [
+			'allowOnSameLine' => true,
+		]);
+		self::assertNoSniffErrorInFile($report);
+	}
+
+	public function testAllowOnSameLineErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/attributeAndTargetSpacingAllowOnSameLineErrors.php', [
+			'allowOnSameLine' => true,
+		]);
+
+		self::assertSame(2, $report->getErrorCount());
+
+		self::assertSniffError($report, 11, AttributeAndTargetSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_ATTRIBUTE_AND_TARGET);
+		self::assertSniffError($report, 18, AttributeAndTargetSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_ATTRIBUTE_AND_TARGET);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testInvalidAttributePriorPhp80(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/attributeAndTargetSpacingInvalidAttribute.php');

tests/Sniffs/Attributes/data/attributeAndTargetSpacingAllowOnSameLineErrors.fixed.php

@@ -0,0 +1,23 @@
+<?php // lint >= 8.0
+
+/** Class comment */
+#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+
+#[Attribute4(), Attribute5]
+#[Attribute6] class Whatever
+{
+
+	#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+	#[Attribute4(), Attribute5]
+	/**
+	 * Method comment
+	 */
+	#[Attribute6] public function method(
+		#[Attribute1]
+		$parameter1,
+		#[Attribute2] $parameter2
+	)
+	{
+	}
+
+}

tests/Sniffs/Attributes/data/attributeAndTargetSpacingAllowOnSameLineErrors.php

@@ -0,0 +1,28 @@
+<?php // lint >= 8.0
+
+/** Class comment */
+#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+
+#[Attribute4(), Attribute5]
+#[Attribute6] class Whatever
+{
+
+	#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+	#[Attribute4(), Attribute5]
+
+
+	/**
+	 * Method comment
+	 */
+	#[Attribute6] public function method(
+		#[Attribute1]
+
+
+
+		$parameter1,
+		#[Attribute2] $parameter2
+	)
+	{
+	}
+
+}

tests/Sniffs/Attributes/data/attributeAndTargetSpacingAllowOnSameLineNoErrors.php

@@ -0,0 +1,23 @@
+<?php // lint >= 8.0
+
+/** Class comment */
+#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+
+#[Attribute4(), Attribute5]
+#[Attribute6] class Whatever
+{
+
+	#[Attribute1, Attribute2('var'), Attribute3(option: PDO::class, option2: true, option3: 'False')]
+	#[Attribute4(), Attribute5]
+	/**
+	 * Method comment
+	 */
+	#[Attribute6] public function method(
+		#[Attribute1]
+		$parameter1,
+		#[Attribute2] $parameter2
+	)
+	{
+	}
+
+}