@easyops-cn/docusaurus-search-local 0.35.0 → 0.36.0

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 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.36.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.35.0...v0.36.0) (2023-09-09)
+
+
+### Features
+
+* added ignoreClasses option to be able to exclude specific content from indexing ([e9f7794](https://github.com/easyops-cn/docusaurus-search-local/commit/e9f7794f48c7af070c377d56bf3b6dbfccf3b9de))
+
+
+### Bug Fixes
+
+* make tests work on windows ([565199a](https://github.com/easyops-cn/docusaurus-search-local/commit/565199a63760e51f2f5421c8df075aeeb7e54a53))
+
 ## [0.35.0](https://github.com/easyops-cn/docusaurus-search-local/compare/v0.34.0...v0.35.0) (2023-03-04)
 
 

package/dist/server/server/utils/parse.js

@@ -5,10 +5,15 @@ const tslib_1 = require("tslib");
 const cheerio_1 = tslib_1.__importDefault(require("cheerio"));
 const parseDocument_1 = require("./parseDocument");
 const parsePage_1 = require("./parsePage");
-function parse(html, type, url) {
+function parse(html, type, url, { ignoreCssSelectors }) {
     const $ = cheerio_1.default.load(html);
     // Remove copy buttons from code boxes
     $('div[class^="mdxCodeBlock_"] button').remove();
+    if (ignoreCssSelectors) {
+        for (const ignoreSelector of ignoreCssSelectors) {
+            $(ignoreSelector).remove();
+        }
+    }
     if (type === "docs") {
         // Remove version badges
         $("span.badge")

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

@@ -18,7 +18,7 @@ function postBuildFactory(config, searchIndexFilename) {
             (0, debug_1.debugInfo)("parsing documents");
             for (const versionData of data) {
                 // Give every index entry a unique id so that the index does not need to store long URLs.
-                const allDocuments = yield (0, scanDocuments_1.scanDocuments)(versionData.paths);
+                const allDocuments = yield (0, scanDocuments_1.scanDocuments)(versionData.paths, config);
                 (0, debug_1.debugInfo)("building index");
                 const docsByDirMap = new Map();
                 const { searchContextByPaths, hideSearchBarWithNoSearchContext, useAllContextsWithNoSearchContext, } = config;

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

@@ -12,6 +12,7 @@ function processPluginOptions(options, { siteDir, siteConfig: { themeConfig }, }
     ensureArray(config, "docsDir");
     ensureArray(config, "blogDir");
     ensureArray(config, "ignoreFiles");
+    ensureArray(config, "ignoreCssSelectors");
     config.docsRouteBasePath = config.docsRouteBasePath.map((basePath) => basePath.replace(/^\//, ""));
     config.blogRouteBasePath = config.blogRouteBasePath.map((basePath) => basePath.replace(/^\//, ""));
     config.docsDir = config.docsDir.map((dir) => path_1.default.resolve(siteDir, dir));

package/dist/server/server/utils/scanDocuments.js

@@ -12,7 +12,7 @@ let nextDocId = 0;
 const getNextDocId = () => {
     return (nextDocId += 1);
 };
-function scanDocuments(DocInfoWithFilePathList) {
+function scanDocuments(DocInfoWithFilePathList, config) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const titleDocuments = [];
         const headingDocuments = [];
@@ -21,7 +21,7 @@ function scanDocuments(DocInfoWithFilePathList) {
         yield Promise.all(DocInfoWithFilePathList.map(({ filePath, url, type }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
             (0, debug_1.debugVerbose)(`parsing %s file %o of %o`, type, path_1.default.relative(process.cwd(), filePath), url);
             const html = yield readFileAsync(filePath, { encoding: "utf8" });
-            const { pageTitle, sections, breadcrumb } = (0, parse_1.parse)(html, type, url);
+            const { pageTitle, sections, breadcrumb } = (0, parse_1.parse)(html, type, url, config);
             const titleId = getNextDocId();
             titleDocuments.push({
                 i: titleId,

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

@@ -22,6 +22,7 @@ const schema = utils_validation_1.Joi.object({
     searchResultContextMaxLength: utils_validation_1.Joi.number().default(50),
     explicitSearchResultPath: utils_validation_1.Joi.boolean().default(false),
     ignoreFiles: isArrayOfStringsOrRegExpsOrStringOrRegExp.default([]),
+    ignoreCssSelectors: isStringOrArrayOfStrings.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"),

package/dist/types/index.d.ts

@@ -103,6 +103,12 @@ export interface PluginOptions {
      * @default []
      */
     ignoreFiles?: string | RegExp | (string | RegExp)[];
+    /**
+     * A list of css selectors to ignore when indexing each page.
+     *
+     * @default []
+     */
+    ignoreCssSelectors?: string | string[];
     /**
      * Whether to enable keyboard shortcut to focus in search bar.
      *

package/package.json

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