ensure typed completions end up on top by sorting them to come before regular completions

Author: zth

analysis/src/CompletionBackEnd.ml

@@ -2281,10 +2281,25 @@ Note: The `@react.component` decorator requires the react-jsx config to be set i
         match (prefix, completionContext) with
         | "", _ -> items
         | _, None ->
+          (* Completions for local things like variables in scope, modules in the project, etc. *)
           let regularCompletions =
             prefix
             |> getComplementaryCompletionsForTypedValue ~opens ~allFiles ~env
                  ~scope
           in
+          let items =
+            if List.length regularCompletions > 0 then
+              (* The client will occasionally sort the list of completions alphabetically, disregarding the order
+                 in which we send it. This fixes that by providing a sort text making the typed completions
+                 guaranteed to end up on top. *)
+              items
+              |> List.mapi (fun index (c : Completion.t) ->
+                     {
+                       c with
+                       sortText =
+                         Some ("AAA" ^ string_of_int (index + 1) ^ " " ^ c.name);
+                     })
+            else items
+          in
           items @ regularCompletions
         | _ -> items)))

analysis/tests/src/expected/CompletionExpressions.res.txt

@@ -233,6 +233,7 @@ Completable: Cexpression CArgument Value[fnTakingRecord]($0)=O->recordField(vari
     "tags": [],
     "detail": "One\n\ntype someVariant = One | Two | Three(int, string)",
     "documentation": null,
+    "sortText": "AAA1 One",
     "insertText": "One",
     "insertTextFormat": 2
   }, {

analysis/tests/src/expected/CompletionFunctionArguments.res.txt

@@ -25,7 +25,8 @@ Completable: Cexpression CArgument Value[someFn](~isOn)=t
     "kind": 4,
     "tags": [],
     "detail": "bool",
-    "documentation": null
+    "documentation": null,
+    "sortText": "AAA1 true"
   }, {
     "label": "tLocalVar",
     "kind": 12,
@@ -126,6 +127,7 @@ Completable: Cexpression CArgument Value[someFnTakingVariant](~config)=O
     "tags": [],
     "detail": "One\n\ntype someVariant = One | Two | Three(int, string)",
     "documentation": null,
+    "sortText": "AAA1 One",
     "insertText": "One",
     "insertTextFormat": 2
   }, {
@@ -158,6 +160,7 @@ Completable: Cexpression CArgument Value[someFnTakingVariant]($0)=So
     "tags": [],
     "detail": "someVariant",
     "documentation": null,
+    "sortText": "AAA1 Some(_)",
     "insertText": "Some(${1:_})",
     "insertTextFormat": 2
   }, {
@@ -178,6 +181,7 @@ Completable: Cexpression CArgument Value[someFnTakingVariant](~configOpt2)=O
     "tags": [],
     "detail": "One\n\ntype someVariant = One | Two | Three(int, string)",
     "documentation": null,
+    "sortText": "AAA1 One",
     "insertText": "One",
     "insertTextFormat": 2
   }, {
@@ -244,7 +248,8 @@ Completable: Cexpression CArgument Value[someOtherFn]($2)=t
     "kind": 4,
     "tags": [],
     "detail": "bool",
-    "documentation": null
+    "documentation": null,
+    "sortText": "AAA1 true"
   }, {
     "label": "tLocalVar",
     "kind": 12,

analysis/tests/src/expected/CompletionJsxProps.res.txt

@@ -38,6 +38,7 @@ Completable: Cexpression CJsxPropValue [CompletionSupport, TestComponent] test=T
     "tags": [],
     "detail": "Two\n\ntype testVariant = One | Two | Three(int)",
     "documentation": null,
+    "sortText": "AAA1 Two",
     "insertText": "Two",
     "insertTextFormat": 2
   }, {
@@ -46,6 +47,7 @@ Completable: Cexpression CJsxPropValue [CompletionSupport, TestComponent] test=T
     "tags": [],
     "detail": "Three(int)\n\ntype testVariant = One | Two | Three(int)",
     "documentation": null,
+    "sortText": "AAA2 Three(_)",
     "insertText": "Three(${1:_})",
     "insertTextFormat": 2
   }, {