更新记录

1.0.0（2026-06-27） 下载此版本

首个稳定版本发布，API 稳定性承诺与生产就绪标志

里程碑说明

经过 0.x 系列（0.0.1 - 0.2.7）共 27 个版本的迭代，插件体系从最初的 2 个插件（copyFile、injectIco）发展到 15 个插件覆盖构建全生命周期，common 工具模块从零散函数发展为 14 个规范化子模块，插件开发框架（BasePlugin、Logger、Validator、createPluginFactory）趋于成熟。1.0.0 版本标记 API 稳定性，后续变更将严格遵循语义化版本规范。

与 0.x 的主要差异

插件完整清单（15 个，7 个分组）

Common 工具模块（14 个子模块）

插件开发框架

BasePlugin 抽象类：所有插件的基类，提供完整的生命周期管理

createPluginFactory 工厂函数：支持选项标准化器（OptionsNormalizer），允许插件接受非对象类型的简写配置

Logger 单例日志系统：以实例 ID 为 key 管理每个插件实例的日志配置，避免同类型多实例冲突，支持 register / unregister / destroy 生命周期

Validator 泛型验证器：链式 API（required / enum / minValue / maxValue / custom 等），编译时类型安全保障

子路径导出总览

// 主入口（向后兼容）
import { compressAssets, generateRouter } from '@meng-xi/vite-plugin'

// 按分组导入（推荐，利于 Tree-shaking）
import { compressAssets } from '@meng-xi/vite-plugin/plugins/compress'
import { generateRouter } from '@meng-xi/vite-plugin/plugins/generate'
import { loadingManager } from '@meng-xi/vite-plugin/plugins/inject'

// 单插件导入
import { generateRouter } from '@meng-xi/vite-plugin/plugins/generate/generate-router'

// Common 工具
import { parsePluginTemplate } from '@meng-xi/vite-plugin/common/format'
import { deepMerge } from '@meng-xi/vite-plugin/common/object'

// 框架能力
import { BasePlugin, createPluginFactory } from '@meng-xi/vite-plugin/factory'
import { Logger } from '@meng-xi/vite-plugin/logger'

完整子路径清单：

• . — 主入口（导出全部）
• ./common + 14 个 common 子模块（code/compress/concurrency/env/format/fs/hash/html/object/path/script/string/ui/validation）
• ./factory — BasePlugin、createPluginFactory、类型定义
• ./logger — Logger 单例、PluginLogger
• ./plugins + 7 个分组子路径（analyze/compress/copy/generate/guard/inject/proxy）+ 15 个插件单独子路径

生产就绪声明

• Vite 兼容性：支持 Vite 5.x - 7.x（peerDependencies: vite >=5.0.0 <8.0.0）
• TypeScript 支持：完整类型定义，types 字段指向 .d.ts 文件
• 双格式输出：同时提供 ESM（.mjs）与 CJS（.cjs）构建产物
• 可选依赖：sharp、svgo 为可选依赖，不可用时优雅降级
• 零配置可用：所有插件参数可选化，提供合理默认值

0.2.7（2026-06-26） 下载此版本

插件按功能分组导出，修复 generateRouter 类型注解生成缺陷

插件分组导出（新增）

变更：将 15 个插件按功能划分为 7 个分组，每个分组提供独立子路径导出，支持按需导入与 Tree-shaking

// 0.2.6：单入口导入全部插件
import { compressAssets, generateRouter, loadingManager } from '@meng-xi/vite-plugin/plugins'

// 0.2.7：按组导入，利于 Tree-shaking
import { compressAssets } from '@meng-xi/vite-plugin/plugins/compress'
import { generateRouter } from '@meng-xi/vite-plugin/plugins/generate'
import { loadingManager } from '@meng-xi/vite-plugin/plugins/inject'

./plugins 主入口仍保留，向后兼容；各插件单独子路径（如 ./plugins/analyze/build-progress）同步开放

generateRouter（修复）

Bug 修复：exportTypes: false 时生成的路由文件类型注解与 import 语句不一致

// 0.2.6：exportTypes: false 时仍生成类型注解，但无 import 语句，导致 RouteConfig 未定义错误
export const routes: RouteConfig[] = [
    // ❌ RouteConfig 未定义
    // ...
]

// 0.2.7：exportTypes: false 时不生成类型注解，与 import 逻辑保持一致
export const routes = [
    // ✅ 无类型注解，无错误
    // ...
]

子路径导出（变更）

• 新增 @meng-xi/vite-plugin/plugins/analyze 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/compress 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/copy 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/generate 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/guard 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/inject 子路径导出
• 新增 @meng-xi/vite-plugin/plugins/proxy 子路径导出
• 新增各插件单独子路径导出（如 ./plugins/analyze/build-progress、./plugins/compress/compress-assets 等）

0.2.6（2026-06-25） 下载此版本

通用工具抽离与架构统一重构，版本号注入机制自动化

Common 工具模块（增强 + 新增）

新增 6 个子模块：将各插件内部重复的工具函数提取到 common 目录统一管理，消除冗余代码

common/format（增强）：

import { parsePluginTemplate } from './uni_modules/vite-plugin/js_sdk/common/format/index.mjs'

// 支持自定义日期格式和自定义字段
parsePluginTemplate('{name} {custom:author} {date:YYYY-MM-DD} {version}', {
    name: 'generate-router',
    version: '0.2.6',
    customFields: { author: 'MengXi Studio' }
})
// 输出：'generate-router MengXi Studio 2026-06-25 0.2.6'

版本号注入机制（重构）

变更：移除手动版本同步逻辑，改为构建时自动注入

影响：generateRouter 注释头中的 {version} 占位符现在通过 __PLUGIN_VERSION__ 自动获取，版本号升级时无需修改插件源码

versionUpdateChecker（优化）

变更：自定义提示模板解析改用通用工具函数

插件目录结构（重构）

变更：统一插件内部助手目录命名，提升代码可维护性

此变更仅影响插件内部结构，对用户导入路径无影响

子路径导出（变更）

• 新增 @meng-xi/vite-plugin/common/code 子路径导出
• 新增 @meng-xi/vite-plugin/common/compress 子路径导出
• 新增 @meng-xi/vite-plugin/common/env 子路径导出
• 新增 @meng-xi/vite-plugin/common/hash 子路径导出
• 新增 @meng-xi/vite-plugin/common/object 子路径导出
• 新增 @meng-xi/vite-plugin/common/string 子路径导出
• @meng-xi/vite-plugin/common/format 新增导出：parsePluginTemplate
• @meng-xi/vite-plugin/common/code 新增导出：JS_KEYWORDS、stripCommentsAndStrings
• @meng-xi/vite-plugin/common/compress 新增导出：calculateGzipSize
• @meng-xi/vite-plugin/common/env 新增导出：parseEnvContent
• @meng-xi/vite-plugin/common/hash 新增导出：generateRandomHash
• @meng-xi/vite-plugin/common/object 新增导出：deepMerge
• @meng-xi/vite-plugin/common/string 新增导出：toCamelCase、toPascalCase、stripJsonComments、escapeRegex

平台兼容性

uni-app(3.7.12)

uni-app x(3.7.12)

其他

@meng-xi/vite-plugin

Vite 实用插件集与插件开发框架（uni-app 版本）。

📖 完整文档：https://mengxi-studio.github.io/vite-plugin/

特性

• 开箱即用 - 15 个实用插件，覆盖构建、产物、路由、版本、HTML、代理等场景
• 插件开发框架 - 导出 BasePlugin、Logger、Validator，快速构建自定义插件
• 通用工具库 - 内置 14 大 Common 工具模块，支持子路径按需导入
• uni-app 适配 - 通过 uni_modules 集成，无需 npm 安装

安装

uni_modules（推荐）

将 vite-plugin 目录复制到项目的 uni_modules 目录下：

src/
  └── uni_modules/
        └── vite-plugin/
              └── js_sdk/
                    └── index.mjs

npm

pnpm add @meng-xi/vite-plugin -D

npm 方式需将导入路径改为 @meng-xi/vite-plugin。

快速开始

import { defineConfig } from 'vite'
import uni from '@dcloudio/vite-plugin-uni'
import {
    assetManifest,
    autoImport,
    buildProgress,
    compressAssets,
    copyFile,
    envGuard,
    faviconManager,
    generateRouter,
    generateVersion,
    htmlInject,
    imageOptimizer,
    loadingManager,
    proxyManager,
    versionUpdateChecker
} from './uni_modules/vite-plugin/js_sdk/index.mjs'

export default defineConfig({
    plugins: [
        uni(),
        // 按需启用插件
        autoImport({ imports: { vue: ['*'] }, vueTemplate: true }),
        generateRouter({ dts: true }),
        generateVersion({ format: 'datetime', outputType: 'both' }),
        envGuard({ required: { VITE_API_URL: { type: 'url', required: true } } }),
        loadingManager({ defaultVisible: true, autoHideOn: 'DOMContentLoaded' }),
        proxyManager({ rules: [{ context: '/api', target: 'https://api.example.com', changeOrigin: true }] })
    ]
})

内置插件

各插件详细配置与 API 请查阅 官网插件文档。

插件开发框架

导出完整的插件开发框架，帮助快速构建符合规范的自定义 Vite 插件。

import { BasePlugin, createPluginFactory } from './uni_modules/vite-plugin/js_sdk/index.mjs'
import type { Plugin } from 'vite'

class MyPlugin extends BasePlugin<{ prefix?: string }> {
    protected getPluginName() {
        return 'my-plugin'
    }
    protected getDefaultOptions() {
        return { prefix: '[app]' }
    }
    protected validateOptions() {
        this.validator.field('prefix').string().notEmpty().validate()
    }
    protected addPluginHooks(plugin: Plugin) {
        plugin.writeBundle = {
            order: 'post',
            handler: async () => {
                await this.safeExecute(async () => {
                    this.logger.info('插件执行中...')
                }, '执行自定义逻辑')
            }
        }
    }
}

export const myPlugin = createPluginFactory(MyPlugin)

核心 API： BasePlugin（插件基类）、createPluginFactory（转换为 Vite 插件函数）、Logger（日志管理器）、Validator（链式配置验证器）。

详细 API 请查阅 官网框架文档。

Common 工具模块

内置通用工具函数库，按功能模块组织，支持子路径按需导入。

// 示例：按需导入
import { formatFileSize } from './uni_modules/vite-plugin/js_sdk/common/format/index.mjs'
import { scanDirectory } from './uni_modules/vite-plugin/js_sdk/common/fs/index.mjs'
import { deepMerge } from './uni_modules/vite-plugin/js_sdk/common/object/index.mjs'
import { normalizePath } from './uni_modules/vite-plugin/js_sdk/common/path/index.mjs'

各工具函数详细 API 请查阅 官网工具文档。

子路径导出

License

MIT