@easyops-cn/docusaurus-search-local 0.30.1 → 0.32.0

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 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.32.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.31.0...v0.32.0) (2022-09-05)
+
+
+### Features
+
+* support setting searchBarPosition ([60b27d4](https://github.com/easyops-cn/docusaurus-search-local/commit/60b27d4a6e1f3342ac7afda586202fc5d7b8a3bc)), closes [#263](https://github.com/easyops-cn/docusaurus-search-local/issues/263)
+
+## [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)
+
+
+### Bug Fixes
+
+* remove useDocsPreferredVersion error log entirely ([56f5ab5](https://github.com/easyops-cn/docusaurus-search-local/commit/56f5ab51a77f682c565d357bcbf7a37567c2b21e))
+* use debug instead of console.error for useDocsPreferredVersion message ([3a09e39](https://github.com/easyops-cn/docusaurus-search-local/commit/3a09e39ef569a9dd1d99b1e251fdc79f909cff0f))
+
 ## [0.30.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.30.0...v0.30.1) (2022-07-22)
 
 

package/dist/client/client/theme/SearchBar/SearchBar.jsx

@@ -10,7 +10,7 @@ import { fetchIndexes } from "./fetchIndexes";
 import { SearchSourceFactory } from "../../utils/SearchSourceFactory";
 import { SuggestionTemplate } from "./SuggestionTemplate";
 import { EmptyTemplate } from "./EmptyTemplate";
-import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
+import { searchResultLimits, Mark, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, } from "../../utils/proxiedGenerated";
 import LoadingRing from "../LoadingRing/LoadingRing";
 import styles from "./SearchBar.module.css";
 async function fetchAutoCompleteJS() {
@@ -49,7 +49,6 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     catch (e) {
         if (indexDocs) {
             if (e instanceof ReactContextError) {
-                console.error("useDocsPreferredVersion", e);
                 /* ignore, happens when website doesn't use versions */
             }
             else {
@@ -83,7 +82,9 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             autoselect: true,
             openOnFocus: true,
             cssClasses: {
-                root: styles.searchBar,
+                root: clsx(styles.searchBar, {
+                    [styles.searchBarLeft]: searchBarPosition === "left",
+                }),
                 noPrefix: true,
                 dropdownMenu: styles.dropdownMenu,
                 input: styles.input,

package/dist/client/client/theme/SearchBar/SearchBar.module.css

@@ -16,6 +16,13 @@
   padding: var(--search-local-spacing, 12px);
 }
 
+@media not (max-width: 996px) {
+  .searchBar.searchBarLeft .dropdownMenu {
+    left: 0 !important;
+    right: auto !important;
+  }
+}
+
 @media (max-width: 576px) {
   :global(.navbar__search-input):not(:focus) {
     width: 2rem;

package/dist/client/client/theme/SearchPage/SearchPage.jsx

@@ -40,7 +40,6 @@ function SearchPageContent() {
     catch (e) {
         if (indexDocs) {
             if (e instanceof ReactContextError) {
-                console.error("useDocsPreferredVersion", e);
                 /* ignore, happens when website doesn't use versions */
             }
             else {

package/dist/server/server/index.js

@@ -11,7 +11,7 @@ const postBuildFactory_1 = require("./utils/postBuildFactory");
 const generate_1 = require("./utils/generate");
 const PLUGIN_NAME = "@easyops-cn/docusaurus-search-local";
 function DocusaurusSearchLocalPlugin(context, options) {
-    const config = (0, processPluginOptions_1.processPluginOptions)(options, context.siteDir);
+    const config = (0, processPluginOptions_1.processPluginOptions)(options, context);
     const dir = path_1.default.join(context.generatedFilesDir, PLUGIN_NAME, "default");
     fs_extra_1.default.ensureDirSync(dir);
     const searchIndexFilename = (0, generate_1.generate)(config, dir);

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/generate.js

@@ -6,7 +6,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const path_1 = tslib_1.__importDefault(require("path"));
 const getIndexHash_1 = require("./getIndexHash");
 function generate(config, dir) {
-    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, docsPluginIdForPreferredVersion, indexDocs, } = config;
+    const { language, removeDefaultStopWordFilter, removeDefaultStemmer, highlightSearchTermsOnTargetPage, searchResultLimits, searchResultContextMaxLength, explicitSearchResultPath, searchBarShortcut, searchBarShortcutHint, searchBarPosition, docsPluginIdForPreferredVersion, indexDocs, } = config;
     const indexHash = (0, getIndexHash_1.getIndexHash)(config);
     const contents = [
         `import lunr from ${JSON.stringify(require.resolve("lunr"))};`,
@@ -51,6 +51,7 @@ function generate(config, dir) {
     contents.push(`export const explicitSearchResultPath = ${JSON.stringify(explicitSearchResultPath)};`);
     contents.push(`export const searchBarShortcut = ${JSON.stringify(searchBarShortcut)};`);
     contents.push(`export const searchBarShortcutHint = ${JSON.stringify(searchBarShortcutHint)};`);
+    contents.push(`export const searchBarPosition = ${JSON.stringify(searchBarPosition)};`);
     contents.push(`export const docsPluginIdForPreferredVersion = ${docsPluginIdForPreferredVersion === undefined
         ? "undefined"
         : JSON.stringify(docsPluginIdForPreferredVersion)};`);

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

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.processPluginOptions = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
-function processPluginOptions(options, siteDir) {
+function processPluginOptions(options, { siteDir, siteConfig: { themeConfig }, }) {
+    var _a, _b;
     const config = Object.assign({}, options);
     ensureArray(config, "docsRouteBasePath");
     ensureArray(config, "blogRouteBasePath");
@@ -15,6 +16,11 @@ function processPluginOptions(options, siteDir) {
     config.blogRouteBasePath = config.blogRouteBasePath.map((basePath) => basePath.replace(/^\//, ""));
     config.docsDir = config.docsDir.map((dir) => path_1.default.resolve(siteDir, dir));
     config.blogDir = config.blogDir.map((dir) => path_1.default.resolve(siteDir, dir));
+    if (config.searchBarPosition === "auto") {
+        const search = (_b = (_a = themeConfig.navbar) === null || _a === void 0 ? void 0 : _a.items) === null || _b === void 0 ? void 0 : _b.find((item) => item.type === "search");
+        config.searchBarPosition =
+            search && search.position === "left" ? "left" : "right";
+    }
     return config;
 }
 exports.processPluginOptions = processPluginOptions;

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

@@ -24,7 +24,10 @@ const schema = utils_validation_1.Joi.object({
     ignoreFiles: isArrayOfStringsOrRegExpsOrStringOrRegExp.default([]),
     searchBarShortcut: utils_validation_1.Joi.boolean().default(true),
     searchBarShortcutHint: utils_validation_1.Joi.boolean().default(true),
+    searchBarPosition: utils_validation_1.Joi.string().default("auto"),
     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.1",
+  "version": "0.32.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",