Chore: use vitepress instead of vuepress as site builder (#485)

* Chore: use vitepress instead of vuepress as site builder

* fix test

* fix

Author: ota-meshi

.eslintignore

@@ -1,11 +1,11 @@
 /.nyc_output
 /coverage
 /dist
-/docs/.vuepress/dist
-/docs/.vuepress/components/demo/demo-code.js
+/docs/.vitepress/dist
+/docs/.vitepress/build-system/shim/eslint.mjs
 /node_modules
 /assets
-!/docs/.vuepress
+!/docs/.vitepress
 !/.vscode
 !/.github
 /tests/fixtures/integrations/eslint-plugin/test.js

.eslintrc.js

@@ -84,25 +84,34 @@ module.exports = {
         },
         {
             files: ["*.vue"],
-            extends: ["plugin:@ota-meshi/+vue2", "plugin:@ota-meshi/+prettier"],
+            extends: ["plugin:@ota-meshi/+vue3", "plugin:@ota-meshi/+prettier"],
             parserOptions: {
                 sourceType: "module",
             },
             globals: {
                 require: true,
             },
+            rules: {
+                "vue/multi-word-component-names": "off",
+                "@typescript-eslint/no-explicit-any": "off",
+            },
         },
         {
-            files: ["docs/.vuepress/**"],
+            files: ["docs/.vitepress/**"],
             parserOptions: {
                 sourceType: "module",
                 ecmaVersion: 2020,
             },
             globals: {
                 window: true,
+                require: true,
             },
             rules: {
                 "require-jsdoc": "off",
+                "node/file-extension-in-import": "off",
+                "node/no-extraneous-import": "off",
+                "node/no-unsupported-features/es-syntax": "off",
+                "@typescript-eslint/no-explicit-any": "off",
             },
         },
     ],

.github/workflows/GHPages.yml

@@ -32,14 +32,13 @@ jobs:
               run: npm ci
             - name: Build docs
               run: |+
-                  export NODE_OPTIONS=--openssl-legacy-provider
                   npm run docs:build
             - name: Setup Pages
               uses: actions/configure-pages@v2
             - name: Upload artifact
               uses: actions/upload-pages-artifact@v1
               with:
-                  path: ./docs/.vuepress/dist
+                  path: ./docs/.vitepress/dist/eslint-plugin-regexp
             - name: Deploy to GitHub Pages
               id: deployment
               uses: actions/deploy-pages@v1

.gitignore

@@ -88,8 +88,8 @@ dist
 # https://nextjs.org/blog/next-9-1#public-directory-support
 # public
 
-# vuepress build output
-.vuepress/dist
+# vitepress build output
+.vitepress/dist
 
 # Serverless directories
 .serverless/
@@ -102,3 +102,6 @@ dist
 
 # TernJS port file
 .tern-port
+
+## Repo
+docs/.vitepress/build-system/shim/eslint.mjs

CONTRIBUTING.md

@@ -69,7 +69,7 @@ The following steps will walk you through the process of creating a new rule.
 
     The documentation should contain a description of the rule and the problem it detects/solves, examples, all features, all options, and any additional information relevant to the rule.
 
-    You can view the documentation live in your browser by running `npm run build && npm run docs:watch`. The live view will automatically update when you make changes to the documentation. However, you have to re-run the command to see changes to the rule implementation.
+    You can view the documentation live in your browser by running `npm run docs:watch`. The live view will automatically update when you make changes to the documentation. However, you have to re-load the browser to see changes to the rule implementation.
 
 
 ### Updating documentation
@@ -78,9 +78,9 @@ Almost all Markdown files of our website and the project `README.md` are partial
 
 The following files are completely generated and must not be modified directly:
 
-- `docs/README.md` - change this section of the project `README.md` instead.
-- `docs/rules/README.md`
-- `docs/user-guide/README.md` - change this section of the project `README.md` instead.
+- `docs/index.md` - change this section of the project `README.md` instead.
+- `docs/rules/index.md`
+- `docs/user-guide/index.md` - change this section of the project `README.md` instead.
 
 The following files are partially generated:
 
@@ -98,7 +98,7 @@ You can view changes to the website locally by running `npm run docs:watch`.
 
 Aside from `npm test`, there are also a few other ways to manually test new features, changes, and new rules.
 
-1.  `npm run build && npm run docs:watch`:
+1.  `npm run docs:watch`:
 
     The documentation page of each rule includes interactive examples. You can also use your local version of [the playground](https://ota-meshi.github.io/eslint-plugin-regexp/playground/) to for testing.
 

README.md

@@ -2,6 +2,8 @@
 
 [eslint-plugin-regexp](https://www.npmjs.com/package/eslint-plugin-regexp) is ESLint plugin for finding RegExp mistakes and RegExp style guide violations.
 
+<!--PACKAGE_STATUS_START-->
+
 [![NPM license](https://img.shields.io/npm/l/eslint-plugin-regexp.svg)](https://www.npmjs.com/package/eslint-plugin-regexp)
 [![NPM version](https://img.shields.io/npm/v/eslint-plugin-regexp.svg)](https://www.npmjs.com/package/eslint-plugin-regexp)
 [![NPM downloads](https://img.shields.io/badge/dynamic/json.svg?label=downloads&colorB=green&suffix=/day&query=$.downloads&uri=https://api.npmjs.org//downloads/point/last-day/eslint-plugin-regexp&maxAge=3600)](http://www.npmtrends.com/eslint-plugin-regexp)
@@ -12,6 +14,8 @@
 [![Build Status](https://github.com/ota-meshi/eslint-plugin-regexp/workflows/CI/badge.svg?branch=master)](https://github.com/ota-meshi/eslint-plugin-regexp/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/ota-meshi/eslint-plugin-regexp/badge.svg?branch=master)](https://coveralls.io/github/ota-meshi/eslint-plugin-regexp?branch=master)
 
+<!--PACKAGE_STATUS_END-->
+
 ## :name_badge: Features
 
 This ESLint plugin provides linting rules relate to better ways to help you avoid problems when using RegExp.

docs/.vitepress/build-system/build.ts

@@ -0,0 +1,65 @@
+/**
+ * Pre-build cjs packages that cannot be bundled well.
+ */
+
+import esbuild from "esbuild"
+import path from "path"
+import fs from "fs"
+import { fileURLToPath } from "url"
+
+const dirname = path.dirname(
+    fileURLToPath(
+        // @ts-expect-error -- Cannot change `module` option
+        import.meta.url,
+    ),
+)
+
+build(
+    path.join(dirname, "./src/eslint.mjs"),
+    path.join(dirname, "./shim/eslint.mjs"),
+    ["path", "assert", "util"],
+)
+
+/** build */
+function build(input: string, out: string, injects: string[] = []) {
+    // eslint-disable-next-line no-console -- ignore
+    console.log(`build@ ${input}`)
+    let code = bundle(input, injects)
+    code = transform(code, injects)
+    fs.mkdirSync(path.dirname(out), { recursive: true })
+    fs.writeFileSync(out, code, "utf8")
+}
+
+/** bundle */
+function bundle(entryPoint: string, externals: string[]) {
+    const result = esbuild.buildSync({
+        entryPoints: [entryPoint],
+        format: "esm",
+        bundle: true,
+        external: externals,
+        write: false,
+        inject: [path.join(dirname, "./src/process-shim.mjs")],
+    })
+
+    return `${result.outputFiles[0].text}`
+}
+
+/** transform code */
+function transform(code: string, injects: string[]) {
+    const newCode = code.replace(/"[a-z]+" = "[a-z]+";/u, "")
+    return `
+${injects
+    .map(
+        (inject) =>
+            `import $inject_${inject.replace(/-/gu, "_")}$ from '${inject}';`,
+    )
+    .join("\n")}
+const $_injects_$ = {${injects
+        .map((inject) => `${inject.replace(/-/gu, "_")}:$inject_${inject}$`)
+        .join(",\n")}};
+function require(module, ...args) {
+  return $_injects_$[module] || {}
+}
+${newCode}
+`
+}

docs/.vitepress/build-system/shim/path.mjs

@@ -0,0 +1,6 @@
+export const sep = "/"
+const posix = {
+    sep,
+}
+posix.posix = posix
+export default posix

docs/.vitepress/build-system/src/eslint.mjs

@@ -0,0 +1,4 @@
+import * as all from "../../../../node_modules/eslint/lib/linter/linter.js"
+const Linter = all.Linter
+export { Linter }
+export default { Linter }

docs/.vitepress/build-system/src/process-shim.mjs

@@ -0,0 +1,8 @@
+export let process = {
+    env: {},
+    cwd: () => "",
+    stdout: {},
+}
+if (typeof window !== "undefined") {
+    window.process = process
+}