AttributesCheck - detect deprecated attributes

Author: ondrejmirtes

conf/config.neon

@@ -945,6 +945,8 @@ services:
 
 	-
 		class: PHPStan\Rules\AttributesCheck
+		arguments:
+			deprecationRulesInstalled: %deprecationRulesInstalled%
 
 	-
 		class: PHPStan\Rules\Arrays\NonexistentOffsetInArrayDimFetchCheck

src/Rules/AttributesCheck.php

@@ -21,6 +21,7 @@ public function __construct(
 		private ReflectionProvider $reflectionProvider,
 		private FunctionCallParametersCheck $functionCallParametersCheck,
 		private ClassCaseSensitivityCheck $classCaseSensitivityCheck,
+		private bool $deprecationRulesInstalled,
 	)
 	{
 	}
@@ -84,6 +85,15 @@ public function check(
 					$alreadyPresent[$loweredName] = true;
 				}
 
+				if ($this->deprecationRulesInstalled && $attributeClass->isDeprecated()) {
+					if ($attributeClass->getDeprecatedDescription() !== null) {
+						$deprecatedError = sprintf('Attribute class %s is deprecated: %s', $name, $attributeClass->getDeprecatedDescription());
+					} else {
+						$deprecatedError = sprintf('Attribute class %s is deprecated.', $name);
+					}
+					$errors[] = RuleErrorBuilder::message($deprecatedError)->line($attribute->getLine())->build();
+				}
+
 				if (!$attributeClass->hasConstructor()) {
 					if (count($attribute->args) > 0) {
 						$errors[] = RuleErrorBuilder::message(sprintf('Attribute class %s does not have a constructor and must be instantiated without any parameters.', $name))->line($attribute->getLine())->build();

tests/PHPStan/Rules/Classes/ClassAttributesRuleTest.php

@@ -39,6 +39,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Classes/ClassConstantAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/EnumCases/EnumCaseAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Functions/ArrowFunctionAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Functions/ClosureAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Functions/FunctionAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Functions/ParamAttributesRuleTest.php

@@ -38,6 +38,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Methods/MethodAttributesRuleTest.php

@@ -40,6 +40,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}

tests/PHPStan/Rules/Properties/PropertyAttributesRuleTest.php

@@ -37,6 +37,7 @@ protected function getRule(): Rule
 					true,
 				),
 				new ClassCaseSensitivityCheck($reflectionProvider, false),
+				true,
 			),
 		);
 	}
@@ -51,4 +52,18 @@ public function testRule(): void
 		]);
 	}
 
+	public function testDeprecatedAttribute(): void
+	{
+		$this->analyse([__DIR__ . '/data/property-attributes-deprecated.php'], [
+			[
+				'Attribute class DeprecatedPropertyAttribute\DoSomethingTheOldWay is deprecated.',
+				16,
+			],
+			[
+				'Attribute class DeprecatedPropertyAttribute\DoSomethingTheOldWayWithDescription is deprecated: Use something else please',
+				19,
+			],
+		]);
+	}
+
 }

tests/PHPStan/Rules/Properties/data/property-attributes-deprecated.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace DeprecatedPropertyAttribute;
+
+/**
+ * @deprecated
+ */
+#[\Attribute]
+final class DoSomethingTheOldWay
+{
+}
+
+
+final class SomeDTO
+{
+	#[DoSomethingTheOldWay]
+	public readonly string $property;
+
+	#[DoSomethingTheOldWayWithDescription]
+	public readonly string $property2;
+}
+
+/**
+ * @deprecated Use something else please
+ */
+#[\Attribute]
+final class DoSomethingTheOldWayWithDescription
+{
+}