Skip to content

介绍

@meng-xi/vite-plugin 是一个为 Vite 提供实用插件的工具包,同时也是一个完整的 Vite 插件开发框架

它能做什么

  • 17 款开箱即用插件 — 按功能分为 7 组(compress / generate / inject / analyze / copy / guard / proxy),覆盖构建优化、代码生成、资源管理、开发体验等场景
  • 插件开发框架 — 导出 BasePlugin、Logger、Validator 等核心组件,快速构建自定义 Vite 插件
  • 14 大通用工具模块 — 并发控制、文件系统、HTML 注入、路径处理等,支持子路径按需导入

插件分组

插件按功能动词分组,支持按分组或单独导入:

分组说明插件
compress压缩类compressAssets、imageOptimizer
generate生成类autoImport、generateUni、generatePages、generateRouter、generateVersion
inject注入类htmlInject、loadingManager、faviconManager、versionUpdateChecker
analyze分析类bundleAnalyzer、buildProgress
copy拷贝类copyFile、assetManifest
guard守卫类envGuard
proxy代理类proxyManager

插件开发框架

导出核心组件,支持快速构建自定义插件:

组件说明
BasePlugin插件基类,提供生命周期管理、日志、验证、安全执行包裹
createPluginFactory插件工厂函数,自动处理选项合并、标准化和实例化
Logger单例日志管理器,支持插件级别的日志控制
Validator链式配置验证器,支持必填、类型、枚举、范围和自定义验证

通用配置

所有内置插件都继承自 BasePlugin,支持以下通用配置:

typescript
interface BasePluginOptions {
	/** 是否启用插件,默认 true */
	enabled?: boolean
	/** 是否显示详细日志,默认 true */
	verbose?: boolean
	/** 错误处理策略:throw 抛出 | log 记录 | ignore 忽略 */
	errorStrategy?: 'throw' | 'log' | 'ignore'
}

学习路径

推荐学习顺序

  1. 安装 — 安装依赖
  2. 快速开始 — 5 分钟上手
  3. 基础概念 — 理解插件系统与生命周期
  4. 按需导入 — 优化打包体积
  5. 最佳实践 — 场景化推荐与常见陷阱

下一步

Released under the MIT License.