Ignore annotation names

fixes #1603
slevomat · Aug 4, 2023 · cb3072a · cb3072a
1 parent 4b2af2f
commit cb3072a
Showing 1 changed file with 21 additions and 2 deletions.
diff --git a/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php b/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php
@@ -12,6 +12,7 @@
 use SlevomatCodingStandard\Helpers\NamespaceHelper;
 use SlevomatCodingStandard\Helpers\PhpDocParserHelper;
 use SlevomatCodingStandard\Helpers\ReferencedName;
+use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
 use SlevomatCodingStandard\Helpers\TypeHelper;
 use SlevomatCodingStandard\Helpers\TypeHintHelper;
 use function sprintf;
@@ -23,6 +24,9 @@ class FullyQualifiedClassNameInAnnotationSniff implements Sniff
 
 	public const CODE_NON_FULLY_QUALIFIED_CLASS_NAME = 'NonFullyQualifiedClassName';
 
+	/** @var list<string> */
+	public $ignoredAnnotationNames = [];
+
 	/**
 	 * @return array<int, (int|string)>
 	 */
@@ -58,6 +62,11 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
 					continue;
 				}
 
+				$annotationName = $annotation->getName();
+				if (in_array($annotationName, $this->getIgnoredAnnotationNames())) {
+					continue;
+				}
+
 				$fullyQualifiedTypeHint = TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $docCommentOpenPointer, $typeHint);
 				if ($fullyQualifiedTypeHint === $typeHint) {
 					continue;
@@ -66,7 +75,7 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
 				$fix = $phpcsFile->addFixableError(sprintf(
 					'Class name %s in %s should be referenced via a fully qualified name.',
 					$fullyQualifiedTypeHint,
-					$annotation->getName()
+					$annotationName
 				), $annotation->getStartPointer(), self::CODE_NON_FULLY_QUALIFIED_CLASS_NAME);
 
 				if (!$fix) {
@@ -120,7 +129,7 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
 					'%s name %s in %s should be referenced via a fully qualified name.',
 					$isClassConstant ? 'Class' : 'Constant',
 					$fullyQualifiedTypeHint,
-					$annotation->getName()
+					$annotationName
 				), $annotation->getStartPointer(), self::CODE_NON_FULLY_QUALIFIED_CLASS_NAME);
 
 				if (!$fix) {
@@ -158,4 +167,14 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void
 		}
 	}
 
+	/**
+	 * @return list<string>
+	 */
+	private function getIgnoredAnnotationNames(): array
+	{
+		$this->ignoredAnnotationNames = SniffSettingsHelper::normalizeArray($this->ignoredAnnotationNames);
+
+		return $this->ignoredAnnotationNames;
+	}
+
 }