SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses: Fixer should not remove doc comments

Author: kukulich

SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php

@@ -4,6 +4,7 @@
 
 use PHP_CodeSniffer\Files\File;
 use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Util\Tokens;
 use SlevomatCodingStandard\Helpers\CommentHelper;
 use SlevomatCodingStandard\Helpers\FixerHelper;
 use SlevomatCodingStandard\Helpers\NamespaceHelper;
@@ -107,7 +108,7 @@ private function fixAlphabeticalOrder(File $phpcsFile, array $useStatements): vo
 		foreach ($useStatements as $useStatement) {
 			$pointerBeforeUseStatement = TokenHelper::findPreviousNonWhitespace($phpcsFile, $useStatement->getPointer() - 1);
 
-			if (!in_array($tokens[$pointerBeforeUseStatement]['code'], TokenHelper::$inlineCommentTokenCodes, true)) {
+			if (!in_array($tokens[$pointerBeforeUseStatement]['code'], Tokens::$commentTokens, true)) {
 				continue;
 			}
 
@@ -116,7 +117,9 @@ private function fixAlphabeticalOrder(File $phpcsFile, array $useStatements): vo
 				continue;
 			}
 
-			$commentStartPointer = CommentHelper::getMultilineCommentStartPointer($phpcsFile, $pointerBeforeUseStatement);
+			$commentStartPointer = in_array($tokens[$pointerBeforeUseStatement]['code'], TokenHelper::$inlineCommentTokenCodes, true)
+				? CommentHelper::getMultilineCommentStartPointer($phpcsFile, $pointerBeforeUseStatement)
+				: $tokens[$pointerBeforeUseStatement]['comment_opener'];
 
 			$commentsBefore[$useStatement->getPointer()] = TokenHelper::getContent(
 				$phpcsFile,

tests/Sniffs/Namespaces/AlphabeticallySortedUsesSniffTest.php

@@ -86,6 +86,16 @@ public function testFixableWithCommentBeforeFirst(): void
 		self::assertAllFixedInFile($report);
 	}
 
+	public function testFixableWithDocComment(): void
+	{
+		$report = self::checkFile(
+			__DIR__ . '/data/fixableAlphabeticalSortedUsesWithDocComment.php',
+			[],
+			[AlphabeticallySortedUsesSniff::CODE_INCORRECT_ORDER]
+		);
+		self::assertAllFixedInFile($report);
+	}
+
 	public function testFixableNotPsr12Compatible(): void
 	{
 		$report = self::checkFile(__DIR__ . '/data/fixableAlphabeticalSortedUsesNotPsr12Compatible.php', [

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

@@ -0,0 +1,25 @@
+<?php
+
+namespace Abc;
+
+/**
+ * A comment
+ */
+use A;
+/**
+ * B comment
+ */
+use B;
+/**
+ * C comment
+ */
+use C;
+/**
+ * D comment
+ */
+use D;
+
+class Alphabetical
+{
+
+}

tests/Sniffs/Namespaces/data/fixableAlphabeticalSortedUsesWithDocComment.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Abc;
+
+/**
+ * C comment
+ */
+use C;
+/**
+ * B comment
+ */
+use B;
+/**
+ * D comment
+ */
+use D;
+/**
+ * A comment
+ */
+use A;
+
+class Alphabetical
+{
+
+}