boost on exact by default

Author: shmax

example/typedoc.json

@@ -6,7 +6,6 @@
     "search": {
         "numResults": 12,
         "boosts": {
-            "exactMatch": 2,
             "byKind": {
                 "class": 1.2
             },

src/lib/output/themes/default/assets/typedoc/components/Search.ts

@@ -168,50 +168,47 @@ function updateResults(
     // when the `searchText` is empty.
     let res = searchText ? state.index.search(`*${searchText}*`) : [];
 
-    if (searchConfig.boosts != undefined) {
-        for (let i = 0; i < res.length; i++) {
-            const item = res[i];
-            const row = state.data.rows[Number(item.ref)];
-            let boost = 1;
-
-            // boost by exact match on name
-            if (
-                searchConfig.boosts.exactMatch &&
-                row.name.toLowerCase() === searchText.toLowerCase()
-            ) {
-                boost *= searchConfig.boosts.exactMatch;
-            }
+    for (let i = 0; i < res.length; i++) {
+        const item = res[i];
+        const row = state.data.rows[Number(item.ref)];
+        let boost = 1;
+
+        // boost by exact match on name
+        if(row.name
+            .toLowerCase()
+            .startsWith(searchText.toLowerCase())) {
+            boost *= (1 / Math.abs(row.name.length - searchText.length) * 10)
+        }
 
-            // boost by kind
-            for (let kindName in searchConfig.boosts.byKind ?? {}) {
-                const kind: ReflectionKind = parseInt(
-                    Object.keys(ReflectionKind).find(
-                        (key: string) =>
-                            ReflectionKind[key as keyof typeof ReflectionKind]
-                                .toString()
-                                .toLowerCase() === kindName.toLowerCase()
-                    ) ?? "",
-                    10
-                );
-                if (row.kind == kind) {
-                    boost *= searchConfig?.boosts?.byKind?.[kindName] ?? 1;
-                }
+        // boost by kind
+        for (let kindName in searchConfig.boosts?.byKind ?? {}) {
+            const kind: ReflectionKind = parseInt(
+                Object.keys(ReflectionKind).find(
+                    (key: string) =>
+                        ReflectionKind[key as keyof typeof ReflectionKind]
+                            .toString()
+                            .toLowerCase() === kindName.toLowerCase()
+                ) ?? "",
+                10
+            );
+            if (row.kind == kind) {
+                boost *= searchConfig?.boosts?.byKind?.[kindName] ?? 1;
             }
+        }
 
-            // boost by category
-            for (let categoryTitle in searchConfig.boosts?.byCategory ?? []) {
-                if (row.categories.indexOf(categoryTitle) > -1) {
-                    boost *=
-                        searchConfig.boosts.byCategory?.[categoryTitle] ?? 1;
-                }
+        // boost by category
+        for (let categoryTitle in searchConfig.boosts?.byCategory ?? []) {
+            if (row.categories.indexOf(categoryTitle) > -1) {
+                boost *=
+                    searchConfig.boosts?.byCategory?.[categoryTitle] ?? 1;
             }
-
-            item.score *= boost;
         }
 
-        res.sort((a, b) => b.score - a.score);
+        item.score *= boost;
     }
 
+    res.sort((a, b) => b.score - a.score);
+
     for (
         let i = 0, c = Math.min(searchConfig.numResults ?? 10, res.length);
         i < c;

src/lib/utils/options/declaration.ts

@@ -54,7 +54,6 @@ const Kinds = Object.values(ReflectionKind);
 export interface SearchConfig {
     numResults?: number;
     boosts?: {
-        exactMatch?: number;
         byKind?: { [key: typeof Kinds[number]]: number };
         byCategory?: { [key: string]: number };
     };