Add custom PHPStan rule to detect wrong Task class names

CHANGELOG.md

@@ -1,3 +1,9 @@
+2.1.0 (unreleased)
+=====
+
+* (feature) Add custom PHPStan rule to detect wrong `Task` class names. 
+
+
 2.0.0
 =====
 

composer.json

@@ -20,6 +20,7 @@
 	"require-dev": {
 		"bamarni/composer-bin-plugin": "^1.8.2",
 		"composer/composer": "^2.8.9",
+		"phpstan/phpstan": "^2.1.17",
 		"roave/security-advisories": "dev-latest"
 	},
 	"autoload": {

phpstan/lib.neon

@@ -33,3 +33,6 @@ parameters:
 		-
 			identifier: method.deprecated
 			path: %currentWorkingDirectory%/tests/*
+
+rules:
+	- Janus\Phpstan\Rule\TaskRule

src/Phpstan/Rule/TaskRule.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+
+namespace Janus\Phpstan\Rule;
+
+use PhpParser\Node;
+use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements Rule<Class_>
+ *
+ * @final
+ */
+readonly class TaskRule implements Rule
+{
+	/**
+	 * @inheritDoc
+	 */
+	#[\Override]
+	public function getNodeType () : string
+	{
+		return Class_::class;
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	#[\Override]
+	public function processNode (Node $node, Scope $scope) : array
+	{
+		\assert($node instanceof Class_);
+		$className = $node->name?->toString();
+
+		if (null === $className || !$node->extends instanceof Name)
+		{
+			return [];
+		}
+
+		$extendedClassName = $node->extends->toString();
+
+		if (
+			"Torr\\TaskManager\\Task\\Task" === $extendedClassName
+			&& !str_ends_with($className, "Task")
+		)
+		{
+			return [
+				RuleErrorBuilder::message("Task classes must use the 'Task' suffix.")
+					->identifier("21torr.custom.task.suffix")
+					->build(),
+			];
+		}
+
+		return [];
+	}
+}