Skip to content

Adjust suggested names for union case field patterns #15989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
T-Gro merged 3 commits into from
Sep 19, 2023
Merged

Adjust suggested names for union case field patterns #15989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5fae83
Adjust suggested names for union case field patterns
kerams Sep 17, 2023
83ce95a
Merge branch 'main' into sug
kerams Sep 18, 2023
eed5485
Refactor
kerams Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions src/Compiler/Service/FSharpCheckerResults.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,24 +986,32 @@ type internal TypeCheckInfo
None

/// Suggest name based on type
let SuggestNameBasedOnType g pos ty =
if isNumericType g ty then
CreateCompletionItemForSuggestedPatternName pos "num"
else
match tryTcrefOfAppTy g ty with
| ValueSome tcref when not (tyconRefEq g g.system_Object_tcref tcref) ->
CreateCompletionItemForSuggestedPatternName pos tcref.DisplayName
| _ -> None
let SuggestNameBasedOnType (g: TcGlobals) pos ty =
match stripTyparEqns ty with
| TType_app (tyconRef = tcref) when tcref.IsTypeAbbrev && (tcref.IsLocalRef || not (ccuEq g.fslibCcu tcref.nlr.Ccu)) ->
// Respect user-defined aliases
CreateCompletionItemForSuggestedPatternName pos tcref.DisplayName
| ty ->
if isNumericType g ty then
CreateCompletionItemForSuggestedPatternName pos "num"
else
match tryTcrefOfAppTy g ty with
| ValueSome tcref when not (tyconRefEq g g.system_Object_tcref tcref) ->
CreateCompletionItemForSuggestedPatternName pos tcref.DisplayName
| _ -> None

/// Suggest names based on field name and type, add them to the list
let SuggestNameForUnionCaseFieldPattern g caseIdPos fieldPatternPos (uci: UnionCaseInfo) indexOrName completions =
let SuggestNameForUnionCaseFieldPattern g caseIdPos fieldPatternPos (uci: UnionCaseInfo) indexOrName isTheOnlyField completions =
let field =
match indexOrName with
| Choice1Of2 index ->
// Index is None when parentheses were not used, i.e. "| Some v ->" - suggest a name only when the case has a single field
match uci.UnionCase.RecdFieldsArray, index with
| [| field |], None -> Some field
| [| _ |], Some _
| [| field |], None ->
// Index is None when parentheses were not used, i.e. `| Some v ->` - suggest a name only when the case has a single field
Some field
| [| _ |], Some _ when not isTheOnlyField ->
// When completing `| Some (a| , b)`, we're binding the first tuple element, not the sole case field
None
| _, None -> None
| arr, Some index -> arr |> Array.tryItem index
| Choice2Of2 name -> uci.UnionCase.RecdFieldsArray |> Array.tryFind (fun x -> x.DisplayName = name)
Expand All @@ -1016,7 +1024,7 @@ type internal TypeCheckInfo
sResolutions.CapturedNameResolutions
|> ResizeArray.tryPick (fun r ->
match r.Item with
| Item.Value vref when r.Pos = fieldPatternPos -> Some(stripTyparEqns vref.Type)
| Item.Value vref when r.Pos = fieldPatternPos -> Some vref.Type
| _ -> None)
|> Option.defaultValue field.FormalType
else
Expand Down Expand Up @@ -1118,7 +1126,7 @@ type internal TypeCheckInfo
|> Option.defaultValue []
|> List.append (fields indexOrName isTheOnlyField uci)

Some(SuggestNameForUnionCaseFieldPattern g caseIdRange.End pos uci indexOrName list, r.DisplayEnv, r.Range)
Some(SuggestNameForUnionCaseFieldPattern g caseIdRange.End pos uci indexOrName isTheOnlyField list, r.DisplayEnv, r.Range)
| _ -> None)
|> Option.orElse declaredItems

Expand Down
18 changes: 16 additions & 2 deletions vsintegration/tests/FSharp.Editor.Tests/CompletionProviderTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1710,6 +1710,16 @@ fun (Some v) -> ()

type C =
member _.M (Ids (c, o)) = ()


type MyAlias = int

type Id2<'a> = Id2 of fff: 'a

let r: Id2<MyAlias> = Id2 3

match r with
| Id2 (a) -> ()
"""

VerifyCompletionList(fileContents, "let x (Ids (c", [ "customerId"; "num" ], [])
Expand All @@ -1720,7 +1730,9 @@ type C =
VerifyCompletionList(fileContents, "fun (Ids (c, o", [ "orderId"; "option" ], [])
VerifyCompletionList(fileContents, "fun (Some v", [ "value" ], [])
VerifyCompletionList(fileContents, "member _.M (Ids (c", [ "customerId"; "num" ], [ "orderId" ])
VerifyCompletionList(fileContents, "member _.M (Ids (c, o", [ "orderId"; "option" ], [ "customerId"; "num" ])

// Respecting the type alias
VerifyCompletionList(fileContents, "| Id2 (a", [ "fff"; "myAlias" ], [ "num" ])

[<Fact>]
let ``Completion list does not contain suggested names in tuple deconstruction`` () =
Expand All @@ -1735,7 +1747,9 @@ match Some (1, 2) with
VerifyCompletionList(fileContents, "| Some v", [ "value" ], [])
VerifyCompletionList(fileContents, "| Some (a", [], [ "value" ])
VerifyCompletionList(fileContents, "| Some (a, b", [], [ "value" ])
VerifyCompletionList(fileContents, "| Some (c", [], [ "value" ])

// Binding the whole tuple here, so the field name should be present
VerifyCompletionList(fileContents, "| Some (c", [ "value" ], [])

[<Fact>]
let ``Completion list contains suggested names for union case field pattern based on the name of the generic type's solution`` () =
Expand Down