new version

Author: gspgsp

README.md

@@ -1 +1,23 @@
-# vuepress-search-plugin
+#### VuePress v2 Full-text Search Plugin
+
+##### Overview
+
+This plugin provides full-text search functionality for **VuePress v2**. It is designed to address the search needs of VuePress sites, offering a fast and efficient way to search through the content of your site. The plugin automatically generates a search index from your site's pages and provides a simple way for users to search through the content.
+
+This plugin is built to work with the latest version of VuePress, but also maintains backward compatibility for VuePress versions up to **v2.0.0-beta.43**. It ensures smooth transitions for users upgrading their VuePress projects.
+
+##### Features
+
+- **Full-text Search**: Automatically generates a search index for your pages, allowing users to search through the text content of your site.
+- **VuePress v2 Compatibility**: Designed specifically for VuePress v2, ensuring full integration with the latest features and updates.
+- **HMR Support**: Includes Hot Module Replacement (HMR) code to allow live updates of the search index during development.
+- **Search Index Generation**: A script that generates the search index by extracting relevant data from your site's pages.
+
+##### Installation
+
+To install the plugin, follow these steps:
+
+1. **Install the plugin** via npm:
+
+   ```bash
+   npm install vuepress-serach-plugin --save

eslint.config.mjs

@@ -9,9 +9,6 @@ export default [
       "**/node_modules",
       "tests/fixtures/**/*.json",
       "!playground/docs/.vuepress",
-      "playground/docs/.vuepress/.temp",
-      "playground/docs/.vuepress/.cache",
-      "playground/docs/.vuepress/dist",
     ],
   },
   {
@@ -73,14 +70,4 @@ export default [
       "@typescript-eslint/no-misused-promises": "off",
     },
   },
-  {
-    files: ["playground/**/*.js"],
-
-    rules: {
-      "n/no-missing-import": "off",
-      "n/no-unpublished-import": "off",
-      "n/no-missing-require": "off",
-      "n/no-unpublished-require": "off",
-    },
-  },
 ];

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vuepress-serach-plugin",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "a plugin for vuepress2 search.",
   "files": [
     "lib"
@@ -37,9 +37,7 @@
   },
   "keywords": [
     "vuepress",
-    "vuepress-plugin",
-    "full-text-search",
-    "vuepress-next"
+    "vuepress-plugin"
   ],
   "author": "gspgsp",
   "license": "MIT",
@@ -56,7 +54,6 @@
     "vuepress": "^2.0.0-rc.18"
   },
   "devDependencies": {
-    "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
     "@types/chai": "^4.2.22",
     "@types/mocha": "^10.0.0",
     "@types/node": "^22.0.0",
@@ -66,14 +63,8 @@
     "cpx2": "^8.0.0",
     "eslint": "^9.6.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jsdoc": "^50.0.0",
-    "eslint-plugin-json-schema-validator": "^5.0.0",
-    "eslint-plugin-jsonc": "^2.0.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-node-dependencies": "^0.12.0",
     "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-regexp": "^2.0.0",
-    "eslint-plugin-vue": "^9.0.0",
     "mocha": "^10.0.0",
     "mocha-chai-jest-snapshot": "^1.1.3",
     "nyc": "^17.0.0",
@@ -83,8 +74,6 @@
     "tsconfig-vuepress": "^5.0.0",
     "tsup": "^8.0.0",
     "typescript": "~5.6.0",
-    "typescript-eslint": "^8.0.0",
-    "vue-eslint-parser": "^9.0.0",
     "vuepress": "^2.0.0-rc.18"
   }
 }

src/client/engine.ts

@@ -2,7 +2,7 @@ import {
   searchIndex as searchIndexRaw,
   UPD_NAME,
   // @ts-expect-error -- generated from prepare-search-index
-} from "@internal/vuepress-plugin-full-text-search2-search-index";
+} from "@internal/vuepress-search-plugin-index";
 import { computed, ref, watch } from "vue";
 import type { Ref } from "vue";
 import type { PageContent, PageIndex } from "../types";

src/index.ts

@@ -29,7 +29,7 @@ function fullTextSearchPluginFunction(
   options: FullTextSearchPluginOptions | App = {},
 ): PluginObject {
   return {
-    name: "vuepress-plugin-full-text-search2",
+    name: "vuepress-search-plugin",
 
     define: {
       __SEARCH_LOCALES__: ("locales" in options ? options?.locales : {}) ?? {},

src/prepare-search-index.ts

@@ -46,7 +46,7 @@ export async function prepareSearchIndex({
   // search index file content
   let content = `
 export const searchIndex = ${JSON.stringify(searchIndex, null, 2)}
-export const UPD_NAME = 'update-vuepress-plugin-full-text-search2-search-index'
+export const UPD_NAME = 'update-vuepress-search-plugin-index'
 `;
 
   // inject HMR code
@@ -55,7 +55,7 @@ export const UPD_NAME = 'update-vuepress-plugin-full-text-search2-search-index'
   }
 
   return app.writeTemp(
-    "internal/vuepress-plugin-full-text-search2-search-index.js",
+    "internal/vuepress-search-plugin-index.js",
     content,
   );
 }