@vuepress-plume/plugin-search 1.0.0-rc.192 → 1.0.0-rc.193

package/lib/client/composables/index.d.ts

@@ -2,12 +2,42 @@ import { ComputedRef, MaybeRef, ShallowRef } from "vue";
 import { SearchBoxLocales, SearchLocaleOptions } from "../../shared/index.js";
 
 //#region src/client/composables/locale.d.ts
+/**
+ * Get locale configuration for the current route.
+ *
+ * 获取当前路由的语言配置。
+ *
+ * @param locales - Locale configuration object / 语言配置对象
+ * @returns Computed ref to the current locale settings / 当前语言设置的计算引用
+ * @example
+ * const locale = useLocale(locales)
+ * console.log(locale.value.placeholder) // 'Search' or localized value
+ */
 declare function useLocale(locales: MaybeRef<SearchBoxLocales>): ComputedRef<Partial<SearchLocaleOptions>>;
 //#endregion
 //#region src/client/composables/searchIndex.d.ts
+/**
+ * Type definition for search index data.
+ *
+ * 搜索索引数据的类型定义。
+ *
+ * Maps locale paths to functions that load the corresponding search index.
+ *
+ * 将语言路径映射到加载相应搜索索引的函数。
+ */
 type SearchIndexData = Record<string, () => Promise<{
   default: string;
 }>>;
+/**
+ * Get the search index data for all locales.
+ *
+ * 获取所有语言的搜索索引数据。
+ *
+ * @returns Shallow ref to the search index data / 搜索索引数据的浅层引用
+ * @example
+ * const indexData = useSearchIndex()
+ * const localeIndex = await indexData.value['/zh/']()
+ */
 declare function useSearchIndex(): ShallowRef<SearchIndexData>;
 //#endregion
 export { useLocale, useSearchIndex };

package/lib/client/composables/index.js

@@ -1,8 +1,12 @@
 import { computed, shallowRef, toRef } from "vue";
 import { useRouteLocale } from "vuepress/client";
 import { searchIndex } from "@internal/minisearchIndex";
-
 //#region src/client/composables/locale.ts
+/**
+* Default locale configuration for search.
+*
+* 搜索的默认语言配置。
+*/
 const defaultLocales = { "/": {
 	placeholder: "Search",
 	resetButtonTitle: "Reset search",
@@ -18,21 +22,45 @@ const defaultLocales = { "/": {
 		closeKeyAriaLabel: "escape"
 	}
 } };
+/**
+* Get locale configuration for the current route.
+*
+* 获取当前路由的语言配置。
+*
+* @param locales - Locale configuration object / 语言配置对象
+* @returns Computed ref to the current locale settings / 当前语言设置的计算引用
+* @example
+* const locale = useLocale(locales)
+* console.log(locale.value.placeholder) // 'Search' or localized value
+*/
 function useLocale(locales) {
 	const localesRef = toRef(locales);
 	const routeLocale = useRouteLocale();
 	return computed(() => localesRef.value[routeLocale.value] ?? defaultLocales[routeLocale.value] ?? defaultLocales["/"]);
 }
-
 //#endregion
 //#region src/client/composables/searchIndex.ts
+/**
+* Reactive reference to the search index data.
+*
+* 搜索索引数据的响应式引用。
+*/
 const searchIndexData = shallowRef(searchIndex);
+/**
+* Get the search index data for all locales.
+*
+* 获取所有语言的搜索索引数据。
+*
+* @returns Shallow ref to the search index data / 搜索索引数据的浅层引用
+* @example
+* const indexData = useSearchIndex()
+* const localeIndex = await indexData.value['/zh/']()
+*/
 function useSearchIndex() {
 	return searchIndexData;
 }
 if (__VUEPRESS_DEV__ && (import.meta.webpackHot || import.meta.hot)) __VUE_HMR_RUNTIME__.updateSearchIndex = (data) => {
 	searchIndexData.value = data;
 };
-
 //#endregion
-export { useLocale, useSearchIndex };
+export { useLocale, useSearchIndex };

package/lib/client/config.js

@@ -1,7 +1,6 @@
 import { h } from "vue";
 import { defineClientConfig } from "vuepress/client";
 import Search from "./components/Search.vue";
-
 //#region src/client/config.ts
 const locales = __SEARCH_LOCALES__;
 const searchOptions = __SEARCH_OPTIONS__;
@@ -12,6 +11,5 @@ var config_default = defineClientConfig({ enhance({ app }) {
 		...props
 	}));
 } });
-
 //#endregion
-export { config_default as default };
+export { config_default as default };

package/lib/client/index.js

@@ -1,4 +1,17 @@
 import SearchBox from "./components/Search.vue";
 import { useSearchIndex } from "./composables/index.js";
-
-export { SearchBox, useSearchIndex };
+//#region src/client/index.ts
+/**
+* VuePress Search Plugin - Client Side Entry
+*
+* VuePress 搜索插件 - 客户端入口
+*
+* Exports the SearchBox component and search index composable for use in
+* VuePress theme components.
+*
+* 导出 SearchBox 组件和搜索索引组合式函数，供 VuePress 主题组件使用。
+*
+* @module plugin-search/client
+*/
+//#endregion
+export { SearchBox, useSearchIndex };

package/lib/client/utils/index.d.ts

@@ -1,11 +1,86 @@
 //#region src/client/utils/lru.d.ts
+/**
+ * LRU (Least Recently Used) Cache Implementation
+ *
+ * LRU（最近最少使用）缓存实现
+ *
+ * Adapted from https://stackoverflow.com/a/46432113/11613622
+ *
+ * @module plugin-search/client/utils/lru
+ */
+/**
+ * Generic LRU Cache implementation using Map.
+ *
+ * 使用 Map 实现的通用 LRU 缓存。
+ *
+ * Automatically evicts the least recently used item when the cache reaches
+ * its maximum size.
+ *
+ * 当缓存达到最大容量时，自动淘汰最近最少使用的项。
+ *
+ * @template K - Key type / 键类型
+ * @template V - Value type / 值类型
+ * @example
+ * const cache = new LRUCache<string, number>(3)
+ * cache.set('a', 1)
+ * cache.set('b', 2)
+ * cache.set('c', 3)
+ * cache.set('d', 4) // 'a' is evicted
+ * cache.get('b') // returns 2, 'b' becomes most recent
+ */
 declare class LRUCache<K, V> {
+  /** Maximum number of items in the cache / 缓存中的最大项数 */
   private max;
+  /** Internal Map storage / 内部 Map 存储 */
   private cache;
+  /**
+   * Create a new LRU Cache instance.
+   *
+   * 创建新的 LRU 缓存实例。
+   *
+   * @param max - Maximum cache size (default: 10) / 最大缓存大小（默认：10）
+   */
   constructor(max?: number);
+  /**
+   * Get a value from the cache.
+   *
+   * 从缓存中获取值。
+   *
+   * Accessing an item moves it to the end (most recently used position).
+   *
+   * 访问项会将其移动到末尾（最近使用的位置）。
+   *
+   * @param key - Cache key / 缓存键
+   * @returns Cached value or undefined if not found / 缓存值，未找到则返回 undefined
+   */
   get(key: K): V | undefined;
+  /**
+   * Set a value in the cache.
+   *
+   * 在缓存中设置值。
+   *
+   * If the key already exists, it is moved to the end. If the cache is full,
+   * the oldest item is evicted.
+   *
+   * 如果键已存在，则将其移动到末尾。如果缓存已满，则淘汰最旧的项。
+   *
+   * @param key - Cache key / 缓存键
+   * @param val - Value to cache / 要缓存的值
+   */
   set(key: K, val: V): void;
+  /**
+   * Get the first (oldest) key in the cache.
+   *
+   * 获取缓存中的第一个（最旧的）键。
+   *
+   * @returns The oldest key or undefined if cache is empty / 最旧的键，缓存为空则返回 undefined
+   */
   first(): K | undefined;
+  /**
+   * Clear all items from the cache.
+   *
+   * 清空缓存中的所有项。
+   */
   clear(): void;
 }
 //#endregion

package/lib/client/utils/index.js

@@ -1,11 +1,61 @@
 //#region src/client/utils/lru.ts
+/**
+* LRU (Least Recently Used) Cache Implementation
+*
+* LRU（最近最少使用）缓存实现
+*
+* Adapted from https://stackoverflow.com/a/46432113/11613622
+*
+* @module plugin-search/client/utils/lru
+*/
+/**
+* Generic LRU Cache implementation using Map.
+*
+* 使用 Map 实现的通用 LRU 缓存。
+*
+* Automatically evicts the least recently used item when the cache reaches
+* its maximum size.
+*
+* 当缓存达到最大容量时，自动淘汰最近最少使用的项。
+*
+* @template K - Key type / 键类型
+* @template V - Value type / 值类型
+* @example
+* const cache = new LRUCache<string, number>(3)
+* cache.set('a', 1)
+* cache.set('b', 2)
+* cache.set('c', 3)
+* cache.set('d', 4) // 'a' is evicted
+* cache.get('b') // returns 2, 'b' becomes most recent
+*/
 var LRUCache = class {
+	/** Maximum number of items in the cache / 缓存中的最大项数 */
 	max;
+	/** Internal Map storage / 内部 Map 存储 */
 	cache;
+	/**
+	* Create a new LRU Cache instance.
+	*
+	* 创建新的 LRU 缓存实例。
+	*
+	* @param max - Maximum cache size (default: 10) / 最大缓存大小（默认：10）
+	*/
 	constructor(max = 10) {
 		this.max = max;
 		this.cache = /* @__PURE__ */ new Map();
 	}
+	/**
+	* Get a value from the cache.
+	*
+	* 从缓存中获取值。
+	*
+	* Accessing an item moves it to the end (most recently used position).
+	*
+	* 访问项会将其移动到末尾（最近使用的位置）。
+	*
+	* @param key - Cache key / 缓存键
+	* @returns Cached value or undefined if not found / 缓存值，未找到则返回 undefined
+	*/
 	get(key) {
 		const item = this.cache.get(key);
 		if (item !== void 0) {
@@ -14,18 +64,42 @@ var LRUCache = class {
 		}
 		return item;
 	}
+	/**
+	* Set a value in the cache.
+	*
+	* 在缓存中设置值。
+	*
+	* If the key already exists, it is moved to the end. If the cache is full,
+	* the oldest item is evicted.
+	*
+	* 如果键已存在，则将其移动到末尾。如果缓存已满，则淘汰最旧的项。
+	*
+	* @param key - Cache key / 缓存键
+	* @param val - Value to cache / 要缓存的值
+	*/
 	set(key, val) {
 		if (this.cache.has(key)) this.cache.delete(key);
 		else if (this.cache.size === this.max) this.cache.delete(this.first());
 		this.cache.set(key, val);
 	}
+	/**
+	* Get the first (oldest) key in the cache.
+	*
+	* 获取缓存中的第一个（最旧的）键。
+	*
+	* @returns The oldest key or undefined if cache is empty / 最旧的键，缓存为空则返回 undefined
+	*/
 	first() {
 		return this.cache.keys().next().value;
 	}
+	/**
+	* Clear all items from the cache.
+	*
+	* 清空缓存中的所有项。
+	*/
 	clear() {
 		this.cache.clear();
 	}
 };
-
 //#endregion
-export { LRUCache };
+export { LRUCache };

package/lib/node/index.d.ts

@@ -3,11 +3,35 @@ import { App, Plugin } from "vuepress/core";
 export * from "../shared/index.js";
 
 //#region src/node/prepareSearchIndex.d.ts
+/**
+ * Options for search index preparation.
+ *
+ * 搜索索引准备的配置选项。
+ */
 interface SearchIndexOptions {
+  /** VuePress application instance / VuePress 应用实例 */
   app: App;
+  /** MiniSearch configuration options / MiniSearch 配置选项 */
   searchOptions: SearchOptions;
+  /** Function to filter searchable pages / 过滤可搜索页面的函数 */
   isSearchable: SearchPluginOptions['isSearchable'];
 }
+/**
+ * Prepare search indexes for all pages in the VuePress application.
+ *
+ * 为 VuePress 应用中的所有页面准备搜索索引。
+ *
+ * This function indexes all pages concurrently, creating separate MiniSearch
+ * instances for each locale, and writes the indexes to temporary files.
+ *
+ * 此函数并发索引所有页面，为每个语言创建独立的 MiniSearch 实例，
+ * 并将索引写入临时文件。
+ *
+ * @param options - Search index preparation options / 搜索索引准备选项
+ * @param options.app - VuePress application instance / VuePress 应用实例
+ * @param options.isSearchable - Function to filter searchable pages / 过滤可搜索页面的函数
+ * @param options.searchOptions - MiniSearch configuration / MiniSearch 配置
+ */
 declare function prepareSearchIndex({
   app,
   isSearchable,
@@ -15,6 +39,36 @@ declare function prepareSearchIndex({
 }: SearchIndexOptions): Promise<void>;
 //#endregion
 //#region src/node/searchPlugin.d.ts
+/**
+ * Create a VuePress search plugin instance.
+ *
+ * 创建 VuePress 搜索插件实例。
+ *
+ * @param options - Plugin configuration options / 插件配置选项
+ * @param options.locales - Locale-specific search configurations / 特定语言的搜索配置
+ * @param options.isSearchable - Function to determine if a page should be indexed / 判断页面是否应被索引的函数
+ * @param options.searchOptions - MiniSearch options / MiniSearch 配置选项
+ * @returns VuePress plugin object / VuePress 插件对象
+ * @example
+ * // Basic usage
+ * export default {
+ *   plugins: [
+ *     searchPlugin()
+ *   ]
+ * }
+ *
+ * // With custom options
+ * export default {
+ *   plugins: [
+ *     searchPlugin({
+ *       locales: {
+ *         '/zh/': { placeholder: '搜索文档' }
+ *       },
+ *       isSearchable: (page) => page.path !== '/secret/'
+ *     })
+ *   ]
+ * }
+ */
 declare function searchPlugin({
   locales,
   isSearchable,

package/lib/node/index.js

@@ -2,14 +2,24 @@ import MiniSearch from "minisearch";
 import pMap from "p-map";
 import { colors, getDirname, logger, path } from "vuepress/utils";
 import { addViteOptimizeDepsInclude, getFullLocaleConfig } from "@vuepress/helper";
-import chokidar from "chokidar";
-
-export * from "../shared/index.js"
-
+export * from "../shared/index.js";
 //#region src/node/prepareSearchIndex.ts
+/** Directory path for storing search index files / 存储搜索索引文件的目录路径 */
 const SEARCH_INDEX_DIR = "internal/minisearchIndex/";
+/** Map of locale paths to their MiniSearch instances / 语言路径到 MiniSearch 实例的映射 */
 const indexByLocales = /* @__PURE__ */ new Map();
+/** Cache for index objects by file path / 按文件路径缓存索引对象 */
 const indexCache = /* @__PURE__ */ new Map();
+/**
+* Get or create a MiniSearch index for a specific locale.
+*
+* 获取或创建特定语言的 MiniSearch 索引。
+*
+* @param locale - Locale path (e.g., '/', '/zh/') / 语言路径
+* @param lang - Language code for tokenization / 用于分词的语言代码
+* @param options - Search index options / 搜索索引选项
+* @returns MiniSearch instance for the locale / 该语言的 MiniSearch 实例
+*/
 function getIndexByLocale(locale, lang, options) {
 	let index = indexByLocales.get(locale);
 	if (!index) {
@@ -30,6 +40,14 @@ function getIndexByLocale(locale, lang, options) {
 	}
 	return index;
 }
+/**
+* Get or create an index cache for a specific file path.
+*
+* 获取或创建特定文件路径的索引缓存。
+*
+* @param filepath - File path to get cache for / 要获取缓存的文件路径
+* @returns Array of index objects for the file / 该文件的索引对象数组
+*/
 function getIndexCache(filepath) {
 	let index = indexCache.get(filepath);
 	if (!index) {
@@ -38,9 +56,38 @@ function getIndexCache(filepath) {
 	}
 	return index;
 }
+/**
+* Write a placeholder search index file for development mode.
+*
+* 为开发模式写入占位符搜索索引文件。
+*
+* This is used to provide an empty index before the actual index is prepared,
+* preventing errors when the search component loads before indexing completes.
+*
+* 用于在实际索引准备完成之前提供空索引，
+* 防止搜索组件在索引完成之前加载时出错。
+*
+* @param app - VuePress application instance / VuePress 应用实例
+*/
 async function prepareSearchIndexPlaceholder(app) {
 	await app.writeTemp(`${SEARCH_INDEX_DIR}index.js`, "export const searchIndex = {}");
 }
+/**
+* Prepare search indexes for all pages in the VuePress application.
+*
+* 为 VuePress 应用中的所有页面准备搜索索引。
+*
+* This function indexes all pages concurrently, creating separate MiniSearch
+* instances for each locale, and writes the indexes to temporary files.
+*
+* 此函数并发索引所有页面，为每个语言创建独立的 MiniSearch 实例，
+* 并将索引写入临时文件。
+*
+* @param options - Search index preparation options / 搜索索引准备选项
+* @param options.app - VuePress application instance / VuePress 应用实例
+* @param options.isSearchable - Function to filter searchable pages / 过滤可搜索页面的函数
+* @param options.searchOptions - MiniSearch configuration / MiniSearch 配置
+*/
 async function prepareSearchIndex({ app, isSearchable, searchOptions }) {
 	const start = performance.now();
 	indexByLocales.clear();
@@ -53,15 +100,36 @@ async function prepareSearchIndex({ app, isSearchable, searchOptions }) {
 	}
 	if (app.env.isDebug) logger.info(`\n[${colors.green("@vuepress-plume/plugin-search")}] prepare search time spent: ${(performance.now() - start).toFixed(2)}ms`);
 }
-async function onSearchIndexUpdated(filepath, { app, isSearchable, searchOptions }) {
-	if ((isSearchable ? app.pages.filter(isSearchable) : app.pages).some((p) => p.filePathRelative?.endsWith(filepath))) {
-		await indexFile(app.pages.find((p) => p.filePathRelative?.endsWith(filepath)), searchOptions, isSearchable);
-		await writeTemp(app);
-	}
+/**
+* Handle search index update when a page is modified.
+*
+* 当页面被修改时处理搜索索引更新。
+*
+* @param app - VuePress application instance / VuePress 应用实例
+* @param options - Search index preparation options / 搜索索引准备选项
+* @param options.page - VuePress page instance / VuePress 页面实例
+* @param options.isSearchable - Function to filter searchable pages / 过滤可搜索页面的函数
+* @param options.searchOptions - MiniSearch configuration / MiniSearch 配置
+*/
+async function onSearchIndexUpdated(app, { page, isSearchable, searchOptions }) {
+	if (isSearchable && !isSearchable(page)) return;
+	await indexFile(page, searchOptions, isSearchable);
+	await writeTemp(app);
 }
-async function onSearchIndexRemoved(filepath, { app, isSearchable, searchOptions }) {
-	if ((isSearchable ? app.pages.filter(isSearchable) : app.pages).some((p) => p.filePathRelative?.endsWith(filepath))) {
-		const page = app.pages.find((p) => p.filePathRelative?.endsWith(filepath));
+/**
+* Handle search index update when a page is removed.
+*
+* 当页面被删除时处理搜索索引更新。
+*
+* @param app - VuePress application instance / VuePress 应用实例
+* @param options - Search index preparation options / 搜索索引准备选项
+* @param options.page - VuePress page instance / VuePress 页面实例
+* @param options.isSearchable - Function to filter searchable pages / 过滤可搜索页面的函数
+* @param options.searchOptions - MiniSearch configuration / MiniSearch 配置
+*/
+async function onSearchIndexRemoved(app, { page, isSearchable, searchOptions }) {
+	if (isSearchable && !isSearchable(page)) return;
+	if (page.filePathRelative) {
 		const fileId = page.path;
 		const locale = page.pathLocale;
 		const lang = page.lang;
@@ -71,6 +139,19 @@ async function onSearchIndexRemoved(filepath, { app, isSearchable, searchOptions
 		await writeTemp(app);
 	}
 }
+/**
+* Write all search indexes to temporary files.
+*
+* 将所有搜索索引写入临时文件。
+*
+* Creates separate JavaScript files for each locale's search index,
+* enabling lazy loading of indexes in the client.
+*
+* 为每个语言的搜索索引创建独立的 JavaScript 文件，
+* 支持客户端延迟加载索引。
+*
+* @param app - VuePress application instance / VuePress 应用实例
+*/
 async function writeTemp(app) {
 	const records = [];
 	const promises = [];
@@ -83,6 +164,21 @@ async function writeTemp(app) {
 	promises.push(app.writeTemp(`${SEARCH_INDEX_DIR}index.js`, `export const searchIndex = {${records.join(",")}}${app.env.isDev ? `\n${genHmrCode("searchIndex")}` : ""}`));
 	await Promise.all(promises);
 }
+/**
+* Index a single page for search.
+*
+* 为单个页面建立搜索索引。
+*
+* Extracts content from the page, splits it into sections based on headings,
+* and adds each section to the appropriate locale's MiniSearch index.
+*
+* 从页面提取内容，根据标题将其分割为章节，
+* 并将每个章节添加到相应语言的 MiniSearch 索引中。
+*
+* @param page - VuePress page object / VuePress 页面对象
+* @param options - MiniSearch options / MiniSearch 选项
+* @param isSearchable - Function to check if page should be indexed / 检查页面是否应被索引的函数
+*/
 async function indexFile(page, options, isSearchable) {
 	if (!page.filePath || page.frontmatter?.search === false) return;
 	if (isSearchable && !isSearchable(page)) return;
@@ -112,11 +208,24 @@ ${page.contentRendered}`);
 		}
 	}
 }
+/** Regex pattern for matching heading tags / 匹配标题标签的正则表达式 */
 const headingRegex = /<h(\d*).*?>(<a.*? href="#.*?".*?>[\s\S]*?<\/a>)<\/h\1>/gi;
+/** Regex pattern for extracting heading content / 提取标题内容的正则表达式 */
 const headingContentRegex = /<a.*? href="#(.*?)".*?><span>([\s\S]*?)<\/span><\/a>/i;
+/** Regex pattern for ignoring template content / 忽略模板内容的正则表达式 */
 const ignoreHeadingRegex = /<template[^>]*>[\s\S]*<\/template>/gi;
 /**
-* Splits HTML into sections based on headings
+* Split HTML content into sections based on heading elements.
+*
+* 根据标题元素将 HTML 内容分割为章节。
+*
+* This generator function parses HTML content and yields section objects
+* containing anchor, titles hierarchy, and searchable text.
+*
+* 此生成器函数解析 HTML 内容并生成包含锚点、标题层级和可搜索文本的章节对象。
+*
+* @param html - HTML content to split / 要分割的 HTML 内容
+* @yields Section objects with anchor, titles, and text / 包含锚点、标题和文本的章节对象
 */
 function* splitPageIntoSections(html) {
 	const result = html.split(headingRegex);
@@ -142,14 +251,38 @@ function* splitPageIntoSections(html) {
 		};
 	}
 }
+/**
+* Extract searchable text from HTML content by removing tags.
+*
+* 通过移除标签从 HTML 内容中提取可搜索文本。
+*
+* @param content - HTML content / HTML 内容
+* @returns Plain text content / 纯文本内容
+*/
 function getSearchableText(content) {
 	content = clearHtmlTags(content);
 	return content;
 }
+/**
+* Remove all HTML tags from a string.
+*
+* 移除字符串中的所有 HTML 标签。
+*
+* @param str - String containing HTML / 包含 HTML 的字符串
+* @returns String with HTML tags removed / 移除 HTML 标签后的字符串
+*/
 function clearHtmlTags(str) {
 	str = str.replace(ignoreHeadingRegex, "");
 	return str.replace(/<[^>]*>/g, "");
 }
+/**
+* Generate HMR (Hot Module Replacement) code for the search index.
+*
+* 为搜索索引生成 HMR（热模块替换）代码。
+*
+* @param m - Module name / 模块名称
+* @returns HMR code string / HMR 代码字符串
+*/
 function genHmrCode(m) {
 	const func = `update${m[0].toUpperCase()}${m.slice(1)}`;
 	return `
@@ -167,153 +300,162 @@ if (import.meta.hot) {
 }
 `;
 }
-
-//#endregion
-//#region src/node/locales/de.ts
-const deSearchLocale = {
-	placeholder: "Dokumente durchsuchen",
-	resetButtonTitle: "Suche zurücksetzen",
-	backButtonTitle: "Schließen",
-	noResultsText: "Keine Suchergebnisse:",
-	footer: {
-		selectText: "Auswählen",
-		selectKeyAriaLabel: "Eingabe",
-		navigateText: "Wechseln",
-		navigateUpKeyAriaLabel: "Nach oben",
-		navigateDownKeyAriaLabel: "Nach unten",
-		closeText: "Schließen",
-		closeKeyAriaLabel: "Beenden"
-	}
-};
-
-//#endregion
-//#region src/node/locales/en.ts
-const enSearchLocale = {
-	placeholder: "Search",
-	resetButtonTitle: "Reset search",
-	backButtonTitle: "Close search",
-	noResultsText: "No results for",
-	footer: {
-		selectText: "to select",
-		selectKeyAriaLabel: "enter",
-		navigateText: "to navigate",
-		navigateUpKeyAriaLabel: "up arrow",
-		navigateDownKeyAriaLabel: "down arrow",
-		closeText: "to close",
-		closeKeyAriaLabel: "escape"
-	}
-};
-
-//#endregion
-//#region src/node/locales/fr.ts
-const frSearchLocale = {
-	placeholder: "Rechercher dans la documentation",
-	resetButtonTitle: "Réinitialiser la recherche",
-	backButtonTitle: "Fermer",
-	noResultsText: "Aucun résultat trouvé :",
-	footer: {
-		selectText: "sélectionner",
-		selectKeyAriaLabel: "Entrée",
-		navigateText: "naviguer",
-		navigateUpKeyAriaLabel: "haut",
-		navigateDownKeyAriaLabel: "bas",
-		closeText: "fermer",
-		closeKeyAriaLabel: "sortie"
-	}
-};
-
-//#endregion
-//#region src/node/locales/ja.ts
-const jaSearchLocale = {
-	placeholder: "ドキュメントを検索",
-	resetButtonTitle: "検索をリセット",
-	backButtonTitle: "閉じる",
-	noResultsText: "検索結果がありません：",
-	footer: {
-		selectText: "選択",
-		selectKeyAriaLabel: "入力",
-		navigateText: "切り替え",
-		navigateUpKeyAriaLabel: "上へ",
-		navigateDownKeyAriaLabel: "下へ",
-		closeText: "閉じる",
-		closeKeyAriaLabel: "終了"
-	}
-};
-
-//#endregion
-//#region src/node/locales/ru.ts
-const ruSearchLocale = {
-	placeholder: "Поиск по документации",
-	resetButtonTitle: "Сбросить поиск",
-	backButtonTitle: "Закрыть",
-	noResultsText: "Нет результатов поиска:",
-	footer: {
-		selectText: "Выбрать",
-		selectKeyAriaLabel: "Ввод",
-		navigateText: "Переключить",
-		navigateUpKeyAriaLabel: "Вверх",
-		navigateDownKeyAriaLabel: "Вниз",
-		closeText: "Закрыть",
-		closeKeyAriaLabel: "Выход"
-	}
-};
-
-//#endregion
-//#region src/node/locales/zh-tw.ts
-const zhTwSearchLocale = {
-	placeholder: "搜尋文件",
-	resetButtonTitle: "重設搜尋",
-	backButtonTitle: "關閉",
-	noResultsText: "無搜尋結果：",
-	footer: {
-		selectText: "選擇",
-		selectKeyAriaLabel: "輸入",
-		navigateText: "切換",
-		navigateUpKeyAriaLabel: "向上",
-		navigateDownKeyAriaLabel: "向下",
-		closeText: "關閉",
-		closeKeyAriaLabel: "退出"
-	}
-};
-
-//#endregion
-//#region src/node/locales/zh.ts
-const zhSearchLocale = {
-	placeholder: "搜索文档",
-	resetButtonTitle: "重置搜索",
-	backButtonTitle: "关闭",
-	noResultsText: "无搜索结果：",
-	footer: {
-		selectText: "选择",
-		selectKeyAriaLabel: "输入",
-		navigateText: "切换",
-		navigateUpKeyAriaLabel: "向上",
-		navigateDownKeyAriaLabel: "向下",
-		closeText: "关闭",
-		closeKeyAriaLabel: "退出"
-	}
-};
-
 //#endregion
 //#region src/node/locales/index.ts
+/**
+* Default locale configurations for search plugin.
+*
+* 搜索插件的默认语言配置。
+*
+* Maps language codes to their respective locale strings.
+*
+* 将语言代码映射到相应的本地化字符串。
+*/
 const SEARCH_LOCALES = [
-	[["en", "en-US"], enSearchLocale],
+	[["en", "en-US"], {
+		placeholder: "Search",
+		resetButtonTitle: "Reset search",
+		backButtonTitle: "Close search",
+		noResultsText: "No results for",
+		footer: {
+			selectText: "to select",
+			selectKeyAriaLabel: "enter",
+			navigateText: "to navigate",
+			navigateUpKeyAriaLabel: "up arrow",
+			navigateDownKeyAriaLabel: "down arrow",
+			closeText: "to close",
+			closeKeyAriaLabel: "escape"
+		}
+	}],
 	[[
 		"zh",
 		"zh-CN",
 		"zh-Hans",
 		"zh-Hant"
-	], zhSearchLocale],
-	[["zh-TW"], zhTwSearchLocale],
-	[["de", "de-DE"], deSearchLocale],
-	[["fr", "fr-FR"], frSearchLocale],
-	[["ru", "ru-RU"], ruSearchLocale],
-	[["ja", "ja-JP"], jaSearchLocale]
+	], {
+		placeholder: "搜索文档",
+		resetButtonTitle: "重置搜索",
+		backButtonTitle: "关闭",
+		noResultsText: "无搜索结果：",
+		footer: {
+			selectText: "选择",
+			selectKeyAriaLabel: "输入",
+			navigateText: "切换",
+			navigateUpKeyAriaLabel: "向上",
+			navigateDownKeyAriaLabel: "向下",
+			closeText: "关闭",
+			closeKeyAriaLabel: "退出"
+		}
+	}],
+	[["zh-TW"], {
+		placeholder: "搜尋文件",
+		resetButtonTitle: "重設搜尋",
+		backButtonTitle: "關閉",
+		noResultsText: "無搜尋結果：",
+		footer: {
+			selectText: "選擇",
+			selectKeyAriaLabel: "輸入",
+			navigateText: "切換",
+			navigateUpKeyAriaLabel: "向上",
+			navigateDownKeyAriaLabel: "向下",
+			closeText: "關閉",
+			closeKeyAriaLabel: "退出"
+		}
+	}],
+	[["de", "de-DE"], {
+		placeholder: "Dokumente durchsuchen",
+		resetButtonTitle: "Suche zurücksetzen",
+		backButtonTitle: "Schließen",
+		noResultsText: "Keine Suchergebnisse:",
+		footer: {
+			selectText: "Auswählen",
+			selectKeyAriaLabel: "Eingabe",
+			navigateText: "Wechseln",
+			navigateUpKeyAriaLabel: "Nach oben",
+			navigateDownKeyAriaLabel: "Nach unten",
+			closeText: "Schließen",
+			closeKeyAriaLabel: "Beenden"
+		}
+	}],
+	[["fr", "fr-FR"], {
+		placeholder: "Rechercher dans la documentation",
+		resetButtonTitle: "Réinitialiser la recherche",
+		backButtonTitle: "Fermer",
+		noResultsText: "Aucun résultat trouvé :",
+		footer: {
+			selectText: "sélectionner",
+			selectKeyAriaLabel: "Entrée",
+			navigateText: "naviguer",
+			navigateUpKeyAriaLabel: "haut",
+			navigateDownKeyAriaLabel: "bas",
+			closeText: "fermer",
+			closeKeyAriaLabel: "sortie"
+		}
+	}],
+	[["ru", "ru-RU"], {
+		placeholder: "Поиск по документации",
+		resetButtonTitle: "Сбросить поиск",
+		backButtonTitle: "Закрыть",
+		noResultsText: "Нет результатов поиска:",
+		footer: {
+			selectText: "Выбрать",
+			selectKeyAriaLabel: "Ввод",
+			navigateText: "Переключить",
+			navigateUpKeyAriaLabel: "Вверх",
+			navigateDownKeyAriaLabel: "Вниз",
+			closeText: "Закрыть",
+			closeKeyAriaLabel: "Выход"
+		}
+	}],
+	[["ja", "ja-JP"], {
+		placeholder: "ドキュメントを検索",
+		resetButtonTitle: "検索をリセット",
+		backButtonTitle: "閉じる",
+		noResultsText: "検索結果がありません：",
+		footer: {
+			selectText: "選択",
+			selectKeyAriaLabel: "入力",
+			navigateText: "切り替え",
+			navigateUpKeyAriaLabel: "上へ",
+			navigateDownKeyAriaLabel: "下へ",
+			closeText: "閉じる",
+			closeKeyAriaLabel: "終了"
+		}
+	}]
 ];
-
 //#endregion
 //#region src/node/searchPlugin.ts
 const __dirname = getDirname(import.meta.url);
+/**
+* Create a VuePress search plugin instance.
+*
+* 创建 VuePress 搜索插件实例。
+*
+* @param options - Plugin configuration options / 插件配置选项
+* @param options.locales - Locale-specific search configurations / 特定语言的搜索配置
+* @param options.isSearchable - Function to determine if a page should be indexed / 判断页面是否应被索引的函数
+* @param options.searchOptions - MiniSearch options / MiniSearch 配置选项
+* @returns VuePress plugin object / VuePress 插件对象
+* @example
+* // Basic usage
+* export default {
+*   plugins: [
+*     searchPlugin()
+*   ]
+* }
+*
+* // With custom options
+* export default {
+*   plugins: [
+*     searchPlugin({
+*       locales: {
+*         '/zh/': { placeholder: '搜索文档' }
+*       },
+*       isSearchable: (page) => page.path !== '/secret/'
+*     })
+*   ]
+* }
+*/
 function searchPlugin({ locales = {}, isSearchable, ...searchOptions } = {}) {
 	return (app) => ({
 		name: "@vuepress-plume/plugin-search",
@@ -349,37 +491,20 @@ function searchPlugin({ locales = {}, isSearchable, ...searchOptions } = {}) {
 				});
 			}
 		},
-		onWatched: (app, watchers) => {
-			const searchIndexWatcher = chokidar.watch("pages", {
-				cwd: app.dir.temp(),
-				ignoreInitial: true,
-				ignored: (filepath, stats) => Boolean(stats?.isFile()) && !filepath.endsWith(".js")
-			});
-			searchIndexWatcher.on("add", (filepath) => {
-				onSearchIndexUpdated(filepath, {
-					app,
-					isSearchable,
-					searchOptions
-				});
-			});
-			searchIndexWatcher.on("change", (filepath) => {
-				onSearchIndexUpdated(filepath, {
-					app,
-					isSearchable,
-					searchOptions
-				});
+		onPageUpdated: async (app, type, page) => {
+			if (!page?.filePathRelative) return;
+			if (type === "create" || type === "update") await onSearchIndexUpdated(app, {
+				page,
+				isSearchable,
+				searchOptions
 			});
-			searchIndexWatcher.on("unlink", (filepath) => {
-				onSearchIndexRemoved(filepath, {
-					app,
-					isSearchable,
-					searchOptions
-				});
+			else if (type === "delete") await onSearchIndexRemoved(app, {
+				page,
+				isSearchable,
+				searchOptions
 			});
-			watchers.push(searchIndexWatcher);
 		}
 	});
 }
-
 //#endregion
-export { prepareSearchIndex, searchPlugin };
+export { prepareSearchIndex, searchPlugin };

package/lib/shared/index.d.ts

@@ -2,38 +2,90 @@ import { Options } from "minisearch";
 import { LocaleConfig, Page } from "vuepress/core";
 
 //#region src/shared/index.d.ts
+/**
+ * Locale options for search UI strings.
+ *
+ * 搜索 UI 字符串的语言选项。
+ */
 interface SearchLocaleOptions {
+  /** Placeholder text for search input / 搜索输入框的占位文本 */
   placeholder: string;
+  /** Text for search button / 搜索按钮的文本 */
   buttonText: string;
+  /** Title for reset button / 重置按钮的标题 */
   resetButtonTitle: string;
+  /** Title for back/close button / 返回/关闭按钮的标题 */
   backButtonTitle: string;
+  /** Text shown when no results found / 无搜索结果时显示的文本 */
   noResultsText: string;
+  /** Footer keyboard shortcut hints / 底部键盘快捷键提示 */
   footer: {
-    selectText: string;
-    selectKeyAriaLabel: string;
-    navigateText: string;
-    navigateUpKeyAriaLabel: string;
-    navigateDownKeyAriaLabel: string;
-    closeText: string;
+    /** Text for select action / 选择操作的文本 */selectText: string; /** ARIA label for select key / 选择键的 ARIA 标签 */
+    selectKeyAriaLabel: string; /** Text for navigate action / 导航操作的文本 */
+    navigateText: string; /** ARIA label for navigate up key / 向上导航键的 ARIA 标签 */
+    navigateUpKeyAriaLabel: string; /** ARIA label for navigate down key / 向下导航键的 ARIA 标签 */
+    navigateDownKeyAriaLabel: string; /** Text for close action / 关闭操作的文本 */
+    closeText: string; /** ARIA label for close key / 关闭键的 ARIA 标签 */
     closeKeyAriaLabel: string;
   };
 }
+/**
+ * Locale configuration type for search box.
+ *
+ * 搜索框的语言配置类型。
+ */
 type SearchBoxLocales = LocaleConfig<SearchLocaleOptions>;
+/**
+ * Options for the search plugin.
+ *
+ * 搜索插件的选项。
+ */
 interface SearchPluginOptions extends SearchOptions {
+  /** Locale-specific search configurations / 特定语言的搜索配置 */
   locales?: SearchBoxLocales;
+  /**
+   * Function to determine if a page should be indexed.
+   *
+   * 判断页面是否应被索引的函数。
+   *
+   * @param page - VuePress page object / VuePress 页面对象
+   * @returns Whether the page should be searchable / 页面是否可搜索
+   */
   isSearchable?: (page: Page) => boolean;
 }
+/**
+ * Search configuration options.
+ *
+ * 搜索配置选项。
+ */
 interface SearchOptions {
   /**
+   * Whether to disable query persistence in session storage.
+   *
+   * 是否禁用会话存储中的查询持久化。
+   *
    * @default false
    */
   disableQueryPersistence?: boolean;
+  /**
+   * MiniSearch configuration options.
+   *
+   * MiniSearch 配置选项。
+   */
   miniSearch?: {
     /**
+     * MiniSearch instance options.
+     *
+     * MiniSearch 实例选项。
+     *
      * @see https://lucaong.github.io/minisearch/modules/_minisearch_.html#options
      */
     options?: Pick<Options, 'extractField' | 'tokenize' | 'processTerm'>;
     /**
+     * MiniSearch search options.
+     *
+     * MiniSearch 搜索选项。
+     *
      * @see https://lucaong.github.io/minisearch/modules/_minisearch_.html#searchoptions-1
      */
     searchOptions?: Options['searchOptions'];

package/lib/shared/index.js

@@ -1 +1 @@
-export {  };
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vuepress-plume/plugin-search",
   "type": "module",
-  "version": "1.0.0-rc.192",
+  "version": "1.0.0-rc.193",
   "description": "The Plugin for VuePress 2 - local search",
   "author": "pengzhanbo <volodymyr@foxmail.com>",
   "license": "MIT",
@@ -31,18 +31,18 @@
     "lib"
   ],
   "peerDependencies": {
-    "vuepress": "2.0.0-rc.26"
+    "vuepress": "2.0.0-rc.28"
   },
   "dependencies": {
-    "@vuepress/helper": "2.0.0-rc.123",
+    "@vuepress/helper": "2.0.0-rc.128",
     "@vueuse/core": "^14.2.1",
     "@vueuse/integrations": "^14.2.1",
     "chokidar": "5.0.0",
-    "focus-trap": "^8.0.0",
+    "focus-trap": "^8.0.1",
     "mark.js": "^8.11.1",
     "minisearch": "^7.2.0",
     "p-map": "^7.0.4",
-    "vue": "^3.5.29"
+    "vue": "^3.5.31"
   },
   "publishConfig": {
     "access": "public",
@@ -58,6 +58,6 @@
     "build": "pnpm run tsdown && pnpm run copy",
     "clean": "rimraf --glob ./lib",
     "copy": "cpx \"src/**/*.{d.ts,vue,css,scss,jpg,png}\" lib",
-    "tsdown": "tsdown"
+    "tsdown": "tsdown --config-loader unrun"
   }
 }