Skip PHPStan conditional return type in RemoveSuperfluousReturnNameFixer

blink/internal/fixer/rules/symplify_docblock2.go

@@ -104,6 +104,8 @@ type RemoveSuperfluousReturnName struct{}
 var (
 	returnVarNameRe   = regexp.MustCompile(`(@(?:psalm-|phpstan-)?return)(\s+[|\\\w]+)?(\s+)(\$[\w]+)`)
 	docVariableNameRe = regexp.MustCompile(`\$\w+`)
+	// PHPStan conditional return type, e.g. "@return $var ? TypeA : TypeB"
+	conditionalReturnRe = regexp.MustCompile(`@(?:psalm-|phpstan-)?return\s+\$\w+\s*(?:\?|is\b)`)
 )
 
 func (RemoveSuperfluousReturnName) Name() string {
@@ -125,6 +127,9 @@ func (RemoveSuperfluousReturnName) Fix(s *tokens.Stream) bool {
 			if m[4] == "$this" {
 				continue
 			}
+			if conditionalReturnRe.MatchString(line) {
+				continue
+			}
 			if len(docVariableNameRe.FindAllString(line, -1)) >= 2 {
 				continue
 			}

blink/internal/fixer/rules/symplify_docblock_test.go

@@ -88,6 +88,16 @@ func TestRemoveSuperfluousReturnName(t *testing.T) {
 		t.Fatalf("changed=%v got=%q want=%q", changed, got, want)
 	}
 	idempotent(t, RemoveSuperfluousReturnName{}, got)
+
+	// a PHPStan conditional return type is left alone; the variable is the condition, not a name
+	for _, cond := range []string{
+		"<?php\nclass A {\n    /**\n     * @return ($arrayHydration is true ? array<int, mixed> : array<int, LeadList>)\n     */\n    function f(bool $arrayHydration) {}\n}\n",
+		"<?php\nclass A {\n    /**\n     * @return $arrayHydration ? array<int, mixed> : array<int, LeadList>\n     */\n    function f(bool $arrayHydration) {}\n}\n",
+	} {
+		if got, changed := apply(t, RemoveSuperfluousReturnName{}, cond); changed || got != cond {
+			t.Fatalf("conditional return type changed=%v got=%q", changed, got)
+		}
+	}
 }
 
 // TestRemoveSuperfluousVarName drops the variable name from a property @var.

packages/coding-standard/src/Fixer/Commenting/RemoveSuperfluousReturnNameFixer.php

@@ -35,6 +35,9 @@ final class RemoveSuperfluousReturnNameFixer extends AbstractDocBlockFixer
 
     private const string VARIABLE_NAME_PART = 'variableName';
 
+    // PHPStan conditional return type, e.g. "@return $var ? TypeA : TypeB"
+    private const string CONDITIONAL_RETURN_REGEX = '#@(?:psalm-|phpstan-)?return\s+\$\w+\s*(?:\?|is\b)#';
+
     public function getDefinition(): FixerDefinitionInterface
     {
         return new FixerDefinition(self::ERROR_MESSAGE, []);
@@ -86,6 +89,10 @@ private function shouldSkip(array $match, string $content): bool
             return true;
         }
 
+        if (Regex::match($content, self::CONDITIONAL_RETURN_REGEX) !== null) {
+            return true;
+        }
+
         // has multiple return values? "@return array $one, $two"
         return count(Regex::matchAll($content, self::VARIABLE_NAME_REGEX)) >= 2;
     }

packages/coding-standard/tests/Fixer/Commenting/RemoveSuperfluousReturnNameFixer/Fixture/skip_conditional_return_type.php.inc

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * @return ($arrayHydration is true ? array<int, array<string, mixed>> : array<int, LeadList>)
+ */
+function getLists(bool $arrayHydration = false): array
+{
+}
+
+/**
+ * @phpstan-return ($isPublic is true ? string : int)
+ */
+function conditionalWithIs(bool $isPublic): string|int
+{
+}
+
+/**
+ * @return $arrayHydration ? array<int, mixed> : array<int, LeadList>
+ */
+function bareConditional(bool $arrayHydration = false): array
+{
+}
+
+?>
+-----
+<?php
+
+/**
+ * @return ($arrayHydration is true ? array<int, array<string, mixed>> : array<int, LeadList>)
+ */
+function getLists(bool $arrayHydration = false): array
+{
+}
+
+/**
+ * @phpstan-return ($isPublic is true ? string : int)
+ */
+function conditionalWithIs(bool $isPublic): string|int
+{
+}
+
+/**
+ * @return $arrayHydration ? array<int, mixed> : array<int, LeadList>
+ */
+function bareConditional(bool $arrayHydration = false): array
+{
+}
+
+?>