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

package/README.md

@@ -6,7 +6,6 @@
 
 - 构建产物中生成 `version.json`
 - 可选地向 HTML 注入 `window["__VERSION__"]`
-- 通过 `import.meta.env.__VERSION__` 在代码中直接读取版本号
 - 支持自定义版本号、文件名、全局变量名和额外数据
 
 这个插件只负责产出和暴露版本信息。
@@ -107,7 +106,7 @@ export default defineConfig({
 
 如果你的项目要做“检测到新版本后提示刷新”，推荐做法是：
 
-- 用 `import.meta.env.__VERSION__` 读取当前页面版本
+- 用 `window["__VERSION__"]` 读取当前页面版本
 - 请求 `version.json` 读取服务端版本
 - 在业务项目里自行决定提示方式和刷新时机
 
@@ -123,6 +122,7 @@ type BuildVersionPluginOptions = {
   filename?: string
   globalName?: string
   injectToHtml?: boolean
+  timeZone?: string
   version?: string | number | ((ctx: BuildVersionContext) => string | number)
   data?: Record<string, any>
 }
@@ -182,6 +182,18 @@ type BuildVersionPluginOptions = {
 }
 ```
 
+### `timeZone`
+
+- 类型：`string`
+- 默认值：`"Asia/Shanghai"`
+- 作用：控制默认时间按哪个时区生成
+
+说明：
+
+- 只影响插件默认生成的 `time`
+- 如果构建环境是 UTC，也会按设置的时区输出
+- 如果传了 `version`，则以你自己的 `version` 逻辑为准
+
 ### `data`
 
 - 类型：`Record<string, any>`
@@ -302,7 +314,24 @@ export default defineConfig({
 })
 ```
 
-### 6. 追加自定义数据
+### 6. 指定时区生成时间
+
+```ts
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import buildVersionPlugin from 'vite-plugin-build-version-file'
+
+export default defineConfig({
+  plugins: [
+    vue(),
+    buildVersionPlugin({
+      timeZone: 'Asia/Shanghai'
+    })
+  ]
+})
+```
+
+### 7. 追加自定义数据
 
 ```ts
 import { defineConfig } from 'vite'
@@ -337,36 +366,9 @@ export default defineConfig({
 
 ## 在项目中读取版本
 
-插件提供三种方式读取版本号，可根据场景选择：
-
-### 方式一：通过 `import.meta.env` 读取（推荐）
-
-版本号会被注入到 `import.meta.env` 中，可以直接在代码中使用：
-
-```ts
-const version = import.meta.env.__VERSION__
-console.log(version) // '20260401153045' 或 '1.2.3'
-```
-
-**优势：**
-- 无需等待页面加载或发起请求
-- 类型安全，可在 `vite-env.d.ts` 中声明类型
-- 适合在应用初始化时读取版本
-
-**TypeScript 类型声明：**
-
-```ts
-// vite-env.d.ts
-interface ImportMetaEnv {
-  readonly __VERSION__: string
-}
-
-interface ImportMeta {
-  readonly env: ImportMetaEnv
-}
-```
+插件提供两种方式读取版本号，可根据场景选择：
 
-### 方式二：读取注入的全局变量
+### 方式一：读取注入的全局变量
 
 ```ts
 const payload = window['__VERSION__']
@@ -381,7 +383,7 @@ console.log(payload.env)
 - 这里读到的是完整对象，不是单独字符串
 - 如果配置了 `data`，这里也可以直接读取对应字段
 
-### 方式三：读取 `version.json`
+### 方式二：读取 `version.json`
 
 ```ts
 const response = await fetch('/version.json')
@@ -417,8 +419,9 @@ async function checkVersion() {
     })
 
     const payload = await response.json()
+    const currentPayload = window.__VERSION__
 
-    if (payload.time !== import.meta.env.__VERSION__) {
+    if (currentPayload && payload.time !== currentPayload.time) {
       const shouldReload = await showUpdatePrompt()
 
       if (shouldReload) {
@@ -447,7 +450,7 @@ checkVersion()
 
 建议：
 
-- 版本比较只判断 `payload.time` 和 `import.meta.env.__VERSION__` 是否一致
+- 版本比较只判断 `payload.time` 和当前页面里的 `window.__VERSION__.time` 是否一致
 - 提示方式由业务项目自己决定，可以是弹窗、消息条、通知或静默刷新
 - 轮询间隔不要过短，通常用 1 分钟或更长更合适
 - 请求失败后继续下一轮检查，避免一次失败后整个流程中断

package/dist/index.cjs

@@ -29,19 +29,32 @@ var import_node_path = require("path");
 var PLUGIN_NAME = "vite-plugin-build-version-file";
 var DEFAULT_FILENAME = "version.json";
 var DEFAULT_GLOBAL_NAME = "__VERSION__";
-function createDefaultVersion(command) {
+var DEFAULT_TIME_ZONE = "Asia/Shanghai";
+function createDefaultVersion(command, timeZone) {
   if (command === "serve") {
     return 0;
   }
-  const date = /* @__PURE__ */ new Date();
-  const pad = (value) => value.toString().padStart(2, "0");
+  const parts = new Intl.DateTimeFormat("en-US", {
+    timeZone,
+    year: "numeric",
+    month: "2-digit",
+    day: "2-digit",
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+    hour12: false,
+    hourCycle: "h23"
+  }).formatToParts(/* @__PURE__ */ new Date());
+  const getPartValue = (type) => {
+    return parts.find((part) => part.type === type)?.value ?? "";
+  };
   return [
-    date.getFullYear(),
-    pad(date.getMonth() + 1),
-    pad(date.getDate()),
-    pad(date.getHours()),
-    pad(date.getMinutes()),
-    pad(date.getSeconds())
+    getPartValue("year"),
+    getPartValue("month"),
+    getPartValue("day"),
+    getPartValue("hour"),
+    getPartValue("minute"),
+    getPartValue("second")
   ].join("");
 }
 function normalizeFileName(filename) {
@@ -57,6 +70,18 @@ function normalizeGlobalName(globalName) {
   }
   return globalName;
 }
+function normalizeTimeZone(timeZone) {
+  const normalized = timeZone.trim();
+  if (!normalized) {
+    throw new Error(`[${PLUGIN_NAME}] "timeZone" cannot be empty.`);
+  }
+  try {
+    new Intl.DateTimeFormat("en-US", { timeZone: normalized }).format(/* @__PURE__ */ new Date());
+  } catch {
+    throw new Error(`[${PLUGIN_NAME}] "timeZone" is invalid.`);
+  }
+  return normalized;
+}
 function normalizeData(data) {
   if (data === void 0) {
     return {};
@@ -116,59 +141,45 @@ function toRequestPath(base, fileName) {
   const baseWithoutTrailingSlash = withLeadingSlash.endsWith("/") ? withLeadingSlash.slice(0, -1) : withLeadingSlash;
   return `${baseWithoutTrailingSlash}/${fileName}`.replace(/\/{2,}/g, "/");
 }
+function resolveVersion(options, context, timeZone) {
+  if (typeof options.version === "function") {
+    return options.version(context);
+  }
+  if (options.version !== void 0) {
+    return options.version;
+  }
+  return createDefaultVersion(context.command, timeZone);
+}
+function createPayload(options, context, data, timeZone, packageInfo = {}) {
+  let nextPayload = {
+    ...data,
+    ...packageInfo,
+    time: resolveVersion(options, context, timeZone),
+    env: context.mode
+  };
+  if (options.payload) {
+    nextPayload = options.payload(nextPayload);
+  }
+  return nextPayload;
+}
 function buildVersionPlugin(options = {}) {
   const fileName = normalizeFileName(options.filename ?? DEFAULT_FILENAME);
   const globalName = normalizeGlobalName(
     options.globalName ?? DEFAULT_GLOBAL_NAME
   );
   const injectToHtml = options.injectToHtml ?? true;
+  const timeZone = normalizeTimeZone(options.timeZone ?? DEFAULT_TIME_ZONE);
   const data = normalizeData(options.data);
-  let packageInfo = {};
   let payload;
   return {
     name: PLUGIN_NAME,
-    config(config, { command }) {
-      const context = {
-        command,
-        mode: config.mode || "development"
-      };
-      let version;
-      if (typeof options.version === "function") {
-        version = options.version(context);
-      } else if (options.version !== void 0) {
-        version = options.version;
-      } else {
-        version = createDefaultVersion(context.command);
-      }
-      return {
-        define: {
-          [`import.meta.env.${globalName}`]: JSON.stringify(version)
-        }
-      };
-    },
     configResolved(config) {
-      packageInfo = readPackageInfo(config.root);
       const context = {
         command: config.command,
         mode: config.mode
       };
-      let version;
-      if (typeof options.version === "function") {
-        version = options.version(context);
-      } else if (options.version !== void 0) {
-        version = options.version;
-      } else {
-        version = createDefaultVersion(context.command);
-      }
-      payload = {
-        ...data,
-        ...packageInfo,
-        time: version,
-        env: config.mode
-      };
-      if (options.payload) {
-        payload = options.payload(payload);
-      }
+      const packageInfo = readPackageInfo(config.root);
+      payload = createPayload(options, context, data, timeZone, packageInfo);
     },
     configureServer(server) {
       const requestPath = toRequestPath(server.config.base, fileName);

package/dist/index.d.cts

@@ -13,6 +13,7 @@ interface BuildVersionPluginOptions {
     filename?: string;
     globalName?: string;
     injectToHtml?: boolean;
+    timeZone?: string;
     version?: string | number | ((ctx: BuildVersionContext) => string | number);
     data?: Record<string, any>;
     log?: (content: any) => string;

package/dist/index.d.ts

@@ -13,6 +13,7 @@ interface BuildVersionPluginOptions {
     filename?: string;
     globalName?: string;
     injectToHtml?: boolean;
+    timeZone?: string;
     version?: string | number | ((ctx: BuildVersionContext) => string | number);
     data?: Record<string, any>;
     log?: (content: any) => string;

package/dist/index.mjs

@@ -4,19 +4,32 @@ import { dirname, join } from "path";
 var PLUGIN_NAME = "vite-plugin-build-version-file";
 var DEFAULT_FILENAME = "version.json";
 var DEFAULT_GLOBAL_NAME = "__VERSION__";
-function createDefaultVersion(command) {
+var DEFAULT_TIME_ZONE = "Asia/Shanghai";
+function createDefaultVersion(command, timeZone) {
   if (command === "serve") {
     return 0;
   }
-  const date = /* @__PURE__ */ new Date();
-  const pad = (value) => value.toString().padStart(2, "0");
+  const parts = new Intl.DateTimeFormat("en-US", {
+    timeZone,
+    year: "numeric",
+    month: "2-digit",
+    day: "2-digit",
+    hour: "2-digit",
+    minute: "2-digit",
+    second: "2-digit",
+    hour12: false,
+    hourCycle: "h23"
+  }).formatToParts(/* @__PURE__ */ new Date());
+  const getPartValue = (type) => {
+    return parts.find((part) => part.type === type)?.value ?? "";
+  };
   return [
-    date.getFullYear(),
-    pad(date.getMonth() + 1),
-    pad(date.getDate()),
-    pad(date.getHours()),
-    pad(date.getMinutes()),
-    pad(date.getSeconds())
+    getPartValue("year"),
+    getPartValue("month"),
+    getPartValue("day"),
+    getPartValue("hour"),
+    getPartValue("minute"),
+    getPartValue("second")
   ].join("");
 }
 function normalizeFileName(filename) {
@@ -32,6 +45,18 @@ function normalizeGlobalName(globalName) {
   }
   return globalName;
 }
+function normalizeTimeZone(timeZone) {
+  const normalized = timeZone.trim();
+  if (!normalized) {
+    throw new Error(`[${PLUGIN_NAME}] "timeZone" cannot be empty.`);
+  }
+  try {
+    new Intl.DateTimeFormat("en-US", { timeZone: normalized }).format(/* @__PURE__ */ new Date());
+  } catch {
+    throw new Error(`[${PLUGIN_NAME}] "timeZone" is invalid.`);
+  }
+  return normalized;
+}
 function normalizeData(data) {
   if (data === void 0) {
     return {};
@@ -91,59 +116,45 @@ function toRequestPath(base, fileName) {
   const baseWithoutTrailingSlash = withLeadingSlash.endsWith("/") ? withLeadingSlash.slice(0, -1) : withLeadingSlash;
   return `${baseWithoutTrailingSlash}/${fileName}`.replace(/\/{2,}/g, "/");
 }
+function resolveVersion(options, context, timeZone) {
+  if (typeof options.version === "function") {
+    return options.version(context);
+  }
+  if (options.version !== void 0) {
+    return options.version;
+  }
+  return createDefaultVersion(context.command, timeZone);
+}
+function createPayload(options, context, data, timeZone, packageInfo = {}) {
+  let nextPayload = {
+    ...data,
+    ...packageInfo,
+    time: resolveVersion(options, context, timeZone),
+    env: context.mode
+  };
+  if (options.payload) {
+    nextPayload = options.payload(nextPayload);
+  }
+  return nextPayload;
+}
 function buildVersionPlugin(options = {}) {
   const fileName = normalizeFileName(options.filename ?? DEFAULT_FILENAME);
   const globalName = normalizeGlobalName(
     options.globalName ?? DEFAULT_GLOBAL_NAME
   );
   const injectToHtml = options.injectToHtml ?? true;
+  const timeZone = normalizeTimeZone(options.timeZone ?? DEFAULT_TIME_ZONE);
   const data = normalizeData(options.data);
-  let packageInfo = {};
   let payload;
   return {
     name: PLUGIN_NAME,
-    config(config, { command }) {
-      const context = {
-        command,
-        mode: config.mode || "development"
-      };
-      let version;
-      if (typeof options.version === "function") {
-        version = options.version(context);
-      } else if (options.version !== void 0) {
-        version = options.version;
-      } else {
-        version = createDefaultVersion(context.command);
-      }
-      return {
-        define: {
-          [`import.meta.env.${globalName}`]: JSON.stringify(version)
-        }
-      };
-    },
     configResolved(config) {
-      packageInfo = readPackageInfo(config.root);
       const context = {
         command: config.command,
         mode: config.mode
       };
-      let version;
-      if (typeof options.version === "function") {
-        version = options.version(context);
-      } else if (options.version !== void 0) {
-        version = options.version;
-      } else {
-        version = createDefaultVersion(context.command);
-      }
-      payload = {
-        ...data,
-        ...packageInfo,
-        time: version,
-        env: config.mode
-      };
-      if (options.payload) {
-        payload = options.payload(payload);
-      }
+      const packageInfo = readPackageInfo(config.root);
+      payload = createPayload(options, context, data, timeZone, packageInfo);
     },
     configureServer(server) {
       const requestPath = toRequestPath(server.config.base, fileName);

package/package.json

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