@easyops-cn/docusaurus-search-local 0.38.1 → 0.39.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.39.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.38.1...v0.39.0) (2023-12-15)
+
+
+### Features
+
+* customize search context labels [#382](https://github.com/easyops-cn/docusaurus-search-local/issues/382) ([f7df7bb](https://github.com/easyops-cn/docusaurus-search-local/commit/f7df7bb95b47140091f640103830e6c0356bb072))
+
 ## [0.38.1](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.38.0...v0.38.1) (2023-11-28)
 
 

package/README.md

@@ -1 +1 @@
-See https://github.com/easyops-cn/docusaurus-search-local#readme
+See https://github.com/easyops-cn/docusaurus-search-local#readme.

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

@@ -76,7 +76,14 @@ export default function SearchBar({ handleSearchBarToggle, }) {
         let nextSearchContext = "";
         if (location.pathname.startsWith(versionUrl)) {
             const uri = location.pathname.substring(versionUrl.length);
-            const matchedPath = searchContextByPaths.find((path) => uri === path || uri.startsWith(`${path}/`));
+            let matchedPath;
+            for (const _path of searchContextByPaths) {
+                const path = typeof _path === "string" ? _path : _path.path;
+                if (uri === path || uri.startsWith(`${path}/`)) {
+                    matchedPath = path;
+                    break;
+                }
+            }
             if (matchedPath) {
                 nextSearchContext = matchedPath;
             }

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

@@ -103,9 +103,19 @@ function SearchPageContent() {
                 })
                 : ""}
                 </option>
-                {searchContextByPaths.map((context) => (<option key={context} value={context}>
-                    {context}
-                  </option>))}
+                {searchContextByPaths.map((context) => {
+                let label;
+                let path;
+                if (typeof context === "string") {
+                    label = path = context;
+                }
+                else {
+                    ({ label, path } = context);
+                }
+                return (<option key={path} value={path}>
+                      {label}
+                    </option>);
+            })}
               </select>
             </div>) : null}
         </div>

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

@@ -34,7 +34,14 @@ function postBuildFactory(config, searchIndexFilename) {
                         for (const doc of documents) {
                             if (doc.u.startsWith(baseUrl)) {
                                 const uri = doc.u.substring(baseUrl.length);
-                                const matchedPath = searchContextByPaths.find((path) => uri === path || uri.startsWith(`${path}/`));
+                                let matchedPath;
+                                for (const _path of searchContextByPaths) {
+                                    const path = typeof _path === "string" ? _path : _path.path;
+                                    if (uri === path || uri.startsWith(`${path}/`)) {
+                                        matchedPath = path;
+                                        break;
+                                    }
+                                }
                                 if (matchedPath) {
                                     let dirAllDocs = docsByDirMap.get(matchedPath);
                                     if (!dirAllDocs) {

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

@@ -29,7 +29,10 @@ const schema = utils_validation_1.Joi.object({
     docsPluginIdForPreferredVersion: utils_validation_1.Joi.string(),
     zhUserDict: utils_validation_1.Joi.string(),
     zhUserDictPath: utils_validation_1.Joi.string(),
-    searchContextByPaths: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()),
+    searchContextByPaths: utils_validation_1.Joi.array().items(utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+        label: utils_validation_1.Joi.string(),
+        path: utils_validation_1.Joi.string(),
+    }))),
     hideSearchBarWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
     useAllContextsWithNoSearchContext: utils_validation_1.Joi.boolean().default(false),
 });

package/dist/types/index.d.ts

@@ -144,7 +144,10 @@ export interface PluginOptions {
      * Provide an list of sub-paths as separate search context, E.g.: `["docs", "community", "legacy/resources"]`.
      * It will create multiple search indexes by these paths.
      */
-    searchContextByPaths?: string[];
+    searchContextByPaths?: (string | {
+        label: string;
+        path: string;
+    })[];
     /**
      * Whether to hide the search bar when no search context was matched.
      *

package/package.json

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