@easyops-cn/docusaurus-search-local 0.29.2 → 0.30.0

package/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 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.30.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.4...v0.30.0) (2022-07-22)
+
+
+### Features
+
+* support saving hash in filename instead of query ([4930a88](https://github.com/easyops-cn/docusaurus-search-local/commit/4930a88779813ffcaa932a56f786066f969aff6e)), closes [#171](https://github.com/easyops-cn/docusaurus-search-local/issues/171)
+
+## [0.29.4](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.3...v0.29.4) (2022-07-22)
+
+
+### Bug Fixes
+
+* fix call stack overflow with large code blocks ([e0b2cfd](https://github.com/easyops-cn/docusaurus-search-local/commit/e0b2cfd6e21f008609a85c42c0159ae25b575d6b)), closes [#164](https://github.com/easyops-cn/docusaurus-search-local/issues/164)
+
+## [0.29.3](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.2...v0.29.3) (2022-07-20)
+
+
+### Bug Fixes
+
+* hide clear button on small screen when input is not focused ([c69fbf6](https://github.com/easyops-cn/docusaurus-search-local/commit/c69fbf64ff6ba11c32e63d89dada010bb1e521dc)), closes [#230](https://github.com/easyops-cn/docusaurus-search-local/issues/230)
+
 ## [0.29.2](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.29.1...v0.29.2) (2022-07-19)
 
 

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

@@ -178,12 +178,15 @@ export default function SearchBar({ handleSearchBarToggle, }) {
             search.current?.autocomplete.setVal(keywords.join(" "));
         });
     }, [location.search, location.pathname]);
+    const [focused, setFocused] = useState(false);
     const onInputFocus = useCallback(() => {
         focusAfterIndexLoaded.current = true;
         loadIndex();
+        setFocused(true);
         handleSearchBarToggle?.(true);
     }, [handleSearchBarToggle, loadIndex]);
     const onInputBlur = useCallback(() => {
+        setFocused(false);
         handleSearchBarToggle?.(false);
     }, [handleSearchBarToggle]);
     const onInputMouseEnter = useCallback(() => {
@@ -232,6 +235,7 @@ export default function SearchBar({ handleSearchBarToggle, }) {
     }, [location.pathname, location.search, location.hash, history]);
     return (<div className={clsx("navbar__search", styles.searchBarContainer, {
             [styles.searchIndexLoading]: loading && inputChanged,
+            [styles.focused]: focused,
         })}>
       <input placeholder={translate({
             id: "theme.SearchBar.label",

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

@@ -237,6 +237,7 @@ html[data-theme="dark"] .noResultsIcon {
 }
 
 @media (max-width: 576px) {
+  .searchBarContainer:not(.focused) .searchClearButton,
   .searchHintContainer {
     display: none;
   }

package/dist/client/client/theme/SearchBar/fetchIndexes.js

@@ -1,8 +1,8 @@
 import lunr from "lunr";
-import { indexHash } from "../../utils/proxiedGenerated";
+import { searchIndexUrl } from "../../utils/proxiedGenerated";
 export async function fetchIndexes(baseUrl) {
     if (process.env.NODE_ENV === "production") {
-        const json = (await (await fetch(`${baseUrl}search-index.json?_=${indexHash}`)).json());
+        const json = (await (await fetch(`${baseUrl}${searchIndexUrl}`)).json());
         const wrappedIndexes = json.map(({ documents, index }, type) => ({
             type: type,
             documents,

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

@@ -1,7 +1,7 @@
 export let language = ["en", "zh"];
 export let removeDefaultStopWordFilter = false;
 export let removeDefaultStemmer = false;
-export const indexHash = "abc";
+export const searchIndexUrl = "search-index.json?_=abc";
 export const searchResultLimits = 8;
 export const searchResultContextMaxLength = 50;
 export const explicitSearchResultPath = false;

package/dist/client/client/utils/highlightStemmed.js

@@ -3,14 +3,11 @@ import { highlight } from "./highlight";
 import { looseTokenize } from "./looseTokenize";
 import { searchResultContextMaxLength } from "./proxiedGenerated";
 export function highlightStemmed(content, positions, tokens, maxLength = searchResultContextMaxLength) {
-    const chunkIndexRef = {
-        chunkIndex: -1,
-    };
-    const chunks = splitIntoChunks(content, positions, tokens, 0, 0, chunkIndexRef);
-    const leadingChunks = chunks.slice(0, chunkIndexRef.chunkIndex);
-    const firstChunk = chunks[chunkIndexRef.chunkIndex];
+    const { chunkIndex, chunks } = splitIntoChunks(content, positions, tokens);
+    const leadingChunks = chunks.slice(0, chunkIndex);
+    const firstChunk = chunks[chunkIndex];
     const html = [firstChunk.html];
-    const trailingChunks = chunks.slice(chunkIndexRef.chunkIndex + 1);
+    const trailingChunks = chunks.slice(chunkIndex + 1);
     let currentLength = firstChunk.textLength;
     let leftPadding = 0;
     let rightPadding = 0;
@@ -54,42 +51,46 @@ export function highlightStemmed(content, positions, tokens, maxLength = searchR
     }
     return html.join("");
 }
-export function splitIntoChunks(content, positions, tokens, positionIndex, cursor, chunkIndexRef) {
+export function splitIntoChunks(content, positions, tokens) {
     const chunks = [];
-    const [start, length] = positions[positionIndex];
-    if (start < cursor) {
+    let positionIndex = 0;
+    let cursor = 0;
+    let chunkIndex = -1;
+    while (positionIndex < positions.length) {
+        const [start, length] = positions[positionIndex];
         positionIndex += 1;
-        if (positionIndex < positions.length) {
-            chunks.push(...splitIntoChunks(content, positions, tokens, positionIndex, cursor));
+        if (start < cursor) {
+            continue;
         }
-    }
-    else {
         if (start > cursor) {
-            chunks.push(...looseTokenize(content.substring(cursor, start)).map((token) => ({
+            const leadingChunks = looseTokenize(content.substring(cursor, start)).map((token) => ({
                 html: escapeHtml(token),
                 textLength: token.length,
-            })));
+            }));
+            for (const item of leadingChunks) {
+                chunks.push(item);
+            }
         }
-        if (chunkIndexRef) {
-            chunkIndexRef.chunkIndex = chunks.length;
+        if (chunkIndex === -1) {
+            chunkIndex = chunks.length;
         }
+        cursor = start + length;
         chunks.push({
-            html: highlight(content.substr(start, length), tokens, true),
+            html: highlight(content.substring(start, cursor), tokens, true),
             textLength: length,
         });
-        const nextCursor = start + length;
-        positionIndex += 1;
-        if (positionIndex < positions.length) {
-            chunks.push(...splitIntoChunks(content, positions, tokens, positionIndex, nextCursor));
-        }
-        else {
-            if (nextCursor < content.length) {
-                chunks.push(...looseTokenize(content.substr(nextCursor)).map((token) => ({
-                    html: escapeHtml(token),
-                    textLength: token.length,
-                })));
-            }
+    }
+    if (cursor < content.length) {
+        const trailingChunks = looseTokenize(content.substring(cursor)).map((token) => ({
+            html: escapeHtml(token),
+            textLength: token.length,
+        }));
+        for (const item of trailingChunks) {
+            chunks.push(item);
         }
     }
-    return chunks;
+    return {
+        chunkIndex,
+        chunks,
+    };
 }

package/dist/client/client/utils/looseTokenize.js

@@ -11,11 +11,11 @@ export function looseTokenize(content) {
             break;
         }
         if (match.index > 0) {
-            tokens.push(text.substr(0, match.index));
+            tokens.push(text.substring(0, match.index));
         }
         tokens.push(match[0]);
         start += match.index + match[0].length;
-        text = content.substr(start);
+        text = content.substring(start);
     }
     return tokens;
 }

package/dist/server/server/index.js

@@ -14,7 +14,7 @@ function DocusaurusSearchLocalPlugin(context, options) {
     const config = (0, processPluginOptions_1.processPluginOptions)(options, context.siteDir);
     const dir = path_1.default.join(context.generatedFilesDir, PLUGIN_NAME, "default");
     fs_extra_1.default.ensureDirSync(dir);
-    (0, generate_1.generate)(config, dir);
+    const searchIndexFilename = (0, generate_1.generate)(config, dir);
     const themePath = path_1.default.resolve(__dirname, "../../client/client/theme");
     const pagePath = path_1.default.join(themePath, "SearchPage/index.js");
     return {
@@ -22,7 +22,7 @@ function DocusaurusSearchLocalPlugin(context, options) {
         getThemePath() {
             return themePath;
         },
-        postBuild: (0, postBuildFactory_1.postBuildFactory)(config),
+        postBuild: (0, postBuildFactory_1.postBuildFactory)(config, searchIndexFilename),
         getPathsToWatch() {
             return [pagePath];
         },

package/dist/server/server/utils/generate.js

@@ -35,7 +35,18 @@ function generate(config, dir) {
     else {
         contents.push("export const Mark = null;");
     }
-    contents.push(`export const indexHash = ${JSON.stringify(indexHash)};`);
+    let searchIndexFilename = "search-index.json";
+    let searchIndexQuery = "";
+    if (indexHash) {
+        if (config.hashed === "filename") {
+            searchIndexFilename = `search-index-${indexHash}.json`;
+        }
+        else {
+            searchIndexQuery = `?_=${indexHash}`;
+        }
+    }
+    const searchIndexUrl = searchIndexFilename + searchIndexQuery;
+    contents.push(`export const searchIndexUrl = ${JSON.stringify(searchIndexUrl)};`);
     contents.push(`export const searchResultLimits = ${JSON.stringify(searchResultLimits)};`, `export const searchResultContextMaxLength = ${JSON.stringify(searchResultContextMaxLength)};`);
     contents.push(`export const explicitSearchResultPath = ${JSON.stringify(explicitSearchResultPath)};`);
     contents.push(`export const searchBarShortcut = ${JSON.stringify(searchBarShortcut)};`);
@@ -44,5 +55,6 @@ function generate(config, dir) {
         ? "undefined"
         : JSON.stringify(docsPluginIdForPreferredVersion)};`);
     fs_1.default.writeFileSync(path_1.default.join(dir, "generated.js"), contents.join("\n"));
+    return searchIndexFilename;
 }
 exports.generate = generate;

package/dist/server/server/utils/getCondensedText.js

@@ -50,6 +50,9 @@ function getCondensedText(element, $) {
             return element.data;
         }
         if (element.type === "tag") {
+            if (element.name === "br") {
+                return " ";
+            }
             const content = getText($(element).contents().get());
             if (BLOCK_TAGS.has(element.name)) {
                 return " " + content + " ";

package/dist/server/server/utils/postBuildFactory.js

@@ -10,7 +10,7 @@ const debug_1 = require("./debug");
 const processDocInfos_1 = require("./processDocInfos");
 const scanDocuments_1 = require("./scanDocuments");
 const writeFileAsync = util_1.default.promisify(fs_1.default.writeFile);
-function postBuildFactory(config) {
+function postBuildFactory(config, searchIndexFilename) {
     return function postBuild(buildData) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             (0, debug_1.debugInfo)("gathering documents");
@@ -22,7 +22,7 @@ function postBuildFactory(config) {
                 (0, debug_1.debugInfo)("building index");
                 const searchIndex = (0, buildIndex_1.buildIndex)(allDocuments, config);
                 (0, debug_1.debugInfo)("writing index to disk");
-                yield writeFileAsync(path_1.default.join(versionData.outDir, "search-index.json"), JSON.stringify(searchIndex), { encoding: "utf8" });
+                yield writeFileAsync(path_1.default.join(versionData.outDir, searchIndexFilename), JSON.stringify(searchIndex), { encoding: "utf8" });
                 (0, debug_1.debugInfo)("index written to disk successfully!");
             }
         });

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const isStringOrArrayOfStrings = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()));
+const isBooleanOrString = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.boolean(), utils_validation_1.Joi.string());
 const isArrayOfStringsOrRegExpsOrStringOrRegExp = utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.object().regex())), utils_validation_1.Joi.string(), utils_validation_1.Joi.object().regex());
 const schema = utils_validation_1.Joi.object({
     indexDocs: utils_validation_1.Joi.boolean().default(true),
@@ -11,7 +12,7 @@ const schema = utils_validation_1.Joi.object({
     docsRouteBasePath: isStringOrArrayOfStrings.default(["docs"]),
     blogRouteBasePath: isStringOrArrayOfStrings.default(["blog"]),
     language: isStringOrArrayOfStrings.default(["en"]),
-    hashed: utils_validation_1.Joi.boolean().default(false),
+    hashed: isBooleanOrString.default(false),
     docsDir: isStringOrArrayOfStrings.default(["docs"]),
     blogDir: isStringOrArrayOfStrings.default(["blog"]),
     removeDefaultStopWordFilter: utils_validation_1.Joi.boolean().default(false),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyops-cn/docusaurus-search-local",
-  "version": "0.29.2",
+  "version": "0.30.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",