Refactored search pipeline configuration

src/assets/javascripts/integrations/search/_/index.ts

@@ -52,13 +52,20 @@ export interface SearchIndexDocument {
   text: string                         /* Document text */
 }
 
+/* ------------------------------------------------------------------------- */
+
+/**
+ * Search index pipeline function
+ */
+export type SearchIndexPipelineFn =
+  | "stemmer"                          /* Stemmer */
+  | "stopWordFilter"                   /* Stop word filter */
+  | "trimmer"                          /* Trimmer */
+
 /**
  * Search index pipeline
  */
-export interface SearchIndexPipeline {
+export type SearchIndexPipeline = SearchIndexPipelineFn[]
-  trimmer: boolean                     /* Add trimmer to pipeline */
-  stopwords: boolean                   /* Add stopword filter to pipeline */
-}
 
 /* ------------------------------------------------------------------------- */
 
@@ -129,17 +136,12 @@ export class SearchIndex {
     /* If no index was given, create it */
     if (typeof index === "undefined") {
       this.index = lunr(function() {
-        pipeline = pipeline || {
+        pipeline = pipeline || ["trimmer", "stopWordFilter"]
-          trimmer: true,
-          stopwords: true
-        }
 
-        /* Remove stemmer, as it cripples search experience */
+        /* Set up pipeline according to configuration */
         this.pipeline.reset()
-        if (pipeline.trimmer)
+        for (const fn of pipeline)
-          this.pipeline.add(lunr.trimmer)
+          this.pipeline.add(lunr[fn])
-        if (pipeline.stopwords)
-          this.pipeline.add(lunr.stopWordFilter)
 
         /* Set up alternate search languages */
         if (config.lang.length === 1 && config.lang[0] !== "en") {

src/partials/language/ar.html

@@ -32,8 +32,7 @@
   "meta.comments": "التعليقات",
   "meta.source": "المصدر",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "بحث",
   "search.result.placeholder": "اكتب لبدء البحث",
   "search.result.none": "لا توجد نتائج",

src/partials/language/en.html

@@ -32,8 +32,7 @@
   "meta.comments": "Comments",
   "meta.source": "Source",
   "search.language": "en",
-  "search.pipeline.stopwords": true,
+  "search.pipeline": "trimmer, stopWordFilter",
-  "search.pipeline.trimmer": true,
   "search.placeholder": "Search",
   "search.result.placeholder": "Type to start searching",
   "search.result.none": "No matching documents",

src/partials/language/et.html

@@ -31,8 +31,7 @@
   "meta.comments": "Kommentaarid",
   "meta.source": "Lähtekood",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Otsi",
   "search.result.placeholder": "Otsimiseks kirjuta siia",
   "search.result.none": "Otsingule ei leitud ühtegi vastet",

src/partials/language/fa.html

@@ -32,8 +32,7 @@
   "meta.comments": "نظرات",
   "meta.source": "منبع",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "جستجو",
   "search.result.placeholder": "برای شروع جستجو تایپ کنید",
   "search.result.none": "سندی یافت نشد",

src/partials/language/gr.html

@@ -31,8 +31,7 @@
   "meta.comments": "Σχόλια",
   "meta.source": "Πηγή",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Αναζήτηση",
   "search.result.placeholder": "Πληκτρολογήστε για να αρχίσει η αναζήτηση",
   "search.result.none": "Δε βρέθηκαν αντίστοιχα αρχεία",

src/partials/language/he.html

@@ -32,8 +32,7 @@
   "meta.comments": "הערות",
   "meta.source": "מָקוֹר",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "לחפש",
   "search.result.placeholder": "הקלד כדי להתחיל לחפש",
   "search.result.none": "אין מסמכים תואמים",

src/partials/language/hi.html

@@ -31,8 +31,7 @@
   "meta.comments": "टिप्पणियाँ",
   "meta.source": "स्रोत",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "खोज",
   "search.result.placeholder": "खोज शुरू करने के लिए टाइप करें",
   "search.result.none": "कोई मिलान डॉक्यूमेंट नहीं",

src/partials/language/hr.html

@@ -31,8 +31,7 @@
   "meta.comments": "Komentari",
   "meta.source": "Izvor",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Pretraživanje",
   "search.result.placeholder": "Unesite pojam pretraživanja",
   "search.result.none": "Ništa nije pronađeno",

src/partials/language/id.html

@@ -31,8 +31,7 @@
   "meta.comments": "Komentar",
   "meta.source": "Sumber",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Cari",
   "search.result.placeholder": "Ketik untuk mulai pencarian",
   "search.result.none": "Tidak ada dokumen yang sesuai",

src/partials/language/pl.html

@@ -31,8 +31,7 @@
   "meta.comments": "Komentarze",
   "meta.source": "Kod źródłowy",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Szukaj",
   "search.result.placeholder": "Zacznij pisać, aby szukać",
   "search.result.none": "Brak wyników wyszukiwania",

src/partials/language/sr.html

@@ -31,8 +31,7 @@
   "meta.comments": "Коментари",
   "meta.source": "Извор",
   "search.language": "",
-  "search.pipeline.stopwords": false,
+  "search.pipeline": "",
-  "search.pipeline.trimmer": false,
   "search.placeholder": "Претрага",
   "search.result.placeholder": "Унесите појам претраге",
   "search.result.none": "Нису пронађени документи",