RuleErrorBuilder - support multiple tips nicely

ondrejmirtes · ondrejmirtes · commit e06c529ffc64 · 2023-04-03T16:49:33.000+02:00
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -623,6 +623,11 @@ parameters:
 			count: 1
 			path: src/Rules/PhpDoc/VarTagTypeRuleHelper.php
 
+		-
+			message: "#^Access to an undefined property PHPStan\\\\Rules\\\\RuleError\\:\\:\\$tip\\.$#"
+			count: 2
+			path: src/Rules/RuleErrorBuilder.php
+
 		-
 			message: "#^Doing instanceof PHPStan\\\\Type\\\\NullType is error\\-prone and deprecated\\. Use Type\\:\\:isNull\\(\\) instead\\.$#"
 			count: 2
diff --git a/src/Rules/RuleErrorBuilder.php b/src/Rules/RuleErrorBuilder.php
@@ -26,6 +26,9 @@ class RuleErrorBuilder
 	/** @var mixed[] */
 	private array $properties;
 
+	/** @var list<string> */
+	private array $tips = [];
+
 	private function __construct(string $message)
 	{
 		$this->properties['message'] = $message;
@@ -106,7 +109,15 @@ public function file(string $file): self
 
 	public function tip(string $tip): self
 	{
-		$this->properties['tip'] = $tip;
+		$this->tips = [$tip];
+		$this->type |= self::TYPE_TIP;
+
+		return $this;
+	}
+
+	public function addTip(string $tip): self
+	{
+		$this->tips[] = $tip;
 		$this->type |= self::TYPE_TIP;
 
 		return $this;
@@ -122,15 +133,11 @@ public function discoveringSymbolsTip(): self
 	 */
 	public function acceptsReasonsTip(array $reasons): self
 	{
-		if (count($reasons) === 0) {
-			return $this;
-		}
-
-		if (count($reasons) === 1) {
-			return $this->tip($reasons[0]);
+		foreach ($reasons as $reason) {
+			$this->addTip($reason);
 		}
 
-		return $this->tip(implode("\n", array_map(static fn (string $reason) => sprintf('• %s', $reason), $reasons)));
+		return $this;
 	}
 
 	public function identifier(string $identifier): self
@@ -172,6 +179,14 @@ public function build(): RuleError
 			$ruleError->{$propertyName} = $value;
 		}
 
+		if (count($this->tips) > 0) {
+			if (count($this->tips) === 1) {
+				$ruleError->tip = $this->tips[0];
+			} else {
+				$ruleError->tip = implode("\n", array_map(static fn (string $tip) => sprintf('• %s', $tip), $this->tips));
+			}
+		}
+
 		return $ruleError;
 	}
 
