Change to ExternalAutocomplete functions (ionide#1178)

Co-authored-by: Chet Husk <[email protected]>
nojaf · Nov 3, 2023 · 00037fa · 00037fa
1 parent f7467c5
commit 00037fa
Show file tree

Hide file tree

Showing 10 changed files with 347 additions and 156 deletions.
diff --git a/src/FsAutoComplete.Core/KeywordList.fs b/src/FsAutoComplete.Core/KeywordList.fs
@@ -42,13 +42,16 @@ module KeywordList =
   let hashSymbolCompletionItems =
     hashDirectives
     |> Seq.map (fun kv ->
+      let label = "#" + kv.Key
+
       { CompletionItem.Create(kv.Key) with
+          Data = Some(Newtonsoft.Json.Linq.JValue(label))
           Kind = Some CompletionItemKind.Keyword
           InsertText = Some kv.Key
           FilterText = Some kv.Key
           SortText = Some kv.Key
           Documentation = Some(Documentation.String kv.Value)
-          Label = "#" + kv.Key })
+          Label = label })
     |> Seq.toArray
 
   let allKeywords: string list =
@@ -58,6 +61,7 @@ module KeywordList =
     allKeywords
     |> List.mapi (fun id k ->
       { CompletionItem.Create(k) with
+          Data = Some(Newtonsoft.Json.Linq.JValue(k))
           Kind = Some CompletionItemKind.Keyword
           InsertText = Some k
           SortText = Some(sprintf "1000000%d" id)

diff --git a/src/FsAutoComplete/LspHelpers.fs b/src/FsAutoComplete/LspHelpers.fs
@@ -636,6 +636,7 @@ type FSharpConfigDto =
     ExcludeProjectDirectories: string[] option
     KeywordsAutocomplete: bool option
     ExternalAutocomplete: bool option
+    FullNameExternalAutocomplete: bool option
     Linter: bool option
     LinterConfig: string option
     IndentationSize: int option
@@ -771,6 +772,7 @@ type FSharpConfig =
     ExcludeProjectDirectories: string[]
     KeywordsAutocomplete: bool
     ExternalAutocomplete: bool
+    FullNameExternalAutocomplete: bool
     Linter: bool
     LinterConfig: string option
     IndentationSize: int
@@ -816,6 +818,7 @@ type FSharpConfig =
       ExcludeProjectDirectories = [||]
       KeywordsAutocomplete = false
       ExternalAutocomplete = false
+      FullNameExternalAutocomplete = false
       IndentationSize = 4
       Linter = false
       LinterConfig = None
@@ -861,6 +864,7 @@ type FSharpConfig =
       ExcludeProjectDirectories = defaultArg dto.ExcludeProjectDirectories [||]
       KeywordsAutocomplete = defaultArg dto.KeywordsAutocomplete false
       ExternalAutocomplete = defaultArg dto.ExternalAutocomplete false
+      FullNameExternalAutocomplete = defaultArg dto.ExternalAutocomplete false
       IndentationSize = defaultArg dto.IndentationSize 4
       Linter = defaultArg dto.Linter false
       LinterConfig = dto.LinterConfig
@@ -958,6 +962,7 @@ type FSharpConfig =
       ExcludeProjectDirectories = defaultArg dto.ExcludeProjectDirectories x.ExcludeProjectDirectories
       KeywordsAutocomplete = defaultArg dto.KeywordsAutocomplete x.KeywordsAutocomplete
       ExternalAutocomplete = defaultArg dto.ExternalAutocomplete x.ExternalAutocomplete
+      FullNameExternalAutocomplete = defaultArg dto.FullNameExternalAutocomplete x.FullNameExternalAutocomplete
       IndentationSize = defaultArg dto.IndentationSize x.IndentationSize
       Linter = defaultArg dto.Linter x.Linter
       LinterConfig = dto.LinterConfig

diff --git a/src/FsAutoComplete/LspHelpers.fsi b/src/FsAutoComplete/LspHelpers.fsi
@@ -269,6 +269,7 @@ type FSharpConfigDto =
     ExcludeProjectDirectories: string[] option
     KeywordsAutocomplete: bool option
     ExternalAutocomplete: bool option
+    FullNameExternalAutocomplete: bool option
     Linter: bool option
     LinterConfig: string option
     IndentationSize: int option
@@ -363,6 +364,7 @@ type FSharpConfig =
     ExcludeProjectDirectories: string[]
     KeywordsAutocomplete: bool
     ExternalAutocomplete: bool
+    FullNameExternalAutocomplete: bool
     Linter: bool
     LinterConfig: string option
     IndentationSize: int

diff --git a/src/FsAutoComplete/LspServers/AdaptiveFSharpLspServer.fs b/src/FsAutoComplete/LspServers/AdaptiveFSharpLspServer.fs
@@ -2575,6 +2575,33 @@ type AdaptiveFSharpLspServer
                   getCompletions forceGetOpenFileTypeCheckResults
                 | _ -> getCompletions forceGetOpenFileTypeCheckResultsStale
 
+              let getCodeToInsert (d: DeclarationListItem) =
+                match d.NamespaceToOpen with
+                | Some no when config.FullNameExternalAutocomplete -> sprintf "%s.%s" no d.NameInCode
+                | _ -> d.NameInCode
+
+              let createCompletionItem (config: FSharpConfig) (id: int) (d: DeclarationListItem) =
+                let code = getCodeToInsert d
+
+                /// The `label` for completion "System.Math.Ceiling" will be displayed as "Ceiling (System.Math)". This is to bias the viewer towards the member name,
+                /// with the namespace being less-important. The `filterText` is the text that will be used to filter the list of completions as the user types.
+                /// Prepending the member name to the filter text makes it so that the text the user is mot likely typing catches more relevant members at the head of the list.
+                /// e.f. "CeilingSystem.Math.Ceiling" means that the user typing `ceiling` will catch all of the members named ceiling that are in the available namespaces
+                let label, filterText =
+                  match d.NamespaceToOpen with
+                  | Some no when config.FullNameExternalAutocomplete ->
+                    sprintf "%s (%s)" d.NameInList no, d.NameInList + code
+                  | Some no -> sprintf "%s (open %s)" d.NameInList no, d.NameInList
+                  | None -> d.NameInList, d.NameInList
+
+                { CompletionItem.Create(d.NameInList) with
+                    Data = Some(JValue(d.FullName))
+                    Kind = (AVal.force glyphToCompletionKind) d.Glyph
+                    InsertText = Some code
+                    SortText = Some(sprintf "%06d" id)
+                    FilterText = Some filterText
+                    Label = label }
+
               match!
                 retryAsyncOption
                   (TimeSpan.FromMilliseconds(15.))
@@ -2592,37 +2619,14 @@ type AdaptiveFSharpLspServer
                     transact (fun () ->
                       HashMap.OfList(
                         [ for d in decls do
-                            d.NameInList, (d, pos, filePath, volatileFile.Source.GetLine, typeCheckResults.GetAST) ]
+                            d.FullName, (d, pos, filePath, volatileFile.Source.GetLine, typeCheckResults.GetAST) ]
                       )
                       |> autoCompleteItems.UpdateTo)
                     |> ignore<bool>
 
                     let includeKeywords = config.KeywordsAutocomplete && shouldKeywords
 
-                    let items =
-                      decls
-                      |> Array.mapi (fun id d ->
-                        let code =
-                          if
-                            System.Text.RegularExpressions.Regex.IsMatch(d.NameInList, """^[a-zA-Z][a-zA-Z0-9']+$""")
-                          then
-                            d.NameInList
-                          elif d.NamespaceToOpen.IsSome then
-                            d.NameInList
-                          else
-                            FSharpKeywords.NormalizeIdentifierBackticks d.NameInList
-
-                        let label =
-                          match d.NamespaceToOpen with
-                          | Some no -> sprintf "%s (open %s)" d.NameInList no
-                          | None -> d.NameInList
-
-                        { CompletionItem.Create(d.NameInList) with
-                            Kind = (AVal.force glyphToCompletionKind) d.Glyph
-                            InsertText = Some code
-                            SortText = Some(sprintf "%06d" id)
-                            FilterText = Some d.NameInList
-                            Label = label })
+                    let items = decls |> Array.mapi (createCompletionItem config)
 
                     let its =
                       if not includeKeywords then
@@ -2650,6 +2654,8 @@ type AdaptiveFSharpLspServer
       }
 
     override __.CompletionItemResolve(ci: CompletionItem) =
+      let config = AVal.force config
+
       let mapHelpText (ci: CompletionItem) (text: HelpText) =
         match text with
         | HelpText.Simple(symbolName, text) ->
@@ -2708,8 +2714,8 @@ type AdaptiveFSharpLspServer
 
               let n =
                 match getAutoCompleteNamespacesByDeclName sym |> AVal.force with
-                | None -> None
-                | Some s -> Some s
+                | Some s when not config.FullNameExternalAutocomplete -> Some s
+                | _ -> None
 
               CoreResponse.Res(HelpText.Full(sym, tip, n))
 
@@ -2725,10 +2731,10 @@ type AdaptiveFSharpLspServer
           )
 
           return!
-            match ci.InsertText with
-            | None -> LspResult.internalError "No InsertText"
-            | Some insertText ->
-              helpText insertText
+            match ci.Data with
+            | None -> LspResult.internalError "No FullName"
+            | Some fullName ->
+              helpText (fullName.ToString())
               |> Result.ofCoreResponse
               |> Result.bimap
                 (function