vite-plugin-necessary-import
v1.2.0
Published
vite 按需引用插件 (已支持: [email protected], [email protected])
Downloads
10
Readme
vite-plugin-necessary-import
vite 按需引用插件, 使用此插件能够以最小的改动, 为组件库提供 vite 按需引用支持
特性
- api 设计参考
babel-plugin-import
, 可以从@vue/cli-service
脚手架上快速移植 - 与组件库弱相关, 按需引用特性不需要组件库指定特定的目录规范或实现
resolver
Usage
- install
# npm
npm install vite-necessary-import -D
# pnpm
pnpm install vite-necessary-import -D
# yarn
yarn add vite-necessary-import --dev
- config for vite.config.ts
import { defineConfig } from 'vite'
import { necessaryImport } from 'vite-necessary-import'
export default defineConfig({
plugins: [
// element-ui
necessaryImport({ library: 'element-ui', base: true }),
// antdv
necessaryImport({ library: 'ant-design-vue', base: true }),
// vant
necessaryImport({ library: 'vant', base: true }),
// meri-design
necessaryImport({ library: 'meri-design', base: true }),
// 其他
necessaryImport({ library: '<组件库的 name>' })
]
})
- options
| option | type | required | desc | default |
| ------------ | ---------------------------- | -------- | ------------------------------------------------------ | ---------------------------- |
| library | string | ✔ | 需要按需引用的库名 | |
| base | string | | 是否添加公共(基础)样式,如果有的情况下 | false |
| include | FilterPattern | | 扫描文件目录 (见源码注释) | |
| exclude | FilterPattern | | 排除文件目录 | [] |
| extension | Array<IStyleType>
| | 样式文件类型(扩展名) | ['css','less','scss','sass'] |
| styleDir | string / IStylePathFactory
| | 样式文件扫描目录(支持自定义, 为空时扫描库下面所有文件) | '/' |
| noComponent | Array<string>
| | 哪些导入的对象不是组件(忽略样式加载) | [] |
| noFoundStyle | 'warn' / 'error' / false
| | 样式文件检索不到时, 如何处理 | 'warn' |
| logLevel | LogLevel | | 打印日志等级(用于调试) | 'warn' |
# include default
# ['src/**/*.ts(x|)', 'src/**/*.js(x|)', 'src/**/*.vue']
已测试场景
framework
[email protected]
: vite + @vitejs/plugin-vue2 + vue(>=2.6.11)- meri-design@latest | ✔
- element-ui@latest | ✔
- [email protected] | ✔
- [email protected] | ✔
[email protected]
: vite + @vitejs/plugin-vue- meri-plus | ✔
react
: vite + @vitejs/plugin-reactreact+swc
: vite + @vitejs/plugin-reactsvelte
: vite + @vitejs/plugin-svelte
局限性
- 目前功能仅在
vue2.x
,vue3.x
进行过测试
RoadMap
- vite 其他类型模板测试
react
react+swc
svelte
- 现有问题处理
element-ui
组件样式依赖问题处理
- 待确认项
动态导入组件
的样式导入问题
QA
适用范围
假设你使用的组件库在迁移到 vite 前使用的
babel-plugin-import
, 那么你迁移到这个插件应该很容易. 这个库的配置方式, 是参考babel-plugin-import
实现的。如果, 你使用的是自己实现的组件库, 那可以先尝试下, 如果样式导入不成功, 可以通过自定义
IStylePathFactory
来获取需要导入的样式.受我目前的项目类型影响, 我仅测试了如下文件的按需引用能力.
.vue
(包括: vue2, vue3),.ts(x)
,.js(x)
, 如果发现问题, 可以向我提 issues 反馈
为什么有了
unplugin-auto-import
+unplugin-vue-component
方案, 还要再创建这个插件在这个插件创建之前, 我从
element-plus
了解到unplugin-auto-import
+unplugin-vue-component
这套方案。他的机制时, 扫描使用的组件名, 如<template>
中的组件, 让 resolver 根据组件名, 去匹配相关内容. 这套机制放在规范标准的库下面没有什么问题, 如:antdv
,element
等, 这些组件库会为自己的组件增加命名前缀。但是, 一些小的组件库(比如我们团队的meri-design
), 他的命名规范没有那么标准(没有命名前缀, 如:<Button>
,<Avatar>
这样 😂), 就比较难受了。另外,
unplugin-auto-import
+unplugin-vue-component
方案, 聚合了太多冗余的能力, 如:动态的dts配置
, 我不太喜欢他把 dts 文件生成到项目根目录下的行为, 然后就搞了一个这个库~