[BCB] Constructor parameter $isEquality in AssertTag*ValueNode made required

Author: ondrejmirtes

UPGRADING.md

@@ -76,7 +76,7 @@ If these parts are supposed to be PHPDoc descriptions, you need to put whitespac
 /** @return array{foo: int} } */
 ```
 
-## Type aliases with invalid types are preserved
+### Type aliases with invalid types are preserved
 
 In phpdoc-parser 1.x, invalid type alias syntax was represented as [`InvalidTagValueNode`](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Ast.PhpDoc.InvalidTagValueNode.html), losing information about a type alias being present.
 
@@ -88,19 +88,19 @@ In phpdoc-parser 1.x, invalid type alias syntax was represented as [`InvalidTagV
 
 This `@phpstan-type` is missing the actual type to alias. In phpdoc-parser 2.0 this is now represented as [`TypeAliasTagValueNode`](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Ast.PhpDoc.TypeAliasTagValueNode.html) (instead of `InvalidTagValueNode`) with [`InvalidTypeNode`](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Ast.Type.InvalidTypeNode.html) in place of the type.
 
-## Removal of QuoteAwareConstExprStringNode
+### Removal of QuoteAwareConstExprStringNode
 
 The class [QuoteAwareConstExprStringNode](https://phpstan.github.io/phpdoc-parser/1.23.x/PHPStan.PhpDocParser.Ast.ConstExpr.QuoteAwareConstExprStringNode.html) has been removed.
 
 Instead, [ConstExprStringNode](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Ast.ConstExpr.ConstExprStringNode.html) gained information about the kind of quotes being used.
 
-## Removed 2nd parameter of `ConstExprParser::parse()` (`$trimStrings`)
+### Removed 2nd parameter of `ConstExprParser::parse()` (`$trimStrings`)
 
 `ConstExprStringNode::$value` now contains unescaped values without surrounding `''` or `""` quotes.
 
 Use `ConstExprStringNode::__toString()` or [`Printer`](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Printer.Printer.html) to get the escaped value along with surrounding quotes.
 
-## Text between tags always belongs to description
+### Text between tags always belongs to description
 
 Multi-line descriptions between tags were previously represented as separate [PhpDocTextNode](https://phpstan.github.io/phpdoc-parser/2.0.x/PHPStan.PhpDocParser.Ast.PhpDoc.PhpDocTextNode.html):
 
@@ -113,3 +113,7 @@ Multi-line descriptions between tags were previously represented as separate [Ph
 ```
 
 The line with `some text in the middle` in phpdoc-parser 2.0 is now part of the description of the first `@param` tag.
+
+### Minor BC breaks
+
+* Constructor parameter `$isEquality` in `AssertTag*ValueNode` made required

src/Ast/PhpDoc/AssertTagMethodValueNode.php

@@ -24,7 +24,7 @@ class AssertTagMethodValueNode implements PhpDocTagValueNode
 	/** @var string (may be empty) */
 	public string $description;
 
-	public function __construct(TypeNode $type, string $parameter, string $method, bool $isNegated, string $description, bool $isEquality = false)
+	public function __construct(TypeNode $type, string $parameter, string $method, bool $isNegated, string $description, bool $isEquality)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;

src/Ast/PhpDoc/AssertTagPropertyValueNode.php

@@ -24,7 +24,7 @@ class AssertTagPropertyValueNode implements PhpDocTagValueNode
 	/** @var string (may be empty) */
 	public string $description;
 
-	public function __construct(TypeNode $type, string $parameter, string $property, bool $isNegated, string $description, bool $isEquality = false)
+	public function __construct(TypeNode $type, string $parameter, string $property, bool $isNegated, string $description, bool $isEquality)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;

src/Ast/PhpDoc/AssertTagValueNode.php

@@ -22,7 +22,7 @@ class AssertTagValueNode implements PhpDocTagValueNode
 	/** @var string (may be empty) */
 	public string $description;
 
-	public function __construct(TypeNode $type, string $parameter, bool $isNegated, string $description, bool $isEquality = false)
+	public function __construct(TypeNode $type, string $parameter, bool $isNegated, string $description, bool $isEquality)
 	{
 		$this->type = $type;
 		$this->parameter = $parameter;

tests/PHPStan/Parser/PhpDocParserTest.php

@@ -4667,6 +4667,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4683,6 +4684,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4699,6 +4701,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'assert Type to $var',
+						false,
 					),
 				),
 			]),
@@ -4718,6 +4721,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4735,6 +4739,7 @@ public function provideAssertTagsData(): Iterator
 						'method',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4752,6 +4757,7 @@ public function provideAssertTagsData(): Iterator
 						'property',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4768,6 +4774,7 @@ public function provideAssertTagsData(): Iterator
 						'$this',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4784,6 +4791,7 @@ public function provideAssertTagsData(): Iterator
 						'$this',
 						false,
 						'assert Type to $this',
+						false,
 					),
 				),
 			]),
@@ -4808,6 +4816,7 @@ public function provideAssertTagsData(): Iterator
 						'$this',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4825,6 +4834,7 @@ public function provideAssertTagsData(): Iterator
 						'method',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4842,6 +4852,7 @@ public function provideAssertTagsData(): Iterator
 						'property',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4858,6 +4869,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4874,6 +4886,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						false,
 						'',
+						false,
 					),
 				),
 			]),
@@ -4890,6 +4903,7 @@ public function provideAssertTagsData(): Iterator
 						'$var',
 						true,
 						'',
+						false,
 					),
 				),
 			]),