chore(docs): use vitepress (#114)

Author: ota-meshi

.eslintignore

@@ -1,5 +1,6 @@
-!.vuepress
+!.vitepress
 
 /coverage
-/docs/.vuepress/dist
+/docs/.vitepress/dist
+/docs/.vitepress/cache
 /node_modules

.github/workflows/GHPages.yml

@@ -35,7 +35,6 @@ jobs:
 
       - name: Build docs
         run: |+
-          export NODE_OPTIONS=--openssl-legacy-provider
           npm run docs:build
 
       - name: Setup Pages
@@ -44,7 +43,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          path: ./docs/.vuepress/dist
+          path: ./docs/.vitepress/dist/eslint-plugin-eslint-comments
 
       - name: Deploy to GitHub Pages
         id: deployment

.gitignore

@@ -1,7 +1,8 @@
 /.nyc_output
 /.vscode
 /coverage
-/docs/.vuepress/dist
+/docs/.vitepress/dist
+/docs/.vitepress/cache
 /node_modules
 /npm-debug.log
 /test.js

docs/.vitepress/.eslintrc.js

@@ -0,0 +1,26 @@
+"use strict"
+
+module.exports = {
+    rules: {
+        "n/no-missing-import": "off",
+        "n/no-extraneous-import": "off",
+        "n/file-extension-in-import": "off",
+        "n/no-extraneous-require": "off",
+    },
+    globals: {
+        window: "readonly",
+        document: "readonly",
+    },
+    overrides: [
+        {
+            files: ["*.vue"],
+            rules: {
+                "vue/multiline-html-element-content-newline": "off",
+                "vue/singleline-html-element-content-newline": "off",
+                "vue/name-property-casing": "off",
+                "vue/html-self-closing": "off",
+                "vue/comma-dangle": "off",
+            },
+        },
+    ],
+}

docs/.vitepress/config.mjs

@@ -0,0 +1,74 @@
+import { defineConfig } from "vitepress"
+import path from "path"
+import { fileURLToPath } from "url"
+import { vitePluginGetLinter, viteCommonjs } from "./vite-plugin.mjs"
+import eslint4b from "vite-plugin-eslint4b"
+import { createRequire } from "module"
+
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = path.dirname(__filename)
+const require = createRequire(import.meta.url)
+
+const { withCategories } = require("../../scripts/lib/rules")
+require("../../scripts/update-docs-headers")
+require("../../scripts/update-docs-index")
+
+export default defineConfig({
+    title: "eslint-plugin-eslint-comments",
+    base: "/eslint-plugin-eslint-comments/",
+    description: "Additional ESLint rules for ESLint directive comments.",
+    head: [["link", { rel: "icon", href: "/favicon.png" }]],
+
+    outDir: path.resolve(__dirname, "./dist/eslint-plugin-eslint-comments"),
+    vite: {
+        publicDir: path.resolve(__dirname, "./public"),
+        plugins: [eslint4b(), vitePluginGetLinter(), viteCommonjs()],
+        define: {
+            MONACO_EDITOR_VERSION: JSON.stringify(
+                require("monaco-editor/package.json").version
+            ),
+        },
+    },
+
+    lastUpdated: true,
+    themeConfig: {
+        search: {
+            provider: "local",
+            options: {
+                detailedView: true,
+            },
+        },
+        editLink: {
+            pattern:
+                "https://github.com/eslint-community/eslint-plugin-eslint-comments/edit/main/docs/:path",
+        },
+        socialLinks: [
+            {
+                icon: "github",
+                link: "https://github.com/eslint-community/eslint-plugin-eslint-comments",
+            },
+        ],
+
+        nav: [
+            { text: "Guide", link: "/" },
+            { text: "Rules", link: "/rules/" },
+        ],
+
+        sidebar: [
+            {
+                items: [
+                    { text: "Guide", link: "/" },
+                    { text: "Available Rules", link: "/rules/" },
+                ],
+            },
+            ...withCategories.map(({ category, rules }) => ({
+                text: `Rules in ${category}`,
+                collapsable: false,
+                items: rules.map((rule) => ({
+                    text: `eslint-comments/${rule.name}`,
+                    link: `/rules/${rule.name}`,
+                })),
+            })),
+        ],
+    },
+})