vite-plugin-app-build-info 0.1.0

package/README.md

@@ -0,0 +1,102 @@
+# vite-plugin-app-build-info
+
+Vite 插件：构建时生成应用版本信息，并同时注入到 JS、HTML 和 `version.json`。
+
+## 安装
+
+```sh
+pnpm add -D vite-plugin-app-build-info
+```
+
+也可以使用 npm：
+
+```sh
+npm install -D vite-plugin-app-build-info
+```
+
+## 使用
+
+```ts
+import { defineConfig } from 'vite'
+import buildInfo from 'vite-plugin-app-build-info'
+
+export default defineConfig({
+  plugins: [buildInfo()],
+})
+```
+
+默认会生成三类输出：
+
+- 前端代码可读取 `__APP_INFO__`
+- 构建产物包含 `dist/version.json`
+- `index.html` 的 `head` 内包含 `app-build-info` meta 标签
+
+## 本地开发
+
+在仓库根目录安装依赖：
+
+```sh
+pnpm install
+```
+
+构建插件：
+
+```sh
+pnpm --filter vite-plugin-app-build-info build
+```
+
+发布前检查 npm 包内容：
+
+```sh
+pnpm --filter vite-plugin-app-build-info pack:dry-run
+```
+
+## 发布到 npmjs
+
+首次发布前先登录 npmjs：
+
+```sh
+npm login --registry https://registry.npmjs.org/
+```
+
+确认版本号后，在仓库根目录执行：
+
+```sh
+pnpm publish:plugin
+```
+
+发布脚本会先自动重新构建 `dist` 后再发布公开包。
+
+如果你本机默认 npm registry 是公司内网源，发布时不用手动切换；包内 `publishConfig` 和根目录发布脚本已经显式指定 `https://registry.npmjs.org/`。
+
+## 类型声明
+
+如果要在前端代码里读取默认的 `__APP_INFO__`，可以在项目的 `env.d.ts` 中声明：
+
+```ts
+declare const __APP_INFO__: {
+  name: string
+  version: string
+  commit: string
+  branch: string
+  commitTime: string
+  buildTime: string
+  builder?: string
+}
+```
+
+## 配置
+
+```ts
+buildInfo({
+  globalName: '__APP_INFO__',
+  jsonFileName: 'version.json',
+  metaName: 'app-build-info',
+  includeBuilder: true,
+})
+```
+
+- `globalName`：注入到 JS bundle 的全局常量名
+- `jsonFileName`：输出的 JSON 文件名
+- `metaName`：HTML meta 标签的 `name`
+- `includeBuilder`：是否记录本机打包用户和主机名

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import type { Plugin } from 'vite';
+export type AppBuildInfo = {
+    name: string;
+    version: string;
+    commit: string;
+    branch: string;
+    commitTime: string;
+    buildTime: string;
+    builder?: string;
+};
+export type BuildInfoPluginOptions = {
+    globalName?: string;
+    jsonFileName?: string;
+    metaName?: string;
+    includeBuilder?: boolean;
+};
+export default function buildInfoPlugin(options?: BuildInfoPluginOptions): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAA;AAElC,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB,CAAA;AAyDD,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,MAAM,CA4CpF"}

package/dist/index.js

@@ -0,0 +1,90 @@
+import { execSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import { hostname, userInfo } from 'node:os';
+import { resolve } from 'node:path';
+const defaultOptions = {
+    globalName: '__APP_INFO__',
+    jsonFileName: 'version.json',
+    metaName: 'app-build-info',
+    includeBuilder: true,
+};
+function git(cmd, cwd) {
+    try {
+        return execSync(cmd, { cwd, encoding: 'utf-8' }).trim();
+    }
+    catch {
+        return 'unknown';
+    }
+}
+function formatGitTime(value) {
+    if (value === 'unknown')
+        return value;
+    const date = new Date(value);
+    if (Number.isNaN(date.getTime()))
+        return 'unknown';
+    return date.toLocaleString('sv');
+}
+function readPackageJson(root) {
+    try {
+        return JSON.parse(readFileSync(resolve(root, 'package.json'), 'utf-8'));
+    }
+    catch {
+        return {};
+    }
+}
+function createBuildInfo(root, includeBuilder) {
+    const pkg = readPackageJson(root);
+    const info = {
+        name: pkg.name ?? 'unknown',
+        version: pkg.version ?? 'unknown',
+        commit: git('git rev-parse --short=8 HEAD', root),
+        branch: git('git rev-parse --abbrev-ref HEAD', root),
+        commitTime: formatGitTime(git('git log -1 --format=%cI', root)),
+        buildTime: new Date().toLocaleString('sv'),
+    };
+    if (includeBuilder) {
+        info.builder = `${userInfo().username}@${hostname()}`;
+    }
+    return info;
+}
+export default function buildInfoPlugin(options = {}) {
+    const resolvedOptions = { ...defaultOptions, ...options };
+    let buildInfo;
+    function getBuildInfo(root = process.cwd()) {
+        buildInfo ??= createBuildInfo(root, resolvedOptions.includeBuilder);
+        return buildInfo;
+    }
+    return {
+        name: 'vite-plugin-app-build-info',
+        config(config) {
+            const root = config.root ? resolve(config.root) : process.cwd();
+            const info = getBuildInfo(root);
+            return {
+                define: {
+                    [resolvedOptions.globalName]: JSON.stringify(info),
+                },
+            };
+        },
+        transformIndexHtml() {
+            const info = getBuildInfo();
+            const content = [info.commit, info.buildTime, info.builder].filter(Boolean).join(' | ');
+            return [
+                {
+                    tag: 'meta',
+                    attrs: {
+                        name: resolvedOptions.metaName,
+                        content,
+                    },
+                    injectTo: 'head',
+                },
+            ];
+        },
+        generateBundle() {
+            this.emitFile({
+                type: 'asset',
+                fileName: resolvedOptions.jsonFileName,
+                source: JSON.stringify(getBuildInfo(), null, 2),
+            });
+        },
+    };
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "vite-plugin-app-build-info",
+  "version": "0.1.0",
+  "description": "Inject app build metadata into Vite bundles, HTML, and version.json.",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "vite",
+    "vite-plugin",
+    "build-info",
+    "version",
+    "metadata"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "peerDependencies": {
+    "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.2",
+    "typescript": "~6.0.0",
+    "vite": "^8.0.16"
+  }
+}