Make #[Override] attribute errors fixable

Author: ondrejmirtes

src/Rules/Methods/OverridingMethodRule.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Rules\Methods;
 
 use PhpParser\Node;
+use PhpParser\Node\Attribute;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassMethodNode;
 use PHPStan\Php\PhpVersion;
@@ -94,6 +95,10 @@ public function processNode(Node $node, Scope $scope): array
 					))
 						->nonIgnorable()
 						->identifier('method.override')
+						->fixNode($node->getOriginalNode(), function (Node\Stmt\ClassMethod $method) {
+							$method->attrGroups = $this->filterOverrideAttribute($method->attrGroups);
+							return $method;
+						})
 						->build(),
 				];
 			}
@@ -116,7 +121,16 @@ public function processNode(Node $node, Scope $scope): array
 				$method->getName(),
 				$prototypeDeclaringClass->getDisplayName(true),
 				$prototype->getName(),
-			))->identifier('method.missingOverride')->build();
+			))
+				->identifier('method.missingOverride')
+				->fixNode($node->getOriginalNode(), static function (Node\Stmt\ClassMethod $method) {
+					$method->attrGroups[] = new Node\AttributeGroup([
+						new Attribute(new Node\Name\FullyQualified('Override')),
+					]);
+
+					return $method;
+				})
+				->build();
 		}
 		if ($prototype->isFinalByKeyword()->yes()) {
 			$messages[] = RuleErrorBuilder::message(sprintf(
@@ -278,6 +292,30 @@ public function processNode(Node $node, Scope $scope): array
 		return $this->addErrors($messages, $node, $scope);
 	}
 
+	/**
+	 * @param Node\AttributeGroup[] $attrGroups
+	 * @return Node\AttributeGroup[]
+	 */
+	private function filterOverrideAttribute(array $attrGroups): array
+	{
+		foreach ($attrGroups as $i => $attrGroup) {
+			foreach ($attrGroup->attrs as $j => $attr) {
+				if ($attr->name->toLowerString() !== 'override') {
+					continue;
+				}
+
+				unset($attrGroup->attrs[$j]);
+				if (count($attrGroup->attrs) !== 0) {
+					continue;
+				}
+
+				unset($attrGroups[$i]);
+			}
+		}
+
+		return $attrGroups;
+	}
+
 	/**
 	 * @param list<IdentifierRuleError> $errors
 	 * @return list<IdentifierRuleError>

tests/PHPStan/Rules/Methods/OverridingMethodRuleTest.php

@@ -834,4 +834,15 @@ public function testSimpleXmlElementChildClass(): void
 		$this->analyse([__DIR__ . '/data/simple-xml-element-child.php'], []);
 	}
 
+	public function testFixOverride(): void
+	{
+		if (PHP_VERSION_ID < 80300) {
+			$this->markTestSkipped('Test requires PHP 8.3.');
+		}
+
+		$this->phpVersionId = PHP_VERSION_ID;
+		$this->checkMissingOverrideMethodAttribute = true;
+		$this->fix(__DIR__ . '/data/fix-override-attribute.php', __DIR__ . '/data/fix-override-attribute.php.fixed');
+	}
+
 }

tests/PHPStan/Rules/Methods/data/fix-override-attribute.php

@@ -0,0 +1,34 @@
+<?php // lint >= 8.3
+
+namespace FixOverrideAttribute;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+
+	}
+
+}
+
+class Bar extends Foo
+{
+
+	public function doFoo(): void
+	{
+
+	}
+
+
+	public function doBar(): void
+	{
+
+	}
+
+	#[\Override]
+	public function doBaz(): void
+	{
+	}
+
+}

tests/PHPStan/Rules/Methods/data/fix-override-attribute.php.fixed

@@ -0,0 +1,34 @@
+<?php // lint >= 8.3
+
+namespace FixOverrideAttribute;
+
+class Foo
+{
+
+	public function doFoo(): void
+	{
+
+	}
+
+}
+
+class Bar extends Foo
+{
+
+	#[\Override]
+	public function doFoo(): void
+	{
+
+	}
+
+
+	public function doBar(): void
+	{
+
+	}
+
+	public function doBaz(): void
+	{
+	}
+
+}