@cxkit/version-vite-plugin
v0.0.6
Published
Vite plugin for generating version manifest and injecting build metadata.
Maintainers
Readme
@cxkit/version-vite-plugin
@cxkit 架构的构建层核心。它是一个高度轻量级的 Vite 插件,专为无感热更新和静态全量检查拦截生成构建时元数据。
工作原理
在执行 vite build 时,该插件会自动在你的产物目录 dist/ 下生成一份静态配置文件 version.json,其中包含了一串唯一哈希 buildId。同时,它会通过 Vite 的 define 机制向应用程序的构建宏中注入基础预检配置常量,允许你在代码里自由读取 __APP_VERSION__ 等信息。
安装
这是唯一一个需要在 开发依赖 (devDependencies) 中去安装的插件。
npm install -D @cxkit/version-vite-plugin使用方法
在 vite.config.ts 中:
import { defineConfig } from 'vite'
import { versionManifest } from '@cxkit/version-vite-plugin'
// 或借助 Node fs / 宏读取你的 package.json
const versionPlugin = versionManifest(process.env.npm_package_version || '1.0.0')
export default defineConfig({
plugins: [
// 生成 version.json 文件
versionPlugin.plugin
],
// 将打包的时间与 ID 宏注入到源码替换
define: versionPlugin.define
})构建产出 (version.json)
执行打包后,会生成如下结果:
{
"version": "1.0.0",
"buildTime": "2026-03-26T12:00:00.000Z",
"buildId": "a7b8c9d0e12345"
}阅读完整文档
详细用法请访问 官方开发文档。
