rustdoc search: rank aliases lower than exact matches

Author: lolbinarycat

src/librustdoc/html/static/js/rustdoc.d.ts

@@ -129,7 +129,7 @@ declare namespace rustdoc {
 
     /**
      * A single parsed "atom" in a search query. For example,
-     * 
+     *
      *     std::fmt::Formatter, Write -> Result<()>
      *     ┏━━━━━━━━━━━━━━━━━━  ┌────    ┏━━━━━┅┅┅┅┄┄┄┄┄┄┄┄┄┄┄┄┄┄┐
      *     ┃                    │        ┗ QueryElement {        ┊
@@ -264,6 +264,7 @@ declare namespace rustdoc {
         displayTypeSignature: Promise<rustdoc.DisplayTypeSignature> | null,
         item: Row,
         dontValidate?: boolean,
+        alias?: string,
     }
 
     /**

src/librustdoc/html/static/js/search.js

@@ -4273,7 +4273,11 @@ class DocSearch {
             };
         }
 
-        // @ts-expect-error
+        /**
+         * Handle searching by doc aliases
+         *
+         * @type {function(rustdoc.ResultsTable, string, Object=, Object=): Promise<void>}
+         */
         const handleAliases = async(ret, query, filterCrates, currentCrate) => {
             const lowerQuery = query.toLowerCase();
             // We separate aliases and crate aliases because we want to have current crate
@@ -4328,6 +4332,16 @@ class DocSearch {
                 Promise.all(aliases.map(fetchDesc)),
             ]);
 
+            // if there are any existing results that match exactly, those go before aliases.
+            let exactMatches = 0;
+            while (
+                ret.others[exactMatches] !== undefined &&
+                ret.others[exactMatches].dist === 0 &&
+                ret.others[exactMatches].path_dist === 0
+            ) {
+                exactMatches += 1;
+            }
+
             // @ts-expect-error
             const pushFunc = alias => {
                 alias.alias = query;
@@ -4336,12 +4350,11 @@ class DocSearch {
                 alias.fullPath = alias.displayPath + alias.name;
                 alias.href = res[1];
 
-                ret.others.unshift(alias);
+                ret.others.splice(exactMatches, 0, alias);
                 if (ret.others.length > MAX_RESULTS) {
                     ret.others.pop();
                 }
             };
-
             aliases.forEach((alias, i) => {
                 // @ts-expect-error
                 alias.desc = descs[i];

tests/rustdoc-js/alias-sort.js

@@ -0,0 +1,10 @@
+// rank doc aliases lower than exact matches
+// regression test for <https://github.com/rust-lang/rust/issues/140968>
+
+const EXPECTED = {
+    'query': 'foobazbar',
+    'others': [
+        { 'name': 'foobazbar' },
+        { 'name': 'foo' },
+    ],
+};

tests/rustdoc-js/alias-sort.rs

@@ -0,0 +1,5 @@
+/// asdf
+pub fn foobazbar() {}
+
+#[doc(alias("foobazbar"))]
+pub fn foo() {}

tests/rustdoc-js/doc-alias.js

@@ -231,6 +231,13 @@ const EXPECTED = [
     {
         'query': 'UnionItem',
         'others': [
+            // normalization actually removes the underscores, so this counts as an exact match.
+            {
+                'path': 'doc_alias::Union',
+                'name': 'union_item',
+                'desc': 'Doc for <code>Union::union_item</code>',
+                'href': '../doc_alias/union.Union.html#structfield.union_item'
+            },
             {
                 'path': 'doc_alias',
                 'name': 'Union',
@@ -239,13 +246,6 @@ const EXPECTED = [
                 'href': '../doc_alias/union.Union.html',
                 'is_alias': true
             },
-            // Not an alias!
-            {
-                'path': 'doc_alias::Union',
-                'name': 'union_item',
-                'desc': 'Doc for <code>Union::union_item</code>',
-                'href': '../doc_alias/union.Union.html#structfield.union_item'
-            },
         ],
     },
     {

tests/rustdoc-js/non-english-identifier.js

@@ -1,3 +1,5 @@
+// ignore-order
+
 const PARSED = [
     {
         query: '中文',