Check if treatPhpDocTypesAsCertain tip is enabled

See phpstan/phpstan-src#3452
phpstan · Sep 20, 2024 · daeec74 · daeec74
1 parent 876574c
commit daeec74
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 7 deletions.
diff --git a/rules.neon b/rules.neon
@@ -170,6 +170,7 @@ services:
 		class: PHPStan\Rules\Cast\UselessCastRule
 		arguments:
 			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
+			treatPhpDocTypesAsCertainTip: %tips.treatPhpDocTypesAsCertain%
 
 	-
 		class: PHPStan\Rules\Classes\RequireParentConstructCallRule
@@ -197,6 +198,7 @@ services:
 		arguments:
 			treatPhpDocTypesAsCertain: %treatPhpDocTypesAsCertain%
 			checkNullables: %checkNullables%
+			treatPhpDocTypesAsCertainTip: %tips.treatPhpDocTypesAsCertain%
 
 	-
 		class: PHPStan\Rules\Functions\ClosureUsesThisRule

diff --git a/src/Rules/Cast/UselessCastRule.php b/src/Rules/Cast/UselessCastRule.php
@@ -21,9 +21,16 @@ class UselessCastRule implements Rule
 	/** @var bool */
 	private $treatPhpDocTypesAsCertain;
 
-	public function __construct(bool $treatPhpDocTypesAsCertain)
+	/** @var bool */
+	private $treatPhpDocTypesAsCertainTip;
+
+	public function __construct(
+		bool $treatPhpDocTypesAsCertain,
+		bool $treatPhpDocTypesAsCertainTip
+	)
 	{
 		$this->treatPhpDocTypesAsCertain = $treatPhpDocTypesAsCertain;
+		$this->treatPhpDocTypesAsCertainTip = $treatPhpDocTypesAsCertainTip;
 	}
 
 	public function getNodeType(): string
@@ -55,7 +62,11 @@ public function processNode(Node $node, Scope $scope): array
 					return $ruleErrorBuilder;
 				}
 
-				return $ruleErrorBuilder->tip('Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.');
+				if (!$this->treatPhpDocTypesAsCertainTip) {
+					return $ruleErrorBuilder;
+				}
+
+				return $ruleErrorBuilder->treatPhpDocTypesAsCertainTip();
 			};
 			return [
 				$addTip(RuleErrorBuilder::message(sprintf(

diff --git a/src/Rules/Functions/ArrayFilterStrictRule.php b/src/Rules/Functions/ArrayFilterStrictRule.php
@@ -32,15 +32,20 @@ class ArrayFilterStrictRule implements Rule
 	/** @var bool */
 	private $checkNullables;
 
+	/** @var bool */
+	private $treatPhpDocTypesAsCertainTip;
+
 	public function __construct(
 		ReflectionProvider $reflectionProvider,
 		bool $treatPhpDocTypesAsCertain,
-		bool $checkNullables
+		bool $checkNullables,
+		bool $treatPhpDocTypesAsCertainTip
 	)
 	{
 		$this->reflectionProvider = $reflectionProvider;
 		$this->treatPhpDocTypesAsCertain = $treatPhpDocTypesAsCertain;
 		$this->checkNullables = $checkNullables;
+		$this->treatPhpDocTypesAsCertainTip = $treatPhpDocTypesAsCertainTip;
 	}
 
 	public function getNodeType(): string
@@ -135,8 +140,8 @@ public function processNode(Node $node, Scope $scope): array
 				$callbackType->describe(VerbosityLevel::typeOnly())
 			))->identifier('arrayFilter.strict');
 
-			if (!$this->isCallbackTypeNull($nativeCallbackType) && $this->treatPhpDocTypesAsCertain) {
-				$errorBuilder->tip('Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.');
+			if ($this->treatPhpDocTypesAsCertainTip && !$this->isCallbackTypeNull($nativeCallbackType) && $this->treatPhpDocTypesAsCertain) {
+				$errorBuilder->treatPhpDocTypesAsCertainTip();
 			}
 
 			return [$errorBuilder->build()];

diff --git a/tests/Rules/Cast/UselessCastRuleTest.php b/tests/Rules/Cast/UselessCastRuleTest.php
@@ -16,7 +16,10 @@ class UselessCastRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new UselessCastRule($this->treatPhpDocTypesAsCertain);
+		return new UselessCastRule(
+			$this->treatPhpDocTypesAsCertain,
+			true
+		);
 	}
 
 	protected function shouldTreatPhpDocTypesAsCertain(): bool

diff --git a/tests/Rules/Functions/ArrayFilterStrictRuleTest.php b/tests/Rules/Functions/ArrayFilterStrictRuleTest.php
@@ -19,7 +19,12 @@ class ArrayFilterStrictRuleTest extends RuleTestCase
 
 	protected function getRule(): Rule
 	{
-		return new ArrayFilterStrictRule($this->createReflectionProvider(), $this->treatPhpDocTypesAsCertain, $this->checkNullables);
+		return new ArrayFilterStrictRule(
+			$this->createReflectionProvider(),
+			$this->treatPhpDocTypesAsCertain,
+			$this->checkNullables,
+			true
+		);
 	}
 
 	protected function shouldTreatPhpDocTypesAsCertain(): bool