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

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 {};
@@ -104,6 +129,19 @@ function serializePayload(payload) {
   return `${JSON.stringify(payload, null, 2)}
 `;
 }
+function createInjectScript(globalName, payload) {
+  return `window[${JSON.stringify(globalName)}] = ${JSON.stringify(payload)};`;
+}
+function injectScriptToHead(code, script) {
+  const scriptTag = `<script>${script}</script>`;
+  if (code.includes(script)) {
+    return code;
+  }
+  if (code.includes("</head>")) {
+    return code.replace("</head>", `${scriptTag}</head>`);
+  }
+  return `${scriptTag}${code}`;
+}
 function parsePathname(requestUrl) {
   if (!requestUrl) {
     return "/";
@@ -116,20 +154,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,9 +181,16 @@ 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 {
+  const transformHtml = (code, ..._args) => {
+    if (!injectToHtml || !payload) {
+      return void 0;
+    }
+    return injectScriptToHead(code, createInjectScript(globalName, payload));
+  };
+  const plugin = {
     name: PLUGIN_NAME,
     configResolved(config) {
       const context = {
@@ -153,7 +198,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);
@@ -181,7 +226,7 @@ function buildVersionPlugin(options = {}) {
         {
           tag: "script",
           injectTo: "head",
-          children: `window[${JSON.stringify(globalName)}] = ${JSON.stringify(payload)};`
+          children: createInjectScript(globalName, payload)
         }
       ];
       return tags;
@@ -203,6 +248,10 @@ function buildVersionPlugin(options = {}) {
       }
     }
   };
+  Object.defineProperty(plugin, "transformHtml", {
+    value: transformHtml
+  });
+  return plugin;
 }
 var index_default = buildVersionPlugin;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.d.cts

@@ -13,11 +13,15 @@ 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;
     payload?: (json: any) => any;
 }
-declare function buildVersionPlugin(options?: BuildVersionPluginOptions): Plugin;
+type BuildVersionPlugin = Plugin & {
+    transformHtml: (code: string, ...args: unknown[]) => string | undefined;
+};
+declare function buildVersionPlugin(options?: BuildVersionPluginOptions): BuildVersionPlugin;
 
-export { type BuildVersionContext, type BuildVersionPayload, type BuildVersionPluginOptions, buildVersionPlugin, buildVersionPlugin as default };
+export { type BuildVersionContext, type BuildVersionPayload, type BuildVersionPlugin, type BuildVersionPluginOptions, buildVersionPlugin, buildVersionPlugin as default };

package/dist/index.d.ts

@@ -13,11 +13,15 @@ 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;
     payload?: (json: any) => any;
 }
-declare function buildVersionPlugin(options?: BuildVersionPluginOptions): Plugin;
+type BuildVersionPlugin = Plugin & {
+    transformHtml: (code: string, ...args: unknown[]) => string | undefined;
+};
+declare function buildVersionPlugin(options?: BuildVersionPluginOptions): BuildVersionPlugin;
 
-export { type BuildVersionContext, type BuildVersionPayload, type BuildVersionPluginOptions, buildVersionPlugin, buildVersionPlugin as default };
+export { type BuildVersionContext, type BuildVersionPayload, type BuildVersionPlugin, type BuildVersionPluginOptions, buildVersionPlugin, buildVersionPlugin as default };

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 {};
@@ -79,6 +104,19 @@ function serializePayload(payload) {
   return `${JSON.stringify(payload, null, 2)}
 `;
 }
+function createInjectScript(globalName, payload) {
+  return `window[${JSON.stringify(globalName)}] = ${JSON.stringify(payload)};`;
+}
+function injectScriptToHead(code, script) {
+  const scriptTag = `<script>${script}</script>`;
+  if (code.includes(script)) {
+    return code;
+  }
+  if (code.includes("</head>")) {
+    return code.replace("</head>", `${scriptTag}</head>`);
+  }
+  return `${scriptTag}${code}`;
+}
 function parsePathname(requestUrl) {
   if (!requestUrl) {
     return "/";
@@ -91,20 +129,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,9 +156,16 @@ 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 {
+  const transformHtml = (code, ..._args) => {
+    if (!injectToHtml || !payload) {
+      return void 0;
+    }
+    return injectScriptToHead(code, createInjectScript(globalName, payload));
+  };
+  const plugin = {
     name: PLUGIN_NAME,
     configResolved(config) {
       const context = {
@@ -128,7 +173,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);
@@ -156,7 +201,7 @@ function buildVersionPlugin(options = {}) {
         {
           tag: "script",
           injectTo: "head",
-          children: `window[${JSON.stringify(globalName)}] = ${JSON.stringify(payload)};`
+          children: createInjectScript(globalName, payload)
         }
       ];
       return tags;
@@ -178,6 +223,10 @@ function buildVersionPlugin(options = {}) {
       }
     }
   };
+  Object.defineProperty(plugin, "transformHtml", {
+    value: transformHtml
+  });
+  return plugin;
 }
 var index_default = buildVersionPlugin;
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-build-version-file",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "A Vite plugin that emits version.json and injects version metadata into HTML.",
   "license": "MIT",
   "type": "module",
@@ -23,7 +23,9 @@
   "scripts": {
     "build": "tsup --config tsup.config.ts",
     "build:fixture": "pnpm build && vite build --config debug/fixture-app/vite.config.ts",
+    "build:vitepress": "pnpm build && vitepress build debug/vitepress-app",
     "dev:fixture": "pnpm build && vite --config debug/fixture-app/vite.config.ts",
+    "dev:vitepress": "pnpm build && vitepress dev debug/vitepress-app",
     "prepublishOnly": "pnpm build:fixture"
   },
   "keywords": [
@@ -49,6 +51,7 @@
     "tsup": "^8.0.0",
     "typescript": "^5.0.0",
     "vite": "^5.0.0",
+    "vitepress": "^1.6.4",
     "vue": "^3.4.0"
   }
 }