add bleeding-edge feature toggle

staabm · staabm · commit 03b31599701a · 2025-08-30T11:51:58.000+02:00
diff --git a/conf/bleedingEdge.neon b/conf/bleedingEdge.neon
@@ -8,3 +8,4 @@ parameters:
 		reportPreciseLineForUnusedFunctionParameter: true
 		internalTag: true
 		newStaticInAbstractClassStaticMethod: true
+		reportTooWideBool: true
diff --git a/conf/config.neon b/conf/config.neon
@@ -31,6 +31,7 @@ parameters:
 		reportPreciseLineForUnusedFunctionParameter: false
 		internalTag: false
 		newStaticInAbstractClassStaticMethod: false
+		reportTooWideBool: false
 	fileExtensions:
 		- php
 	checkAdvancedIsset: false
diff --git a/conf/parametersSchema.neon b/conf/parametersSchema.neon
@@ -35,6 +35,7 @@ parametersSchema:
 		reportPreciseLineForUnusedFunctionParameter: bool()
 		internalTag: bool()
 		newStaticInAbstractClassStaticMethod: bool()
+		reportTooWideBool: bool()
 	])
 	fileExtensions: listOf(string())
 	checkAdvancedIsset: bool()
diff --git a/src/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRule.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\AutowiredParameter;
 use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Node\FunctionReturnStatementsNode;
 use PHPStan\Rules\Rule;
@@ -18,6 +19,8 @@ final class TooWideFunctionReturnTypehintRule implements Rule
 
 	public function __construct(
 		private TooWideTypeCheck $check,
+		#[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]
+		private bool $reportTooWideBool,
 	)
 	{
 	}
@@ -40,6 +43,7 @@ public function processNode(Node $node, Scope $scope): array
 				$function->getName(),
 			),
 			false,
+			$this->reportTooWideBool,
 		);
 	}
 
diff --git a/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php b/src/Rules/TooWideTypehints/TooWideMethodReturnTypehintRule.php
@@ -21,6 +21,8 @@ public function __construct(
 		#[AutowiredParameter(ref: '%checkTooWideReturnTypesInProtectedAndPublicMethods%')]
 		private bool $checkProtectedAndPublicMethods,
 		private TooWideTypeCheck $check,
+		#[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]
+		private bool $reportTooWideBool,
 	)
 	{
 	}
@@ -59,6 +61,7 @@ public function processNode(Node $node, Scope $scope): array
 				$method->getName(),
 			),
 			!$isFirstDeclaration && !$method->isPrivate(),
+			$this->reportTooWideBool,
 		);
 	}
 
diff --git a/src/Rules/TooWideTypehints/TooWidePropertyTypeRule.php b/src/Rules/TooWideTypehints/TooWidePropertyTypeRule.php
@@ -4,6 +4,7 @@
 
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
+use PHPStan\DependencyInjection\AutowiredParameter;
 use PHPStan\DependencyInjection\RegisteredRule;
 use PHPStan\Node\ClassPropertiesNode;
 use PHPStan\Reflection\PropertyReflection;
@@ -26,6 +27,8 @@ public function __construct(
 		private ReadWritePropertiesExtensionProvider $extensionProvider,
 		private PropertyReflectionFinder $propertyReflectionFinder,
 		private TooWideTypeCheck $check,
+		#[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]
+		private bool $reportTooWideBool,
 	)
 	{
 	}
@@ -57,8 +60,10 @@ public function processNode(Node $node, Scope $scope): array
 
 			$propertyReflection = $classReflection->getNativeProperty($propertyName);
 			$propertyType = $propertyReflection->getWritableType();
-			if (!$propertyType instanceof UnionType && !$propertyType->isBoolean()->yes()) {
-				continue;
+			if (!$propertyType instanceof UnionType) {
+				if (!$propertyType->isBoolean()->yes() || !$this->reportTooWideBool) {
+					continue;
+				}
 			}
 			foreach ($this->extensionProvider->getExtensions() as $extension) {
 				if ($extension->isAlwaysRead($propertyReflection, $propertyName)) {
diff --git a/src/Rules/TooWideTypehints/TooWideTypeCheck.php b/src/Rules/TooWideTypehints/TooWideTypeCheck.php
@@ -66,11 +66,15 @@ public function checkFunction(
 		Type $functionReturnType,
 		string $functionDescription,
 		bool $checkDescendantClass,
+		bool $reportTooWideBool,
 	): array
 	{
 		$functionReturnType = TypeUtils::resolveLateResolvableTypes($functionReturnType);
-		if (!$functionReturnType instanceof UnionType && !$functionReturnType->isBoolean()->yes()) {
-			return [];
+
+		if (!$functionReturnType instanceof UnionType) {
+			if (!$functionReturnType->isBoolean()->yes() || !$reportTooWideBool) {
+				return [];
+			}
 		}
 		$statementResult = $node->getStatementResult();
 		if ($statementResult->hasYield()) {
diff --git a/tests/PHPStan/Analyser/nsrt/assert-docblock.php b/tests/PHPStan/Analyser/nsrt/assert-docblock.php
@@ -13,6 +13,7 @@ function validateStringArray(array $arr) : void {}
 /**
  * @param mixed[] $arr
  * @phpstan-assert-if-true string[] $arr
+ * @return true
  */
 function validateStringArrayIfTrue(array $arr) : bool {
 	return true;
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideFunctionReturnTypehintRuleTest.php
@@ -11,9 +11,11 @@
 class TooWideFunctionReturnTypehintRuleTest extends RuleTestCase
 {
 
+	private bool $reportTooWideBool = false;
+
 	protected function getRule(): Rule
 	{
-		return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck());
+		return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(), $this->reportTooWideBool);
 	}
 
 	public function testRule(): void
@@ -63,6 +65,7 @@ public function testBug11980(): void
 
 	public function testBug13384c(): void
 	{
+		$this->reportTooWideBool = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Function Bug13384c\doFoo() never returns true so it can be removed from the return type.',
@@ -75,4 +78,9 @@ public function testBug13384c(): void
 		]);
 	}
 
+	public function testBug13384cOff(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-13384c.php'], []);
+	}
+
 }
diff --git a/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodReturnTypehintRuleTest.php b/tests/PHPStan/Rules/TooWideTypehints/TooWideMethodReturnTypehintRuleTest.php
@@ -15,9 +15,11 @@ class TooWideMethodReturnTypehintRuleTest extends RuleTestCase
 
 	private bool $checkProtectedAndPublicMethods = true;
 
+	private bool $reportTooWideBool = false;
+
 	protected function getRule(): Rule
 	{
-		return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck());
+		return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(), $this->reportTooWideBool);
 	}
 
 	public function testPrivate(): void
@@ -201,6 +203,7 @@ public function testBug11980(): void
 
 	public function testBug13384c(): void
 	{
+		$this->reportTooWideBool = true;
 		$this->analyse([__DIR__ . '/data/bug-13384c.php'], [
 			[
 				'Method Bug13384c\Bug13384c::doBar() never returns true so it can be removed from the return type.',
@@ -221,4 +224,9 @@ public function testBug13384c(): void
 		]);
 	}
 
+	public function testBug13384cOff(): void
+	{
+		$this->analyse([__DIR__ . '/data/bug-13384c.php'], []);
+	}
+
 }

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`use PhpParser\Node;`
`6`	`6`	`use PHPStan\Analyser\Scope;`
	`7`	`+use PHPStan\DependencyInjection\AutowiredParameter;`
`7`	`8`	`use PHPStan\DependencyInjection\RegisteredRule;`
`8`	`9`	`use PHPStan\Node\FunctionReturnStatementsNode;`
`9`	`10`	`use PHPStan\Rules\Rule;`
`@@ -18,6 +19,8 @@ final class TooWideFunctionReturnTypehintRule implements Rule`
`18`	`19`
`19`	`20`	`public function __construct(`
`20`	`21`	`private TooWideTypeCheck $check,`
	`22`	`+ #[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]`
	`23`	`+ private bool $reportTooWideBool,`
`21`	`24`	`)`
`22`	`25`	`{`
`23`	`26`	`}`
`@@ -40,6 +43,7 @@ public function processNode(Node $node, Scope $scope): array`
`40`	`43`	`$function->getName(),`
`41`	`44`	`),`
`42`	`45`	`false,`
	`46`	`+ $this->reportTooWideBool,`
`43`	`47`	`);`
`44`	`48`	`}`
`45`	`49`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,8 @@ public function __construct(`
`21`	`21`	`#[AutowiredParameter(ref: '%checkTooWideReturnTypesInProtectedAndPublicMethods%')]`
`22`	`22`	`private bool $checkProtectedAndPublicMethods,`
`23`	`23`	`private TooWideTypeCheck $check,`
	`24`	`+ #[AutowiredParameter(ref: '%featureToggles.reportTooWideBool%')]`
	`25`	`+ private bool $reportTooWideBool,`
`24`	`26`	`)`
`25`	`27`	`{`
`26`	`28`	`}`
`@@ -59,6 +61,7 @@ public function processNode(Node $node, Scope $scope): array`
`59`	`61`	`$method->getName(),`
`60`	`62`	`),`
`61`	`63`	`!$isFirstDeclaration && !$method->isPrivate(),`
	`64`	`+ $this->reportTooWideBool,`
`62`	`65`	`);`
`63`	`66`	`}`
`64`	`67`
Original file line number	Diff line number	Diff line change
`@@ -11,9 +11,11 @@`
`11`	`11`	`class TooWideFunctionReturnTypehintRuleTest extends RuleTestCase`
`12`	`12`	`{`
`13`	`13`
	`14`	`+ private bool $reportTooWideBool = false;`
	`15`	`+`
`14`	`16`	`protected function getRule(): Rule`
`15`	`17`	`{`
`16`		`- return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck());`
	`18`	`+ return new TooWideFunctionReturnTypehintRule(new TooWideTypeCheck(), $this->reportTooWideBool);`
`17`	`19`	`}`
`18`	`20`
`19`	`21`	`public function testRule(): void`
`@@ -63,6 +65,7 @@ public function testBug11980(): void`
`63`	`65`
`64`	`66`	`public function testBug13384c(): void`
`65`	`67`	`{`
	`68`	`+ $this->reportTooWideBool = true;`
`66`	`69`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`67`	`70`	`[`
`68`	`71`	`'Function Bug13384c\doFoo() never returns true so it can be removed from the return type.',`
`@@ -75,4 +78,9 @@ public function testBug13384c(): void`
`75`	`78`	`]);`
`76`	`79`	`}`
`77`	`80`
	`81`	`+ public function testBug13384cOff(): void`
	`82`	`+ {`
	`83`	`+ $this->analyse([__DIR__ . '/data/bug-13384c.php'], []);`
	`84`	`+ }`
	`85`	`+`
`78`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,9 +15,11 @@ class TooWideMethodReturnTypehintRuleTest extends RuleTestCase`
`15`	`15`
`16`	`16`	`private bool $checkProtectedAndPublicMethods = true;`
`17`	`17`
	`18`	`+ private bool $reportTooWideBool = false;`
	`19`	`+`
`18`	`20`	`protected function getRule(): Rule`
`19`	`21`	`{`
`20`		`- return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck());`
	`22`	`+ return new TooWideMethodReturnTypehintRule($this->checkProtectedAndPublicMethods, new TooWideTypeCheck(), $this->reportTooWideBool);`
`21`	`23`	`}`
`22`	`24`
`23`	`25`	`public function testPrivate(): void`
`@@ -201,6 +203,7 @@ public function testBug11980(): void`
`201`	`203`
`202`	`204`	`public function testBug13384c(): void`
`203`	`205`	`{`
	`206`	`+ $this->reportTooWideBool = true;`
`204`	`207`	`$this->analyse([__DIR__ . '/data/bug-13384c.php'], [`
`205`	`208`	`[`
`206`	`209`	`'Method Bug13384c\Bug13384c::doBar() never returns true so it can be removed from the return type.',`
`@@ -221,4 +224,9 @@ public function testBug13384c(): void`
`221`	`224`	`]);`
`222`	`225`	`}`
`223`	`226`
	`227`	`+ public function testBug13384cOff(): void`
	`228`	`+ {`
	`229`	`+ $this->analyse([__DIR__ . '/data/bug-13384c.php'], []);`
	`230`	`+ }`
	`231`	`+`
`224`	`232`	`}`