DuplicateSpacesSniff: Improved detection

slevomat · Mar 28, 2020 · c4bf9ca · c4bf9ca
1 parent faf6fd2
commit c4bf9ca
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 1 deletion.
diff --git a/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php b/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php
@@ -15,6 +15,7 @@
 use function str_replace;
 use function strlen;
 use const PREG_OFFSET_CAPTURE;
+use const T_DOC_COMMENT_CLOSE_TAG;
 use const T_DOC_COMMENT_OPEN_TAG;
 use const T_DOC_COMMENT_STAR;
 use const T_DOC_COMMENT_STRING;
@@ -81,7 +82,11 @@ public function process(File $phpcsFile, $whitespacePointer): void
 
 			if ($this->ignoreSpacesInAnnotation) {
 				$pointerBefore = TokenHelper::findPrevious($phpcsFile, [T_DOC_COMMENT_OPEN_TAG, T_DOC_COMMENT_TAG], $whitespacePointer - 1);
-				if ($pointerBefore !== null && $tokens[$pointerBefore]['code'] === T_DOC_COMMENT_TAG) {
+				if (
+					$pointerBefore !== null
+					&& $tokens[$pointerBefore]['code'] === T_DOC_COMMENT_TAG
+					&& $tokens[$whitespacePointer + 1]['code'] !== T_DOC_COMMENT_CLOSE_TAG
+				) {
 					return;
 				}
 			}

diff --git a/tests/Sniffs/Whitespaces/DuplicateSpacesSniffTest.php b/tests/Sniffs/Whitespaces/DuplicateSpacesSniffTest.php
@@ -48,4 +48,17 @@ public function testIgnoreSpacesInAnnotationNoErrors(): void
 		self::assertNoSniffErrorInFile($report);
 	}
 
+	public function testIgnoreSpacesInAnnotationErrors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/duplicateSpacesIgnoreSpacesInAnnotationErrors.php', [
+			'ignoreSpacesInAnnotation' => true,
+		]);
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 3, DuplicateSpacesSniff::CODE_DUPLICATE_SPACES, 'Duplicate spaces at position 21.');
+
+		self::assertAllFixedInFile($report);
+	}
+
 }
diff --git a/tests/Sniffs/Whitespaces/data/duplicateSpacesIgnoreSpacesInAnnotationErrors.fixed.php b/tests/Sniffs/Whitespaces/data/duplicateSpacesIgnoreSpacesInAnnotationErrors.fixed.php
@@ -0,0 +1,6 @@
+<?php
+
+/** @param string $a */
+function doSomething($a) {
+
+}
diff --git a/tests/Sniffs/Whitespaces/data/duplicateSpacesIgnoreSpacesInAnnotationErrors.php b/tests/Sniffs/Whitespaces/data/duplicateSpacesIgnoreSpacesInAnnotationErrors.php
@@ -0,0 +1,6 @@
+<?php
+
+/** @param string $a  */
+function doSomething($a) {
+
+}