vite-plugin-build-version-file 0.1.5 → 0.1.6

package/README.md

@@ -72,7 +72,7 @@ export default defineConfig({
 {
   "pkgName": "your-app-name",
   "pkgVersion": "1.0.0",
-  "version": "20260401153045",
+  "time": "20260401153045",
   "env": "production"
 }
 ```
@@ -83,7 +83,7 @@ export default defineConfig({
 {
   "pkgName": "your-app-name",
   "pkgVersion": "1.0.0",
-  "version": 0,
+  "time": 0,
   "env": "development"
 }
 ```
@@ -150,7 +150,7 @@ type BuildVersionPluginOptions = {
 
 ```html
 <script>
-  window["__VERSION__"] = { "version": "20260401153045", "env": "production" };
+  window["__VERSION__"] = { "time": "20260401153045", "env": "production" };
 </script>
 ```
 
@@ -193,7 +193,7 @@ type BuildVersionPluginOptions = {
 - 插件会自动从业务项目的 `package.json` 中读取 `name` 和 `version`，分别写入 `pkgName` 和 `pkgVersion`
 - 查找位置是从当前 Vite 项目根目录开始，向上寻找最近的 `package.json`
 - 会同时影响开发态接口返回、构建产物中的 `version.json` 和注入到 `window` 的对象
-- 如果 `data` 里存在 `version` 或 `env` 同名字段，最终仍以插件生成的值为准
+- 如果 `data` 里存在 `time` 或 `env` 同名字段，最终仍以插件生成的值为准
 - 如果 `data` 里存在 `pkgName` 或 `pkgVersion`，读取到业务项目 `package.json` 时会以自动读取的值为准；读取不到时会保留 `data` 里的值
 
 ## 使用示例
@@ -236,7 +236,7 @@ export default defineConfig({
 
 ```ts
 const payload = window['__APP_VERSION__']
-const version = payload.version
+const time = payload.time
 ```
 
 ### 3. 只保留 `version.json`，不注入 `window`
@@ -330,7 +330,7 @@ export default defineConfig({
   "appName": "admin",
   "gitBranch": "release/2026-04",
   "commitSha": "abc1234",
-  "version": "20260401153045",
+  "time": "20260401153045",
   "env": "production"
 }
 ```
@@ -371,7 +371,7 @@ interface ImportMeta {
 ```ts
 const payload = window['__VERSION__']
 
-console.log(payload.version)
+console.log(payload.time)
 console.log(payload.env)
 ```
 
@@ -387,7 +387,7 @@ console.log(payload.env)
 const response = await fetch('/version.json')
 const payload = await response.json()
 
-console.log(payload.version)
+console.log(payload.time)
 console.log(payload.env)
 ```
 
@@ -418,7 +418,7 @@ async function checkVersion() {
 
     const payload = await response.json()
 
-    if (payload.version !== import.meta.env.__VERSION__) {
+    if (payload.time !== import.meta.env.__VERSION__) {
       const shouldReload = await showUpdatePrompt()
 
       if (shouldReload) {
@@ -447,7 +447,7 @@ checkVersion()
 
 建议：
 
-- 版本比较只判断 `payload.version` 和 `import.meta.env.__VERSION__` 是否一致
+- 版本比较只判断 `payload.time` 和 `import.meta.env.__VERSION__` 是否一致
 - 提示方式由业务项目自己决定，可以是弹窗、消息条、通知或静默刷新
 - 轮询间隔不要过短，通常用 1 分钟或更长更合适
 - 请求失败后继续下一轮检查，避免一次失败后整个流程中断

package/dist/index.cjs

@@ -163,7 +163,7 @@ function buildVersionPlugin(options = {}) {
       payload = {
         ...data,
         ...packageInfo,
-        version,
+        time: version,
         env: config.mode
       };
       if (options.payload) {

package/dist/index.d.cts

@@ -5,7 +5,7 @@ interface BuildVersionContext {
     mode: string;
 }
 interface BuildVersionPayload {
-    version: string | number;
+    time: string | number;
     env: string;
     [key: string]: any;
 }

package/dist/index.d.ts

@@ -5,7 +5,7 @@ interface BuildVersionContext {
     mode: string;
 }
 interface BuildVersionPayload {
-    version: string | number;
+    time: string | number;
     env: string;
     [key: string]: any;
 }

package/dist/index.mjs

@@ -138,7 +138,7 @@ function buildVersionPlugin(options = {}) {
       payload = {
         ...data,
         ...packageInfo,
-        version,
+        time: version,
         env: config.mode
       };
       if (options.payload) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-build-version-file",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "A Vite plugin that emits version.json and injects version metadata into HTML.",
   "license": "MIT",
   "type": "module",