Don't show inline hint for arguments with same names as the parameter…

…s in DU (#15305)
dotnet · Jun 5, 2023 · aab21e5 · aab21e5
1 parent 7fd0aa5
commit aab21e5
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 5 deletions.
diff --git a/vsintegration/src/FSharp.Editor/Hints/HintService.fs b/vsintegration/src/FSharp.Editor/Hints/HintService.fs
@@ -30,7 +30,7 @@ module HintService =
                 |> Seq.collect (InlineParameterNameHints(parseResults).GetHintsForMemberOrFunctionOrValue sourceText symbol)
             | HintKind.ParameterNameHint, (:? FSharpUnionCase as symbol) ->
                 symbolUses
-                |> Seq.collect (InlineParameterNameHints(parseResults).GetHintsForUnionCase symbol)
+                |> Seq.collect (InlineParameterNameHints(parseResults).GetHintsForUnionCase sourceText symbol)
             | _ -> []
 
         hintKinds |> Set.toList |> List.map getHintsPerKind

diff --git a/vsintegration/src/FSharp.Editor/Hints/InlineParameterNameHints.fs b/vsintegration/src/FSharp.Editor/Hints/InlineParameterNameHints.fs
@@ -147,21 +147,25 @@ type InlineParameterNameHints(parseResults: FSharpParseFileResults) =
         else
             []
 
-    member _.GetHintsForUnionCase (symbol: FSharpUnionCase) (symbolUse: FSharpSymbolUse) =
+    member _.GetHintsForUnionCase (sourceText: SourceText) (symbol: FSharpUnionCase) (symbolUse: FSharpSymbolUse) =
         if isUnionCaseValidForHint symbol symbolUse then
 
             let fields = Seq.toList symbol.Fields
 
             let ranges =
                 parseResults.GetAllArgumentsForFunctionApplicationAtPosition symbolUse.Range.Start
 
+            let argumentNames =
+                match ranges with
+                | Some ranges -> (List.map (getSourceTextAtRange sourceText)) ranges
+                | None -> []
             // When not all field values are provided (as the user is typing), don't show anything yet
             match ranges with
             | Some ranges when ranges.Length = fields.Length ->
                 fields
-                |> List.zip ranges
-                |> List.where (snd >> fieldNameExists)
-                |> List.map getFieldHint
+                |> List.zip3 argumentNames ranges
+                |> List.where (fun (argumentName, _, parameter) -> fieldNameExists parameter && argumentName <> parameter.DisplayName)
+                |> List.map (fun (_, range, parameter) -> getFieldHint (range, parameter))
 
             | _ -> []
         else

diff --git a/vsintegration/tests/FSharp.Editor.Tests/Hints/InlineParameterNameHintTests.fs b/vsintegration/tests/FSharp.Editor.Tests/Hints/InlineParameterNameHintTests.fs
@@ -347,6 +347,39 @@ let b = Rectangle (1, 2)
 
         Assert.Equal(expected, actual)
 
+    [<Fact>]
+    let ``Hints are not shown for discriminated union case fields with the same names as arguements`` () =
+        let code =
+            """
+type Shape =
+    | Square of side: int
+    | Rectangle of width: int * height: int
+ 
+let width = 5
+let a = Square 1
+let b = Rectangle (width, 2)
+"""
+
+        let document = getFsDocument code
+
+        let expected =
+            [
+                {
+                    Content = "side = "
+                    Location = (6, 16)
+                    Tooltip = "field side"
+                }
+                {
+                    Content = "height = "
+                    Location = (7, 27)
+                    Tooltip = "field height"
+                }
+            ]
+
+        let actual = getParameterNameHints document
+
+        Assert.Equal(expected, actual)
+
     [<Fact>]
     let ``Hints for discriminated union case fields are not shown when names are generated`` () =
         let code =