@easyops-cn/docusaurus-search-local 0.30.2 → 0.31.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 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.31.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.2...v0.31.0) (2022-08-08)
+
+
+### Features
+
+* support `zhUserDict` and `zhUserDictPath` ([33f1ea4](https://github.com/easyops-cn/docusaurus-search-local/commit/33f1ea4765b0e134689fd65aa655c2bc1b4e6f0b)), closes [#246](https://github.com/easyops-cn/docusaurus-search-local/issues/246)
+
 ## [0.30.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.1...v0.30.2) (2022-07-23)
 
 

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

@@ -2,28 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.buildIndex = void 0;
 const tslib_1 = require("tslib");
+/* eslint @typescript-eslint/no-var-requires: 0 */
 const lunr_1 = tslib_1.__importDefault(require("lunr"));
-function buildIndex(allDocuments, { language, removeDefaultStopWordFilter, removeDefaultStemmer, }) {
+function buildIndex(allDocuments, { language, removeDefaultStopWordFilter, removeDefaultStemmer, zhUserDict, zhUserDictPath, }) {
     if (language.length > 1 || language.some((item) => item !== "en")) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
         require("lunr-languages/lunr.stemmer.support")(lunr_1.default);
     }
     if (language.includes("ja") || language.includes("jp")) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
         require("lunr-languages/tinyseg")(lunr_1.default);
     }
     for (const lang of language.filter((item) => item !== "en" && item !== "zh")) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
         require(`lunr-languages/lunr.${lang}`)(lunr_1.default);
     }
     if (language.includes("zh")) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        require("../../shared/lunrLanguageZh").lunrLanguageZh(lunr_1.default, 
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
-        require("./tokenizer").tokenizer);
+        const { tokenizer, loadUserDict } = require("./tokenizer");
+        loadUserDict(zhUserDict, zhUserDictPath);
+        require("../../shared/lunrLanguageZh").lunrLanguageZh(lunr_1.default, tokenizer);
     }
     if (language.length > 1) {
-        // eslint-disable-next-line @typescript-eslint/no-var-requires
         require("lunr-languages/lunr.multi")(lunr_1.default);
     }
     return allDocuments.map((documents) => ({

package/dist/server/server/utils/tokenizer.js

@@ -1,12 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tokenizer = void 0;
+exports.tokenizer = exports.loadUserDict = void 0;
 const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
 const lunr_1 = tslib_1.__importDefault(require("lunr"));
 const jieba_1 = tslib_1.__importDefault(require("@node-rs/jieba"));
 const cutWordByUnderscore_1 = require("./cutWordByUnderscore");
 // https://zhuanlan.zhihu.com/p/33335629
 const RegExpConsecutiveWord = /\w+|\p{Unified_Ideograph}+/u;
+let userDictLoaded = false;
+function loadUserDict(zhUserDict, zhUserDictPath) {
+    if (userDictLoaded) {
+        return;
+    }
+    if (zhUserDict) {
+        jieba_1.default.loadDict(Buffer.from(zhUserDict));
+    }
+    else if (zhUserDictPath) {
+        jieba_1.default.loadDict(fs_1.default.readFileSync(zhUserDictPath));
+    }
+    userDictLoaded = true;
+}
+exports.loadUserDict = loadUserDict;
 function tokenizer(input, metadata) {
     if (input == null) {
         return [];

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

@@ -25,6 +25,8 @@ const schema = utils_validation_1.Joi.object({
     searchBarShortcut: utils_validation_1.Joi.boolean().default(true),
     searchBarShortcutHint: utils_validation_1.Joi.boolean().default(true),
     docsPluginIdForPreferredVersion: utils_validation_1.Joi.string(),
+    zhUserDict: utils_validation_1.Joi.string(),
+    zhUserDictPath: utils_validation_1.Joi.string(),
 });
 function validateOptions({ options, validate, }) {
     return validate(schema, options || {});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.30.2",
+  "version": "0.31.0",
   "description": "An offline/local search plugin for Docusaurus v2",
   "repository": "https://github.com/easyops-cn/docusaurus-search-local",
   "homepage": "https://github.com/easyops-cn/docusaurus-search-local",