Merge pull request #1264 from matrix-org/luke/fix-rte-emoji-sorting

Adjust emoji sorting such that exact matches/prefixes appear first

src/autocomplete/EmojiProvider.js

@@ -71,6 +71,15 @@ const EMOJI_SHORTNAMES = Object.keys(EmojiData).map((key) => EmojiData[key]).sor
 
 let instance = null;
 
+function score(query, space) {
+    const index = space.indexOf(query);
+    if (index === -1) {
+        return Infinity;
+    } else {
+        return index;
+    }
+}
+
 export default class EmojiProvider extends AutocompleteProvider {
     constructor() {
         super(EMOJI_REGEX);
@@ -104,8 +113,20 @@ export default class EmojiProvider extends AutocompleteProvider {
 
             // Do second match with shouldMatchWordsOnly in order to match against 'name'
             completions = completions.concat(this.nameMatcher.match(matchedString));
-            // Reinstate original order
-            completions = _sortBy(_uniq(completions), '_orderBy');
+
+            const sorters = [];
+            // First, sort by score (Infinity if query not in shortname)
+            sorters.push((c) => score(query, c.shortname));
+            // If the query is not empty, sort by length of shortname. Example:
+            //  query = ":bookmark"
+            //  completions = [":bookmark:", ":bookmark_tabs:", ...]
+            if (query.length > 1) {
+                sorters.push((c) => c.shortname.length);
+            }
+            // Finally, sort by original ordering
+            sorters.push((c) => c._orderBy);
+            completions = _sortBy(_uniq(completions), sorters);
+
             completions = completions.map((result) => {
                 const {shortname} = result;
                 const unicode = shortnameToUnicode(shortname);