Add support for Completion.sortText

FEATURE: Completions now support a `sortText` property to influence sort order.

See https://discuss.codemirror.net/t/lsp-client-request-support-for-sorttext-on-completionitem/9576

Author: marijnh

src/completion.ts

@@ -14,6 +14,9 @@ export interface Completion {
   /// provide a [`getMatch`](#autocomplete.CompletionResult.getMatch)
   /// function.
   displayLabel?: string
+  /// Overrides the text that is used to sort completions. Will
+  /// default to `label` if not given.
+  sortText?: string
   /// An optional short piece of information to show (with a different
   /// style) after the label.
   detail?: string

src/config.ts

@@ -110,7 +110,7 @@ export const completionConfig = Facet.define<CompletionConfig, Required<Completi
       addToOptions: [],
       positionInfo: defaultPositionInfo as any,
       filterStrict: false,
-      compareCompletions: (a, b) => a.label.localeCompare(b.label),
+      compareCompletions: (a, b) => (a.sortText || a.label).localeCompare(b.sortText || b.label),
       interactionDelay: 75,
       updateSyncTime: 100
     }, {

test/webtest-autocomplete.ts

@@ -148,6 +148,9 @@ describe("autocomplete", () => {
 
     run.options("sorts alphabetically when score is equal", "a", [from("ac ab acc")], "ab ac acc")
 
+    run.options("sorts by sortText when given", "a",
+                [cx => ({from: 0, to: 1, options: [{label: "ab"}, {label: "ac", sortText: "aa"}]})], "ac ab")
+
     run.options("removes duplicate options", "t", [from("two"), from("two three")], "three two")
 
     run.options("handles all-uppercase words", "sel", [from("SCOPE_CATALOG SELECT SELECTIVE")], "SELECT SELECTIVE SCOPE_CATALOG")