添加组件文档索引插件

docs/global.d.ts

@@ -1,4 +1,5 @@
 import {BundledLanguage} from 'shiki'
+import type {Component} from 'vue'
 
 declare global {
 
@@ -17,6 +18,20 @@ declare global {
         export default src
     }
 
+    declare module 'indexes~' {
+        import type {Component} from 'vue'
+
+        interface Page {
+            name: string
+            path: string
+            component: () => Promise<{ default: Component }>
+        }
+
+        const components: Page[]
+        export default components
+
+        export {}
+    }
 }
 
 export {}

docs/package.json

@@ -5,9 +5,8 @@
   "author": "Yin-Jinlong",
   "type": "module",
   "scripts": {
-    "dev": "pnpm run gen:components-indexes && vite",
-    "build": "pnpm run gen:components-indexes && vite build",
-    "gen:components-indexes": "esno gen-components-indexes.ts",
+    "dev": "vite",
+    "build": "vite build",
     "serve": "vite preview"
   },
   "license": "LGPL-3.0-or-later",

docs/src/App.vue

@@ -68,7 +68,8 @@ import {HButton, vLoading} from '@yin-jinlong/h-ui'
 
 import {PageHeader, SideBar} from '@components'
 
-import components from '../components-indexes'
+// @ts-ignore
+import components from 'indexes~'
 
 const app = shallowRef<Component | null>()
 const loading = shallowRef(false)

docs/src/plugin/index.ts

@@ -0,0 +1 @@
+export * from './indexes'

docs/src/plugin/indexes.ts

@@ -0,0 +1,41 @@
+import fs from 'fs'
+
+import {Plugin} from 'vite'
+
+export declare interface IndexesOptions {
+    dir?: string
+}
+
+function genIndexes(dir: string): string {
+    let pages = ''
+    fs.readdirSync(dir, {
+        withFileTypes: true
+    }).forEach((dir) => {
+        if (dir.isDirectory()) {
+            let name = dir.name
+            pages += `{
+   name: '${name}',
+   path: '/${name}',
+   component: () => import('./components/${name}')
+},`
+        }
+    })
+    return pages
+}
+
+export function indexesPlugin(options?: IndexesOptions): Plugin {
+    return {
+        enforce: 'pre',
+        name: 'gen-indexes',
+        resolveId(source) {
+            if (source.endsWith('~')) {
+                return source
+            }
+        },
+        load(id) {
+            if (id !== 'indexes~')
+                return
+            return `export default [${genIndexes(options?.dir ?? 'components')}]`
+        }
+    }
+}

docs/vite.config.ts

@@ -5,6 +5,8 @@ import {visualizer} from 'rollup-plugin-visualizer'
 import vue from '@vitejs/plugin-vue'
 import viteCompression from 'vite-plugin-compression'
 
+import {indexesPlugin} from './src/plugin'
+
 function getSuffix(name: string) {
     const i = name.lastIndexOf('.')
     return i >= 0 ? name.substring(i + 1) : name
@@ -61,6 +63,7 @@ export default defineConfig((env) => {
             entries: ['@yin-jinlong/h-ui']
         },
         plugins: [
+            indexesPlugin(),
             vue({
                 isProduction: prod
             }),