Contextual help about PHP-Parser 4.13.0

src/Rules/FoundTypeResult.php

@@ -16,6 +16,8 @@ class FoundTypeResult
 	/** @var RuleError[] */
 	private array $unknownClassErrors;
 
+	private ?string $tip;
+
 	/**
 	 * @param \PHPStan\Type\Type $type
 	 * @param string[] $referencedClasses
@@ -24,12 +26,14 @@ class FoundTypeResult
 	public function __construct(
 		Type $type,
 		array $referencedClasses,
-		array $unknownClassErrors
+		array $unknownClassErrors,
+		?string $tip
 	)
 	{
 		$this->type = $type;
 		$this->referencedClasses = $referencedClasses;
 		$this->unknownClassErrors = $unknownClassErrors;
+		$this->tip = $tip;
 	}
 
 	public function getType(): Type
@@ -53,4 +57,9 @@ public function getUnknownClassErrors(): array
 		return $this->unknownClassErrors;
 	}
 
+	public function getTip(): ?string
+	{
+		return $this->tip;
+	}
+
 }

src/Rules/Properties/AccessPropertiesRule.php

@@ -139,12 +139,17 @@ static function (Type $type) use ($name): bool {
 				}
 			}
 
+			$ruleErrorBuilder = RuleErrorBuilder::message(sprintf(
+				'Access to an undefined property %s::$%s.',
+				$type->describe(VerbosityLevel::typeOnly()),
+				$name
+			));
+			if ($typeResult->getTip() !== null) {
+				$ruleErrorBuilder->tip($typeResult->getTip());
+			}
+
 			return [
-				RuleErrorBuilder::message(sprintf(
-					'Access to an undefined property %s::$%s.',
-					$type->describe(VerbosityLevel::typeOnly()),
-					$name
-				))->build(),
+				$ruleErrorBuilder->build(),
 			];
 		}
 

src/Rules/RuleLevelHelper.php

@@ -20,6 +20,7 @@
 use PHPStan\Type\TypeTraverser;
 use PHPStan\Type\TypeUtils;
 use PHPStan\Type\UnionType;
+use PHPStan\Type\VerbosityLevel;
 
 class RuleLevelHelper
 {
@@ -135,7 +136,7 @@ public function findTypeToCheck(
 	): FoundTypeResult
 	{
 		if ($this->checkThisOnly && !$this->isThis($var)) {
-			return new FoundTypeResult(new ErrorType(), [], []);
+			return new FoundTypeResult(new ErrorType(), [], [], null);
 		}
 		$type = $scope->getType($var);
 		if (!$this->checkNullables && !$type instanceof NullType) {
@@ -148,11 +149,11 @@ public function findTypeToCheck(
 			&& !$type instanceof TemplateMixedType
 			&& $type->isExplicitMixed()
 		) {
-			return new FoundTypeResult(new StrictMixedType(), [], []);
+			return new FoundTypeResult(new StrictMixedType(), [], [], null);
 		}
 
 		if ($type instanceof MixedType || $type instanceof NeverType) {
-			return new FoundTypeResult(new ErrorType(), [], []);
+			return new FoundTypeResult(new ErrorType(), [], [], null);
 		}
 		if ($type instanceof StaticType) {
 			$type = $type->getStaticObjectType();
@@ -178,12 +179,12 @@ public function findTypeToCheck(
 		}
 
 		if (count($errors) > 0 || $hasClassExistsClass) {
-			return new FoundTypeResult(new ErrorType(), [], $errors);
+			return new FoundTypeResult(new ErrorType(), [], $errors, null);
 		}
 
 		if (!$this->checkUnionTypes) {
 			if ($type instanceof ObjectWithoutClassType) {
-				return new FoundTypeResult(new ErrorType(), [], []);
+				return new FoundTypeResult(new ErrorType(), [], [], null);
 			}
 			if ($type instanceof UnionType) {
 				$newTypes = [];
@@ -196,12 +197,17 @@ public function findTypeToCheck(
 				}
 
 				if (count($newTypes) > 0) {
-					return new FoundTypeResult(TypeCombinator::union(...$newTypes), $directClassNames, []);
+					return new FoundTypeResult(TypeCombinator::union(...$newTypes), $directClassNames, [], null);
 				}
 			}
 		}
 
-		return new FoundTypeResult($type, $directClassNames, []);
+		$tip = null;
+		if (strpos($type->describe(VerbosityLevel::typeOnly()), 'PhpParser\\Node\\Arg|PhpParser\\Node\\VariadicPlaceholder') !== false && !$unionTypeCriteriaCallback($type)) {
+			$tip = 'Use <fg=cyan>->getArgs()</> instead of <fg=cyan>->args</>.';
+		}
+
+		return new FoundTypeResult($type, $directClassNames, [], $tip);
 	}
 
 }