banboshi_V2/HalftoneWeb/node_modules/vite-plugin-use-modules

vite-plugin-use-modules

自动加载 modules

Usage 🦕

install

1. 安装包

npm i vite-plugin-use-modules -D

2. 注册插件

// vite.config.js or vite.config.ts
import { defineConfig } from 'vite'
import Modules from 'vite-plugin-use-modules'

export default defineConfig({
	plugins: [Modules()]
})

basic

1. 获取所有模块

import { modules } from 'virtual:modules'

console.log(modules) // src/modules 的所有模块都会被获取到

2. 使用 src/modules 下的默认导出函数

// eg: src/modules/router.ts
import { createRouter, createWebHistory } from 'vue-router'

const router = createRouter({
	routes: [],
	history: createWebHistory()
})

export default (app: App) => app.use(router)

import App from './App.vue'
import { createApp } from 'vue'
import { useModules } from 'virtual:modules'

const app = createApp(App)

useModules(app) // 这将注册所有的 Vue 插件

app.mount('#app')

types 🦖

如果你是 ts 项目，可以在 tsconfig.json 中添加如下配置

{
	"compilerOptions": {
		"types": ["vite-plugin-use-modules/client"]
	}
}

配置

1. 修改目标目录

import { defineConfig } from 'vite'
import Modules from 'vite-plugin-use-modules'

export default defineConfig({
	plugins: [
		Modules({
			target: 'src/plugins' // 这将加载 src/plugins 下的模块，默认为 src/modules
		})
	]
})

2. 自动模式

import { defineConfig } from 'vite'
import Modules from 'vite-plugin-use-modules'

export default defineConfig({
	plugins: [
		Modules({
			auto: true // 开启自动模式
		})
	]
})

开启后，虚拟模块的注册是非必需的

import App from './App.vue'
import { createApp } from 'vue'

- import { useModules } from 'virtual:modules'

const app = createApp(App)

- useModules(app)

app.mount('#app')

3. 规范化

import { defineConfig } from 'vite'
import Modules from 'vite-plugin-use-modules'

export default defineConfig({
	plugins: [
		Modules({
			normalize(target) {
				return `'${target}/*.[tj]s'` // 返回扫描的 glob
			}
		})
	]
})

组织 🦔

欢迎关注 帝莎编程

• 官网
• Gitee
• Github
• 网易云课堂

License

Made with markthree

Published under MIT License.