ArrayValuesRule - tip message about treatPhpDocTypesAsCertain

Author: ondrejmirtes

src/Rules/Functions/ArrayValuesRule.php

@@ -70,31 +70,45 @@ public function processNode(Node $node, Scope $scope): array
 			return [];
 		}
 
-		if ($this->treatPhpDocTypesAsCertain === true) {
+		if ($this->treatPhpDocTypesAsCertain) {
 			$arrayType = $scope->getType($args[0]->value);
 		} else {
 			$arrayType = $scope->getNativeType($args[0]->value);
 		}
 
 		if ($arrayType->isIterableAtLeastOnce()->no()) {
 			$message = 'Parameter #1 $array (%s) to function array_values is empty, call has no effect.';
+			$errorBuilder = RuleErrorBuilder::message(sprintf(
+				$message,
+				$arrayType->describe(VerbosityLevel::value()),
+			));
+			if ($this->treatPhpDocTypesAsCertain) {
+				$nativeArrayType = $scope->getNativeType($args[0]->value);
+				if (!$nativeArrayType->isIterableAtLeastOnce()->no()) {
+					$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%</>.');
+				}
+			}
 
 			return [
-				RuleErrorBuilder::message(sprintf(
-					$message,
-					$arrayType->describe(VerbosityLevel::value()),
-				))->build(),
+				$errorBuilder->build(),
 			];
 		}
 
 		if ($arrayType->isList()->yes()) {
 			$message = 'Parameter #1 $array (%s) of array_values is already a list, call has no effect.';
+			$errorBuilder = RuleErrorBuilder::message(sprintf(
+				$message,
+				$arrayType->describe(VerbosityLevel::value()),
+			));
+			if ($this->treatPhpDocTypesAsCertain) {
+				$nativeArrayType = $scope->getNativeType($args[0]->value);
+				if (!$nativeArrayType->isList()->yes()) {
+					$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%</>.');
+				}
+			}
 
 			return [
-				RuleErrorBuilder::message(sprintf(
-					$message,
-					$arrayType->describe(VerbosityLevel::value()),
-				))->build(),
+				$errorBuilder->build(),
 			];
 		}
 

tests/PHPStan/Rules/Functions/ArrayValuesRuleTest.php

@@ -21,6 +21,7 @@ protected function getRule(): Rule
 
 	public function testFile(): void
 	{
+		$tipText = '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%</>.';
 		$expectedErrors = [
 			[
 				'Parameter #1 $array (array{0, 1, 3}) of array_values is already a list, call has no effect.',
@@ -41,6 +42,7 @@ public function testFile(): void
 			[
 				'Parameter #1 $array (list<int>) of array_values is already a list, call has no effect.',
 				14,
+				$tipText,
 			],
 			[
 				'Parameter #1 $array (array{0}) of array_values is already a list, call has no effect.',
@@ -58,12 +60,18 @@ public function testFile(): void
 				'Parameter #1 $array (array{}) to function array_values is empty, call has no effect.',
 				21,
 			],
+			[
+				'Parameter #1 $array (array{}) to function array_values is empty, call has no effect.',
+				25,
+				$tipText,
+			],
 		];
 
 		if (PHP_VERSION_ID >= 80000) {
 			$expectedErrors[] = [
 				'Parameter #1 $array (list<int>) of array_values is already a list, call has no effect.',
-				24,
+				28,
+				$tipText,
 			];
 		}
 

tests/PHPStan/Rules/Functions/data/array_values_list.php

@@ -20,5 +20,9 @@
 array_values([null, 0]);
 array_values([]);
 
+/** @var array{} $empty */
+$empty = doFoo();
+array_values($empty);
+
 array_values(unused: true, array: $array);
 array_values(unused: true, array: $list);