report required template type after optional

jiripudil · jiripudil · commit 86c307bcfd96 · 2024-10-07T14:47:35.000+02:00
diff --git a/src/Rules/Generics/ClassTemplateTypeRule.php b/src/Rules/Generics/ClassTemplateTypeRule.php
@@ -51,6 +51,7 @@ public function processNode(Node $node, Scope $scope): array
 			sprintf('PHPDoc tag @template %%s for %s with bound type %%s is not supported.', $displayName),
 			sprintf('PHPDoc tag @template %%s for %s has invalid default type %%s.', $displayName),
 			sprintf('Default type %%s in PHPDoc tag @template %%s for %s is not subtype of bound type %%s.', $displayName),
+			sprintf('PHPDoc tag @template %%s for %s does not have a default type but follows an optional @template %%s.', $displayName),
 		);
 	}
 
diff --git a/src/Rules/Generics/FunctionTemplateTypeRule.php b/src/Rules/Generics/FunctionTemplateTypeRule.php
@@ -62,6 +62,7 @@ public function processNode(Node $node, Scope $scope): array
 			sprintf('PHPDoc tag @template %%s for function %s() with bound type %%s is not supported.', $escapedFunctionName),
 			sprintf('PHPDoc tag @template %%s for function %s() has invalid default type %%s.', $escapedFunctionName),
 			sprintf('Default type %%s in PHPDoc tag @template %%s for function %s() is not subtype of bound type %%s.', $escapedFunctionName),
+			sprintf('PHPDoc tag @template %%s for function %s() does not have a default type but follows an optional @template %%s.', $escapedFunctionName),
 		);
 	}
 
diff --git a/src/Rules/Generics/InterfaceTemplateTypeRule.php b/src/Rules/Generics/InterfaceTemplateTypeRule.php
@@ -48,6 +48,7 @@ public function processNode(Node $node, Scope $scope): array
 			sprintf('PHPDoc tag @template %%s for interface %s with bound type %%s is not supported.', $escapadInterfaceName),
 			sprintf('PHPDoc tag @template %%s for interface %s has invalid default type %%s.', $escapadInterfaceName),
 			sprintf('Default type %%s in PHPDoc tag @template %%s for interface %s is not subtype of bound type %%s.', $escapadInterfaceName),
+			sprintf('PHPDoc tag @template %%s for interface %s does not have a default type but follows an optional @template %%s.', $escapadInterfaceName),
 		);
 	}
 
diff --git a/src/Rules/Generics/MethodTagTemplateTypeCheck.php b/src/Rules/Generics/MethodTagTemplateTypeCheck.php
@@ -63,6 +63,7 @@ public function check(
 				sprintf('PHPDoc tag @method template %%s for method %s::%s() with bound type %%s is not supported.', $escapedClassName, $escapedMethodName),
 				sprintf('PHPDoc tag @method template %%s for method %s::%s() has invalid default type %%s', $escapedClassName, $escapedMethodName),
 				sprintf('Default type %%s in PHPDoc tag @method template %%s for method %s::%s() is not subtype of bound type %%s', $escapedClassName, $escapedMethodName),
+				sprintf('PHPDoc tag @template %%s for method %s::%s() does not have a default type but follows an optional @template %%s.', $escapedClassName, $escapedMethodName),
 			));
 
 			foreach (array_keys($methodTemplateTags) as $name) {
diff --git a/src/Rules/Generics/MethodTemplateTypeRule.php b/src/Rules/Generics/MethodTemplateTypeRule.php
@@ -68,6 +68,7 @@ public function processNode(Node $node, Scope $scope): array
 			sprintf('PHPDoc tag @template %%s for method %s::%s() with bound type %%s is not supported.', $escapedClassName, $escapedMethodName),
 			sprintf('PHPDoc tag @template %%s for method %s::%s() has invalid default type %%s.', $escapedClassName, $escapedMethodName),
 			sprintf('Default type %%s in PHPDoc tag @template %%s for method %s::%s() is not subtype of bound type %%s.', $escapedClassName, $escapedMethodName),
+			sprintf('PHPDoc tag @template %%s for method %s::%s() does not have a default type but follows an optional @template %%s.', $escapedClassName, $escapedMethodName),
 		);
 
 		$classTemplateTypes = $classReflection->getTemplateTypeMap()->getTypes();
diff --git a/src/Rules/Generics/TemplateTypeCheck.php b/src/Rules/Generics/TemplateTypeCheck.php
@@ -64,9 +64,11 @@ public function check(
 		string $notSupportedBoundMessage,
 		string $invalidDefaultTypeMessage,
 		string $defaultNotSubtypeOfBoundMessage,
+		string $requiredTypeAfterOptionalMessage,
 	): array
 	{
 		$messages = [];
+		$templateTagWithDefaultType = null;
 		foreach ($templateTags as $templateTag) {
 			$templateTagName = $scope->resolveName(new Node\Name($templateTag->getName()));
 			if ($this->reflectionProvider->hasClass($templateTagName)) {
@@ -146,9 +148,19 @@ public function check(
 
 			$defaultType = $templateTag->getDefault();
 			if ($defaultType === null) {
+				if ($templateTagWithDefaultType !== null) {
+					$messages[] = RuleErrorBuilder::message(sprintf(
+						$requiredTypeAfterOptionalMessage,
+						$templateTagName,
+						$templateTagWithDefaultType,
+					))->identifier('generics.requiredTypeAfterOptional')->build();
+				}
+
 				continue;
 			}
 
+			$templateTagWithDefaultType = $templateTagName;
+
 			foreach ($defaultType->getReferencedClasses() as $referencedClass) {
 				if (!$this->reflectionProvider->hasClass($referencedClass)) {
 					$messages[] = RuleErrorBuilder::message(sprintf(
diff --git a/src/Rules/Generics/TraitTemplateTypeRule.php b/src/Rules/Generics/TraitTemplateTypeRule.php
@@ -62,6 +62,7 @@ public function processNode(Node $node, Scope $scope): array
 			sprintf('PHPDoc tag @template %%s for trait %s with bound type %%s is not supported.', $escapedTraitName),
 			sprintf('PHPDoc tag @template %%s for trait %s has invalid default type %%s.', $escapedTraitName),
 			sprintf('Default type %%s in PHPDoc tag @template %%s for trait %s is not subtype of bound type %%s.', $escapedTraitName),
+			sprintf('PHPDoc tag @template %%s for trait %s does not have a default type but follows an optional @template %%s.', $escapedTraitName),
 		);
 	}
 
diff --git a/src/Rules/PhpDoc/GenericCallableRuleHelper.php b/src/Rules/PhpDoc/GenericCallableRuleHelper.php
@@ -62,6 +62,7 @@ public function check(
 				sprintf('PHPDoc tag %s template %%s of %s with bound type %%s is not supported.', $location, $typeDescription),
 				sprintf('PHPDoc tag %s template %%s of %s has invalid default type %%s.', $location, $typeDescription),
 				sprintf('Default type %%s in PHPDoc tag %s template %%s of %s is not subtype of bound type %%s.', $location, $typeDescription),
+				sprintf('PHPDoc tag %s template %%s of %s does not have a default type but follows an optional template %%s.', $location, $typeDescription),
 			);
 
 			$templateTags = $type->getTemplateTags();
diff --git a/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/ClassTemplateTypeRuleTest.php
@@ -94,6 +94,10 @@ public function testRule(): void
 				'Default type bool in PHPDoc tag @template T for class ClassTemplateType\Venenatis is not subtype of bound type object.',
 				129,
 			],
+			[
+				'PHPDoc tag @template V for class ClassTemplateType\Mauris does not have a default type but follows an optional @template U.',
+				139,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Generics/FunctionTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/FunctionTemplateTypeRuleTest.php
@@ -75,6 +75,10 @@ public function testRule(): void
 				'Default type bool in PHPDoc tag @template T for function FunctionTemplateType\outOfBoundsDefault() is not subtype of bound type object.',
 				110,
 			],
+			[
+				'PHPDoc tag @template V for function FunctionTemplateType\requiredAfterOptional() does not have a default type but follows an optional @template U.',
+				120,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Generics/InterfaceTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/InterfaceTemplateTypeRuleTest.php
@@ -73,6 +73,10 @@ public function testRule(): void
 				'Default type bool in PHPDoc tag @template T for interface InterfaceTemplateType\OutOfBoundsDefault is not subtype of bound type object.',
 				90,
 			],
+			[
+				'PHPDoc tag @template V for interface InterfaceTemplateType\RequiredAfterOptional does not have a default type but follows an optional @template U.',
+				100,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Generics/MethodTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/MethodTemplateTypeRuleTest.php
@@ -81,6 +81,10 @@ public function testRule(): void
 				'Default type bool in PHPDoc tag @template T for method MethodTemplateType\InvalidDefault::outOfBounds() is not subtype of bound type object.',
 				130,
 			],
+			[
+				'PHPDoc tag @template V for method MethodTemplateType\InvalidDefault::requiredAfterOptional() does not have a default type but follows an optional @template U.',
+				140,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Generics/TraitTemplateTypeRuleTest.php b/tests/PHPStan/Rules/Generics/TraitTemplateTypeRuleTest.php
@@ -77,6 +77,10 @@ public function testRule(): void
 				'Default type bool in PHPDoc tag @template T for trait TraitTemplateType\Elit is not subtype of bound type object.',
 				80,
 			],
+			[
+				'PHPDoc tag @template V for trait TraitTemplateType\Consecteur does not have a default type but follows an optional @template U.',
+				90,
+			],
 		]);
 	}
 
diff --git a/tests/PHPStan/Rules/Generics/data/class-template.php b/tests/PHPStan/Rules/Generics/data/class-template.php
@@ -130,3 +130,13 @@ class Venenatis
 {
 
 }
+
+/**
+ * @template T
+ * @template U = string
+ * @template V
+ */
+class Mauris
+{
+
+}
diff --git a/tests/PHPStan/Rules/Generics/data/function-template.php b/tests/PHPStan/Rules/Generics/data/function-template.php
@@ -111,3 +111,13 @@ function outOfBoundsDefault()
 {
 
 }
+
+/**
+ * @template T
+ * @template U = string
+ * @template V
+ */
+function requiredAfterOptional()
+{
+
+}
diff --git a/tests/PHPStan/Rules/Generics/data/interface-template.php b/tests/PHPStan/Rules/Generics/data/interface-template.php
@@ -91,3 +91,13 @@ interface OutOfBoundsDefault
 {
 
 }
+
+/**
+ * @template T
+ * @template U = string
+ * @template V
+ */
+interface RequiredAfterOptional
+{
+
+}
diff --git a/tests/PHPStan/Rules/Generics/data/method-template.php b/tests/PHPStan/Rules/Generics/data/method-template.php
@@ -132,4 +132,14 @@ public function outOfBounds()
 
 	}
 
+	/**
+	 * @template T
+	 * @template U = string
+	 * @template V
+	 */
+	public function requiredAfterOptional()
+	{
+
+	}
+
 }
diff --git a/tests/PHPStan/Rules/Generics/data/trait-template.php b/tests/PHPStan/Rules/Generics/data/trait-template.php
@@ -81,3 +81,13 @@ trait Elit
 {
 
 }
+
+/**
+ * @template T
+ * @template U = string
+ * @template V
+ */
+trait Consecteur
+{
+
+}

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ public function processNode(Node $node, Scope $scope): array`
`51`	`51`	`sprintf('PHPDoc tag @template %%s for %s with bound type %%s is not supported.', $displayName),`
`52`	`52`	`sprintf('PHPDoc tag @template %%s for %s has invalid default type %%s.', $displayName),`
`53`	`53`	`sprintf('Default type %%s in PHPDoc tag @template %%s for %s is not subtype of bound type %%s.', $displayName),`
	`54`	`+ sprintf('PHPDoc tag @template %%s for %s does not have a default type but follows an optional @template %%s.', $displayName),`
`54`	`55`	`);`
`55`	`56`	`}`
`56`	`57`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,7 @@ public function processNode(Node $node, Scope $scope): array`
`62`	`62`	`sprintf('PHPDoc tag @template %%s for function %s() with bound type %%s is not supported.', $escapedFunctionName),`
`63`	`63`	`sprintf('PHPDoc tag @template %%s for function %s() has invalid default type %%s.', $escapedFunctionName),`
`64`	`64`	`sprintf('Default type %%s in PHPDoc tag @template %%s for function %s() is not subtype of bound type %%s.', $escapedFunctionName),`
	`65`	`+ sprintf('PHPDoc tag @template %%s for function %s() does not have a default type but follows an optional @template %%s.', $escapedFunctionName),`
`65`	`66`	`);`
`66`	`67`	`}`
`67`	`68`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ public function processNode(Node $node, Scope $scope): array`
`48`	`48`	`sprintf('PHPDoc tag @template %%s for interface %s with bound type %%s is not supported.', $escapadInterfaceName),`
`49`	`49`	`sprintf('PHPDoc tag @template %%s for interface %s has invalid default type %%s.', $escapadInterfaceName),`
`50`	`50`	`sprintf('Default type %%s in PHPDoc tag @template %%s for interface %s is not subtype of bound type %%s.', $escapadInterfaceName),`
	`51`	`+ sprintf('PHPDoc tag @template %%s for interface %s does not have a default type but follows an optional @template %%s.', $escapadInterfaceName),`
`51`	`52`	`);`
`52`	`53`	`}`
`53`	`54`