xzh-vite-plugin-version 1.0.0

package/README.md

@@ -0,0 +1,98 @@
+# @xzh/vite-plugin-version
+
+> 一个 Vite 插件，用于在构建时生成包含版本信息的 version.json 文件
+
+## 特性
+
+- 📦 构建时自动生成版本信息
+- 🔧 包含 Git 提交哈希
+- ⚙️ 高度可配置
+- 📝 支持 TypeScript
+- 🌳 支持树摇优化
+
+## 安装
+
+```bash
+npm install @xzh/vite-plugin-version -D
+# 或
+pnpm add @xzh/vite-plugin-version -D
+# 或
+yarn add @xzh/vite-plugin-version -D
+```
+
+## 使用方法
+
+### 基础用法
+
+```ts
+// vite.config.ts
+import { defineConfig } from "vite";
+import versionPlugin from "@xzh/vite-plugin-version";
+
+export default defineConfig({
+  plugins: [versionPlugin()],
+});
+```
+
+这会在构建输出目录生成 `version.json` 文件：
+
+```json
+{
+  "name": "your-project-name",
+  "version": "1.0.0",
+  "buildTime": "2024-01-01T12:00:00.000Z",
+  "gitCommit": "abc1234"
+}
+```
+
+### 高级选项
+
+```ts
+import { defineConfig } from "vite";
+import versionPlugin from "@xzh/vite-plugin-version";
+
+export default defineConfig({
+  plugins: [
+    versionPlugin({
+      // 自定义输出文件名
+      filename: "build-info.json",
+
+      // 输出到子目录
+      outDir: "meta",
+
+      // 禁用 git 提交哈希
+      gitCommit: false,
+
+      // 自定义转换器
+      transform: (info) => ({
+        ...info,
+        appName: "我的应用",
+        environment: process.env.NODE_ENV,
+      }),
+
+      // 禁用控制台输出
+      verbose: false,
+    }),
+  ],
+});
+```
+
+### 在应用中读取版本信息
+
+```ts
+// 运行时获取
+const versionInfo = await fetch("/version.json").then((r) => r.json());
+console.log(versionInfo.version);
+```
+
+## 配置选项
+
+| 选项        | 类型            | 默认值                 | 描述                         |
+| ----------- | --------------- | ---------------------- | ---------------------------- |
+| `name`      | `string`        | `package.json#name`    | 包名                         |
+| `version`   | `string`        | `package.json#version` | 版本号                       |
+| `outDir`    | `string`        | `''`                   | 输出目录（相对于构建根目录） |
+| `filename`  | `string`        | `'version.json'`       | 输出文件名                   |
+| `gitCommit` | `boolean`       | `true`                 | 是否包含 git 提交哈希        |
+| `transform` | `(info) => any` | `undefined`            | 自定义转换函数               |
+| `verbose`   | `boolean`       | `true`                 | 是否显示控制台输出           |

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { Plugin } from 'vite';
+
+interface VersionInfo {
+    name: string;
+    version: string;
+    buildTime: string;
+    gitCommit: string;
+}
+interface VersionPluginOptions {
+    /**
+     * 包名（默认从 process.cwd() 的 package.json 读取）
+     */
+    name?: string;
+    /**
+     * 版本号（默认从 process.cwd() 的 package.json 读取）
+     */
+    version?: string;
+    /**
+     * 输出目录（相对于 build.outDir 或 process.cwd()）
+     * @default '' (输出到构建根目录)
+     */
+    outDir?: string;
+    /**
+     * 输出文件名
+     * @default 'version.json'
+     */
+    filename?: string;
+    /**
+     * 是否获取 git 提交哈希
+     * @default true
+     */
+    gitCommit?: boolean;
+    /**
+     * 自定义版本信息转换器
+     */
+    transform?: (info: VersionInfo) => Record<string, any>;
+    /**
+     * 是否显示控制台输出
+     * @default true
+     */
+    verbose?: boolean;
+}
+/**
+ * Vite 插件：生成包含构建信息的 version.json 文件
+ */
+declare function versionPlugin(options?: VersionPluginOptions): Plugin;
+
+export { type VersionInfo, type VersionPluginOptions, versionPlugin as default, versionPlugin };

package/dist/index.js

@@ -0,0 +1,74 @@
+import { resolve } from 'path';
+import fs from 'fs';
+import { execSync } from 'child_process';
+
+// src/index.ts
+function versionPlugin(options = {}) {
+  const {
+    name: pkgName,
+    version: pkgVersion,
+    outDir = "",
+    filename = "version.json",
+    gitCommit = true,
+    transform,
+    verbose = true
+  } = options;
+  return {
+    name: "vite-plugin-version",
+    apply: "build",
+    writeBundle({ dir }) {
+      try {
+        let name = pkgName;
+        let version = pkgVersion;
+        if (!name || !version) {
+          const pkgPath = resolve(process.cwd(), "package.json");
+          if (fs.existsSync(pkgPath)) {
+            const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+            name = name || pkg.name;
+            version = version || pkg.version;
+          }
+        }
+        let commitHash = "unknown";
+        if (gitCommit) {
+          try {
+            commitHash = execSync("git rev-parse --short HEAD").toString().trim();
+          } catch {
+            commitHash = "unknown";
+          }
+        }
+        const versionInfo = {
+          name: name || "unknown",
+          version: version || "0.0.0",
+          buildTime: (/* @__PURE__ */ new Date()).toISOString(),
+          gitCommit: commitHash
+        };
+        const finalInfo = transform ? transform(versionInfo) : versionInfo;
+        const buildDir = dir || resolve(process.cwd(), "dist");
+        const outputPath = resolve(buildDir, outDir, filename);
+        const outputDir = resolve(buildDir, outDir);
+        if (!fs.existsSync(outputDir)) {
+          fs.mkdirSync(outputDir, { recursive: true });
+        }
+        fs.writeFileSync(outputPath, JSON.stringify(finalInfo, null, 2), "utf-8");
+        if (verbose) {
+          console.log("\n\u2705 \u7248\u672C\u4FE1\u606F\u6587\u4EF6\u5DF2\u751F\u6210:");
+          console.log(`   \u8DEF\u5F84: ${outputPath}`);
+          console.log(`   \u7248\u672C: ${versionInfo.version}`);
+          if (gitCommit) {
+            console.log(`   Git \u63D0\u4EA4: ${versionInfo.gitCommit}`);
+          }
+          console.log(`   \u6784\u5EFA\u65F6\u95F4: ${versionInfo.buildTime}
+`);
+        }
+      } catch (error) {
+        console.error("\u274C \u751F\u6210\u7248\u672C\u4FE1\u606F\u6587\u4EF6\u5931\u8D25:", error);
+        throw error;
+      }
+    }
+  };
+}
+var index_default = versionPlugin;
+
+export { index_default as default, versionPlugin };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAkDO,SAAS,aAAA,CAAc,OAAA,GAAgC,EAAC,EAAW;AACxE,EAAA,MAAM;AAAA,IACJ,IAAA,EAAM,OAAA;AAAA,IACN,OAAA,EAAS,UAAA;AAAA,IACT,MAAA,GAAS,EAAA;AAAA,IACT,QAAA,GAAW,cAAA;AAAA,IACX,SAAA,GAAY,IAAA;AAAA,IACZ,SAAA;AAAA,IACA,OAAA,GAAU;AAAA,GACZ,GAAI,OAAA;AAEJ,EAAA,OAAO;AAAA,IACL,IAAA,EAAM,qBAAA;AAAA,IACN,KAAA,EAAO,OAAA;AAAA,IACP,WAAA,CAAY,EAAE,GAAA,EAAI,EAAG;AACnB,MAAA,IAAI;AAEF,QAAA,IAAI,IAAA,GAAO,OAAA;AACX,QAAA,IAAI,OAAA,GAAU,UAAA;AAEd,QAAA,IAAI,CAAC,IAAA,IAAQ,CAAC,OAAA,EAAS;AACrB,UAAA,MAAM,OAAA,GAAU,OAAA,CAAQ,OAAA,CAAQ,GAAA,IAAO,cAAc,CAAA;AACrD,UAAA,IAAI,EAAA,CAAG,UAAA,CAAW,OAAO,CAAA,EAAG;AAC1B,YAAA,MAAM,MAAM,IAAA,CAAK,KAAA,CAAM,GAAG,YAAA,CAAa,OAAA,EAAS,OAAO,CAAC,CAAA;AACxD,YAAA,IAAA,GAAO,QAAQ,GAAA,CAAI,IAAA;AACnB,YAAA,OAAA,GAAU,WAAW,GAAA,CAAI,OAAA;AAAA,UAC3B;AAAA,QACF;AAGA,QAAA,IAAI,UAAA,GAAa,SAAA;AACjB,QAAA,IAAI,SAAA,EAAW;AACb,UAAA,IAAI;AACF,YAAA,UAAA,GAAa,QAAA,CAAS,4BAA4B,CAAA,CAAE,QAAA,GAAW,IAAA,EAAK;AAAA,UACtE,CAAA,CAAA,MAAQ;AACN,YAAA,UAAA,GAAa,SAAA;AAAA,UACf;AAAA,QACF;AAGA,QAAA,MAAM,WAAA,GAA2B;AAAA,UAC/B,MAAM,IAAA,IAAQ,SAAA;AAAA,UACd,SAAS,OAAA,IAAW,OAAA;AAAA,UACpB,SAAA,EAAA,iBAAW,IAAI,IAAA,EAAK,EAAE,WAAA,EAAY;AAAA,UAClC,SAAA,EAAW;AAAA,SACb;AAGA,QAAA,MAAM,SAAA,GAAY,SAAA,GAAY,SAAA,CAAU,WAAW,CAAA,GAAI,WAAA;AAGvD,QAAA,MAAM,WAAW,GAAA,IAAO,OAAA,CAAQ,OAAA,CAAQ,GAAA,IAAO,MAAM,CAAA;AACrD,QAAA,MAAM,UAAA,GAAa,OAAA,CAAQ,QAAA,EAAU,MAAA,EAAQ,QAAQ,CAAA;AAGrD,QAAA,MAAM,SAAA,GAAY,OAAA,CAAQ,QAAA,EAAU,MAAM,CAAA;AAC1C,QAAA,IAAI,CAAC,EAAA,CAAG,UAAA,CAAW,SAAS,CAAA,EAAG;AAC7B,UAAA,EAAA,CAAG,SAAA,CAAU,SAAA,EAAW,EAAE,SAAA,EAAW,MAAM,CAAA;AAAA,QAC7C;AAGA,QAAA,EAAA,CAAG,aAAA,CAAc,YAAY,IAAA,CAAK,SAAA,CAAU,WAAW,IAAA,EAAM,CAAC,GAAG,OAAO,CAAA;AAExE,QAAA,IAAI,OAAA,EAAS;AACX,UAAA,OAAA,CAAQ,IAAI,kEAAgB,CAAA;AAC5B,UAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,iBAAA,EAAU,UAAU,CAAA,CAAE,CAAA;AAClC,UAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,iBAAA,EAAU,WAAA,CAAY,OAAO,CAAA,CAAE,CAAA;AAC3C,UAAA,IAAI,SAAA,EAAW;AACb,YAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,qBAAA,EAAc,WAAA,CAAY,SAAS,CAAA,CAAE,CAAA;AAAA,UACnD;AACA,UAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,6BAAA,EAAY,WAAA,CAAY,SAAS;AAAA,CAAI,CAAA;AAAA,QACnD;AAAA,MACF,SAAS,KAAA,EAAO;AACd,QAAA,OAAA,CAAQ,KAAA,CAAM,wEAAiB,KAAK,CAAA;AACpC,QAAA,MAAM,KAAA;AAAA,MACR;AAAA,IACF;AAAA,GACF;AACF;AAEA,IAAO,aAAA,GAAQ","file":"index.js","sourcesContent":["import { Plugin } from \"vite\";\nimport { resolve } from \"path\";\nimport fs from \"fs\";\nimport { execSync } from \"child_process\";\n\nexport interface VersionInfo {\n  name: string;\n  version: string;\n  buildTime: string;\n  gitCommit: string;\n}\n\nexport interface VersionPluginOptions {\n  /**\n   * 包名（默认从 process.cwd() 的 package.json 读取）\n   */\n  name?: string;\n  /**\n   * 版本号（默认从 process.cwd() 的 package.json 读取）\n   */\n  version?: string;\n  /**\n   * 输出目录（相对于 build.outDir 或 process.cwd()）\n   * @default '' (输出到构建根目录)\n   */\n  outDir?: string;\n  /**\n   * 输出文件名\n   * @default 'version.json'\n   */\n  filename?: string;\n  /**\n   * 是否获取 git 提交哈希\n   * @default true\n   */\n  gitCommit?: boolean;\n  /**\n   * 自定义版本信息转换器\n   */\n  transform?: (info: VersionInfo) => Record<string, any>;\n  /**\n   * 是否显示控制台输出\n   * @default true\n   */\n  verbose?: boolean;\n}\n\n/**\n * Vite 插件：生成包含构建信息的 version.json 文件\n */\nexport function versionPlugin(options: VersionPluginOptions = {}): Plugin {\n  const {\n    name: pkgName,\n    version: pkgVersion,\n    outDir = \"\",\n    filename = \"version.json\",\n    gitCommit = true,\n    transform,\n    verbose = true\n  } = options;\n\n  return {\n    name: \"vite-plugin-version\",\n    apply: \"build\",\n    writeBundle({ dir }) {\n      try {\n        // 如果未提供，从 package.json 获取包信息\n        let name = pkgName;\n        let version = pkgVersion;\n\n        if (!name || !version) {\n          const pkgPath = resolve(process.cwd(), \"package.json\");\n          if (fs.existsSync(pkgPath)) {\n            const pkg = JSON.parse(fs.readFileSync(pkgPath, \"utf-8\"));\n            name = name || pkg.name;\n            version = version || pkg.version;\n          }\n        }\n\n        // 获取 git 提交哈希\n        let commitHash = \"unknown\";\n        if (gitCommit) {\n          try {\n            commitHash = execSync(\"git rev-parse --short HEAD\").toString().trim();\n          } catch {\n            commitHash = \"unknown\";\n          }\n        }\n\n        // 构建版本信息\n        const versionInfo: VersionInfo = {\n          name: name || \"unknown\",\n          version: version || \"0.0.0\",\n          buildTime: new Date().toISOString(),\n          gitCommit: commitHash\n        };\n\n        // 应用自定义转换器\n        const finalInfo = transform ? transform(versionInfo) : versionInfo;\n\n        // 确定输出路径\n        const buildDir = dir || resolve(process.cwd(), \"dist\");\n        const outputPath = resolve(buildDir, outDir, filename);\n\n        // 确保输出目录存在\n        const outputDir = resolve(buildDir, outDir);\n        if (!fs.existsSync(outputDir)) {\n          fs.mkdirSync(outputDir, { recursive: true });\n        }\n\n        // 写入版本文件\n        fs.writeFileSync(outputPath, JSON.stringify(finalInfo, null, 2), \"utf-8\");\n\n        if (verbose) {\n          console.log(\"\\n✅ 版本信息文件已生成:\");\n          console.log(`   路径: ${outputPath}`);\n          console.log(`   版本: ${versionInfo.version}`);\n          if (gitCommit) {\n            console.log(`   Git 提交: ${versionInfo.gitCommit}`);\n          }\n          console.log(`   构建时间: ${versionInfo.buildTime}\\n`);\n        }\n      } catch (error) {\n        console.error(\"❌ 生成版本信息文件失败:\", error);\n        throw error;\n      }\n    }\n  };\n}\n\nexport default versionPlugin;\n"]}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "xzh-vite-plugin-version",
+  "version": "1.0.0",
+  "description": "A Vite plugin that generates version.json file with build info",
+  "author": "SwordGate",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "vite",
+    "plugin",
+    "version",
+    "build-info"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "prepublishOnly": "pnpm run build"
+  },
+  "peerDependencies": {
+    "vite": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.19.2",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.2",
+    "vite": "^5.4.11"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/your-username/vite-plugin-version.git"
+  },
+  "bugs": {
+    "url": "https://github.com/your-username/vite-plugin-version/issues"
+  },
+  "homepage": "https://github.com/your-username/vite-plugin-version#readme"
+}