DocCommentSpacingSniff: Fixed support for @phpstan and @phpcs annotations

Author: kukulich

SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php

@@ -21,6 +21,7 @@
 use function asort;
 use function count;
 use function explode;
+use function in_array;
 use function ksort;
 use function max;
 use function preg_match;
@@ -634,17 +635,14 @@ private function sortAnnotationsToGroups(array $annotations): array
 
 		foreach (array_keys($sortedAnnotationsGroups) as $annotationsGroupPosition) {
 			$expectedAnnotationsGroupOrder = array_flip($expectedAnnotationsGroups[$annotationsGroupPosition]);
-			usort($sortedAnnotationsGroups[$annotationsGroupPosition], static function (Annotation $firstAnnotation, Annotation $secondAnnotation) use ($expectedAnnotationsGroupOrder): int {
-				$getExpectedOrder = static function (string $annotationName) use ($expectedAnnotationsGroupOrder): int {
+			usort($sortedAnnotationsGroups[$annotationsGroupPosition], function (Annotation $firstAnnotation, Annotation $secondAnnotation) use ($expectedAnnotationsGroupOrder): int {
+				$getExpectedOrder = function (string $annotationName) use ($expectedAnnotationsGroupOrder): int {
 					if (array_key_exists($annotationName, $expectedAnnotationsGroupOrder)) {
 						return $expectedAnnotationsGroupOrder[$annotationName];
 					}
 
 					foreach ($expectedAnnotationsGroupOrder as $expectedAnnotationName => $expectedAnnotationOrder) {
-						if (
-							substr($expectedAnnotationName, -1) === '\\'
-							&& strpos($annotationName, $expectedAnnotationName) === 0
-						) {
+						if ($this->isAnnotationNameInAnnotationNamespace($expectedAnnotationName, $annotationName)) {
 							return $expectedAnnotationOrder;
 						}
 					}
@@ -665,13 +663,18 @@ private function sortAnnotationsToGroups(array $annotations): array
 		return $sortedAnnotationsGroups;
 	}
 
+	private function isAnnotationNameInAnnotationNamespace(string $annotationNamespace, string $annotationName): bool
+	{
+		return in_array(substr($annotationNamespace, -1), ['\\', '-', ':'], true) && strpos($annotationName, $annotationNamespace) === 0;
+	}
+
 	private function isAnnotationMatched(Annotation $annotation, string $annotationName): bool
 	{
 		if ($annotation->getName() === $annotationName) {
 			return true;
 		}
 
-		return substr($annotationName, -1) === '\\' && strpos($annotation->getName(), $annotationName) === 0;
+		return $this->isAnnotationNameInAnnotationNamespace($annotationName, $annotation->getName());
 	}
 
 	private function checkLinesAfterLastContent(

tests/Sniffs/Commenting/DocCommentSpacingSniffTest.php

@@ -137,6 +137,8 @@ public function testAnnotationsGroupsErrors(): void
 				'@link,@todo',
 				'@whatever',
 				'@anything',
+				'@phpstan-param,@phpstan-return,@phpstan-',
+				'@phpcs:',
 			],
 		], [
 			DocCommentSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_ANNOTATIONS_GROUPS,
@@ -145,7 +147,7 @@ public function testAnnotationsGroupsErrors(): void
 			DocCommentSpacingSniff::CODE_INCORRECT_ORDER_OF_ANNOTATIONS_IN_GROUP,
 		]);
 
-		self::assertSame(8, $report->getErrorCount());
+		self::assertSame(9, $report->getErrorCount());
 
 		self::assertSniffError($report, 20, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 		self::assertSniffError($report, 34, DocCommentSpacingSniff::CODE_INCORRECT_LINES_COUNT_BETWEEN_ANNOTATIONS_GROUPS);
@@ -155,6 +157,7 @@ public function testAnnotationsGroupsErrors(): void
 		self::assertSniffError($report, 74, DocCommentSpacingSniff::CODE_INCORRECT_ORDER_OF_ANNOTATIONS_GROUPS);
 		self::assertSniffError($report, 83, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 		self::assertSniffError($report, 92, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
+		self::assertSniffError($report, 102, DocCommentSpacingSniff::CODE_INCORRECT_ANNOTATIONS_GROUP);
 
 		self::assertAllFixedInFile($report);
 	}

tests/Sniffs/Commenting/data/docCommentSpacingAnnotationsGroupsErrors.fixed.php

@@ -98,4 +98,19 @@ public function twoUndefinedAnnotations()
 
 	}
 
+	/**
+	 * @param int $a
+	 *
+	 * @phpstan-param int $a
+	 * @phpstan-return bool
+	 * @phpstan-whatever X
+	 *
+	 * @phpcs:disable
+	 * @phpcs:enable
+	 */
+	public function phpstanAndPhpcsAnnotations($a)
+	{
+		return false;
+	}
+
 }

tests/Sniffs/Commenting/data/docCommentSpacingAnnotationsGroupsErrors.php

@@ -98,4 +98,18 @@ public function twoUndefinedAnnotations()
 
 	}
 
+	/**
+	 * @phpstan-whatever X
+	 * @phpcs:disable
+	 * @phpstan-param int $a
+	 * @phpcs:enable
+	 * @phpstan-return bool
+	 *
+	 * @param int $a
+	 */
+	public function phpstanAndPhpcsAnnotations($a)
+	{
+		return false;
+	}
+
 }