@easyops-cn/docusaurus-search-local 0.49.2 → 0.50.0

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.50.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.49.2...v0.50.0) (2025-06-03)
+
+
+### Features
+
+* support setting a language list to remove their default stop word filter ([3b5fe70](https://github.com/easyops-cn/docusaurus-search-local/commit/3b5fe7066e8138d6317bc3f3325ec0d84a9c21ce))
+* support setting a language list to remove their default stop word filter ([e7ce7ac](https://github.com/easyops-cn/docusaurus-search-local/commit/e7ce7ac88484b0e738562a79e9d9f2a81ed6e162)), closes [#517](https://github.com/easyops-cn/docusaurus-search-local/issues/517)
+
 ## [0.49.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.49.1...v0.49.2) (2025-03-31)
 
 

package/dist/client/client/utils/__mocks__/proxiedGeneratedConstants.js

@@ -1,5 +1,5 @@
 export let language = ["en", "zh"];
-export let removeDefaultStopWordFilter = false;
+export let removeDefaultStopWordFilter = [];
 export const searchIndexUrl = "search-index{dir}.json?_=abc";
 export const searchResultLimits = 8;
 export let fuzzyMatchingDistance = 0;

package/dist/client/client/utils/smartQueries.js

@@ -35,13 +35,14 @@ export function smartQueries(tokens, zhDictionary) {
     const stopWordPipelines = [];
     for (const lang of language) {
         if (lang === "en") {
-            if (!removeDefaultStopWordFilter) {
+            if (!removeDefaultStopWordFilter.includes(lang)) {
                 stopWordPipelines.unshift(lunr.stopWordFilter);
             }
         }
         else {
             const lunrLang = lunr[lang];
-            if (lunrLang.stopWordFilter) {
+            if (lunrLang.stopWordFilter &&
+                !removeDefaultStopWordFilter.includes(lang)) {
                 stopWordPipelines.unshift(lunrLang.stopWordFilter);
             }
         }

package/dist/server/server/utils/buildIndex.js

@@ -40,13 +40,24 @@ function buildIndex(allDocuments, { language, removeDefaultStopWordFilter, remov
         .map((documents) => ({
         documents,
         index: (0, lunr_1.default)(function () {
+            var _a;
             if (plugin) {
                 this.use(plugin);
             }
-            if (removeDefaultStopWordFilter) {
-                // Sometimes we need no English stop words,
-                // since they are almost all programming code.
-                this.pipeline.remove(lunr_1.default.stopWordFilter);
+            // Sometimes we need no English stop words,
+            // since they are almost all programming code.
+            for (const lang of language) {
+                if (removeDefaultStopWordFilter.includes(lang)) {
+                    if (lang === "en") {
+                        this.pipeline.remove(lunr_1.default.stopWordFilter);
+                    }
+                    else {
+                        const stopWordFilter = (_a = lunr_1.default[lang]) === null || _a === void 0 ? void 0 : _a.stopWordFilter;
+                        if (stopWordFilter) {
+                            this.pipeline.remove(stopWordFilter);
+                        }
+                    }
+                }
             }
             if (removeDefaultStemmer) {
                 this.pipeline.remove(lunr_1.default.stemmer);

package/dist/server/server/utils/processPluginOptions.js

@@ -22,6 +22,11 @@ function processPluginOptions(options, { siteDir, siteConfig: { themeConfig }, }
         config.searchBarPosition =
             search && search.position === "left" ? "left" : "right";
     }
+    if (!Array.isArray(config.removeDefaultStopWordFilter)) {
+        config.removeDefaultStopWordFilter = config.removeDefaultStopWordFilter
+            ? ["en"]
+            : [];
+    }
     return config;
 }
 exports.processPluginOptions = processPluginOptions;

package/dist/server/server/utils/validateOptions.js

@@ -15,7 +15,9 @@ const schema = utils_validation_1.Joi.object({
     hashed: isBooleanOrString.default(false),
     docsDir: isStringOrArrayOfStrings.default(["docs"]),
     blogDir: isStringOrArrayOfStrings.default(["blog"]),
-    removeDefaultStopWordFilter: utils_validation_1.Joi.boolean().default(false),
+    removeDefaultStopWordFilter: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.boolean(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()))
+        .default([]),
     removeDefaultStemmer: utils_validation_1.Joi.boolean().default(false),
     highlightSearchTermsOnTargetPage: utils_validation_1.Joi.boolean().default(false),
     searchResultLimits: utils_validation_1.Joi.number().default(8),

package/dist/types/index.d.ts

@@ -64,8 +64,10 @@ export interface PluginOptions {
     /**
      * Sometimes people (E.g., us) want to keep the English stop words as indexed, since they
      * maybe are relevant in programming docs.
+     *
+     * Set a language list to remove their default stop word filter, `true` is equivalent to `["en"]`.
      */
-    removeDefaultStopWordFilter?: boolean;
+    removeDefaultStopWordFilter?: boolean | string[];
     /**
      * Enable this if you want to be able to search for any partial word at the cost of search performance.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.49.2",
+  "version": "0.50.0",
   "description": "An offline/local search plugin for Docusaurus v3",
   "repository": {
     "type": "git",