UseSpacingSniff: Fixed false positive

Author: kukulich

SlevomatCodingStandard/Sniffs/Namespaces/UseSpacingSniff.php

@@ -15,6 +15,7 @@
 use function count;
 use function in_array;
 use function sprintf;
+use const T_DOC_COMMENT_OPEN_TAG;
 use const T_OPEN_TAG;
 use const T_SEMICOLON;
 use const T_WHITESPACE;
@@ -143,14 +144,13 @@ private function checkLinesAfterLastUse(File $phpcsFile, UseStatement $lastUse):
 
 		if (
 			in_array($tokens[$pointerAfterWhitespaceEnd]['code'], Tokens::$commentTokens, true)
+			&& $tokens[$pointerAfterWhitespaceEnd]['code'] !== T_DOC_COMMENT_OPEN_TAG
 			&& (
 				$tokens[$useEndPointer]['line'] === $tokens[$pointerAfterWhitespaceEnd]['line']
 				|| $tokens[$useEndPointer]['line'] + 1 === $tokens[$pointerAfterWhitespaceEnd]['line']
 			)
 		) {
-			$useEndPointer = array_key_exists('comment_closer', $tokens[$pointerAfterWhitespaceEnd])
-				? $tokens[$pointerAfterWhitespaceEnd]['comment_closer']
-				: CommentHelper::getMultilineCommentEndPointer($phpcsFile, $pointerAfterWhitespaceEnd);
+			$useEndPointer = CommentHelper::getMultilineCommentEndPointer($phpcsFile, $pointerAfterWhitespaceEnd);
 			/** @var int $pointerAfterWhitespaceEnd */
 			$pointerAfterWhitespaceEnd = TokenHelper::findNextExcluding($phpcsFile, T_WHITESPACE, $useEndPointer + 1);
 		}
@@ -183,7 +183,7 @@ private function checkLinesAfterLastUse(File $phpcsFile, UseStatement $lastUse):
 		}
 
 		$linesToAdd = $requiredLinesCountAfterLastUse;
-		if (in_array($tokens[$useEndPointer]['code'], TokenHelper::$inlineCommentTokenCodes, true)) {
+		if (CommentHelper::isLineComment($phpcsFile, $useEndPointer)) {
 			$linesToAdd--;
 		}
 

tests/Sniffs/Namespaces/UseSpacingSniffTest.php

@@ -45,6 +45,17 @@ public function testDefaultSettingsWithCommentsErrors(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testDefaultSettingsWithComments2Errors(): void
+	{
+		$report = self::checkFile(__DIR__ . '/data/useSpacingWithDefaultSettingsWithComments2Errors.php');
+
+		self::assertSame(1, $report->getErrorCount());
+
+		self::assertSniffError($report, 3, UseSpacingSniff::CODE_INCORRECT_LINES_COUNT_AFTER_LAST_USE);
+
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testDefaultSettingsWithInlineCommentsNoErrors(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/useSpacingWithDefaultSettingsWithInlineCommentsNoErrors.php');

tests/Sniffs/Namespaces/data/useSpacingWithDefaultSettingsWithComments2Errors.fixed.php

@@ -0,0 +1,11 @@
+<?php declare(strict_types = 1);
+
+use DateTimeImmutable;
+
+/**
+ * Whatever
+ */
+class Whatever
+{
+
+}

tests/Sniffs/Namespaces/data/useSpacingWithDefaultSettingsWithComments2Errors.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types = 1);
+
+use DateTimeImmutable;
+/**
+ * Whatever
+ */
+class Whatever
+{
+
+}

tests/Sniffs/Namespaces/data/useSpacingWithDefaultSettingsWithCommentsErrors.fixed.php

@@ -13,7 +13,7 @@
  * Anything
  */
 use const PHP_VERSION_ID;
-/**
+/*
  * Nothing
  */
 

tests/Sniffs/Namespaces/data/useSpacingWithDefaultSettingsWithCommentsErrors.php

@@ -16,7 +16,7 @@
  * Anything
  */
 use const PHP_VERSION_ID;
-/**
+/*
  * Nothing
  */
 

tests/Sniffs/Namespaces/data/useSpacingWithDefaultSettingsWithCommentsNoErrors.php

@@ -13,10 +13,10 @@
  * Anything
  */
 use const PHP_VERSION_ID;
+
 /**
  * Nothing
  */
-
 class Whatever
 {