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

package/README.md

@@ -122,6 +122,7 @@ type BuildVersionPluginOptions = {
   filename?: string
   globalName?: string
   injectToHtml?: boolean
+  timeZone?: string
   version?: string | number | ((ctx: BuildVersionContext) => string | number)
   data?: Record<string, any>
 }
@@ -181,6 +182,18 @@ type BuildVersionPluginOptions = {
 }
 ```
 
+### `timeZone`
+
+- 类型：`string`
+- 默认值：`"Asia/Shanghai"`
+- 作用：控制默认时间按哪个时区生成
+
+说明：
+
+- 只影响插件默认生成的 `time`
+- 如果构建环境是 UTC，也会按设置的时区输出
+- 如果传了 `version`，则以你自己的 `version` 逻辑为准
+
 ### `data`
 
 - 类型：`Record<string, any>`
@@ -301,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'

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,20 +141,20 @@ function toRequestPath(base, fileName) {
   const baseWithoutTrailingSlash = withLeadingSlash.endsWith("/") ? withLeadingSlash.slice(0, -1) : withLeadingSlash;
   return `${baseWithoutTrailingSlash}/${fileName}`.replace(/\/{2,}/g, "/");
 }
-function resolveVersion(options, context) {
+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);
+  return createDefaultVersion(context.command, timeZone);
 }
-function createPayload(options, context, data, packageInfo = {}) {
+function createPayload(options, context, data, timeZone, packageInfo = {}) {
   let nextPayload = {
     ...data,
     ...packageInfo,
-    time: resolveVersion(options, context),
+    time: resolveVersion(options, context, timeZone),
     env: context.mode
   };
   if (options.payload) {
@@ -143,6 +168,7 @@ function buildVersionPlugin(options = {}) {
     options.globalName ?? DEFAULT_GLOBAL_NAME
   );
   const injectToHtml = options.injectToHtml ?? true;
+  const timeZone = normalizeTimeZone(options.timeZone ?? DEFAULT_TIME_ZONE);
   const data = normalizeData(options.data);
   let payload;
   return {
@@ -153,7 +179,7 @@ function buildVersionPlugin(options = {}) {
         mode: config.mode
       };
       const packageInfo = readPackageInfo(config.root);
-      payload = createPayload(options, context, data, packageInfo);
+      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,20 +116,20 @@ function toRequestPath(base, fileName) {
   const baseWithoutTrailingSlash = withLeadingSlash.endsWith("/") ? withLeadingSlash.slice(0, -1) : withLeadingSlash;
   return `${baseWithoutTrailingSlash}/${fileName}`.replace(/\/{2,}/g, "/");
 }
-function resolveVersion(options, context) {
+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);
+  return createDefaultVersion(context.command, timeZone);
 }
-function createPayload(options, context, data, packageInfo = {}) {
+function createPayload(options, context, data, timeZone, packageInfo = {}) {
   let nextPayload = {
     ...data,
     ...packageInfo,
-    time: resolveVersion(options, context),
+    time: resolveVersion(options, context, timeZone),
     env: context.mode
   };
   if (options.payload) {
@@ -118,6 +143,7 @@ function buildVersionPlugin(options = {}) {
     options.globalName ?? DEFAULT_GLOBAL_NAME
   );
   const injectToHtml = options.injectToHtml ?? true;
+  const timeZone = normalizeTimeZone(options.timeZone ?? DEFAULT_TIME_ZONE);
   const data = normalizeData(options.data);
   let payload;
   return {
@@ -128,7 +154,7 @@ function buildVersionPlugin(options = {}) {
         mode: config.mode
       };
       const packageInfo = readPackageInfo(config.root);
-      payload = createPayload(options, context, data, packageInfo);
+      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.7",
+  "version": "0.1.8",
   "description": "A Vite plugin that emits version.json and injects version metadata into HTML.",
   "license": "MIT",
   "type": "module",