@frefly/print-build-info 0.0.0-stage → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +94 -2
  2. package/index.js +68 -0
  3. package/package.json +18 -3
package/README.md CHANGED
@@ -1,3 +1,95 @@
1
- # Temporary Holding Version
1
+ # @frefly/print-build-info
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ 前端打包信息输出 Vite 插件。在 `vite build` 结束后,将本次构建的元信息(运行指令、分支、提交 id、打包时长、Node/V8 版本、`VITE_*` 环境变量等)写入项目根目录的 `buildInfo.txt`。
4
+
5
+ ## 安装
6
+
7
+ ```bash
8
+ pnpm add -D @frefly/print-build-info
9
+ ```
10
+
11
+ ## 使用
12
+
13
+ 在 `vite.config.js` 中注册插件,并把 `loadEnv` 返回的环境变量传入:
14
+
15
+ ```js
16
+ import { defineConfig, loadEnv } from 'vite'
17
+ import { printBuildInfo } from '@frefly/print-build-info'
18
+
19
+ export default defineConfig(({ mode }) => {
20
+ const env = loadEnv(mode, process.cwd())
21
+
22
+ return {
23
+ plugins: [printBuildInfo(env)]
24
+ }
25
+ })
26
+ ```
27
+
28
+ 执行 `vite build` 后,会在项目根目录生成 `buildInfo.txt`。
29
+
30
+ > 插件仅在 `build` 命令下生效(`apply: 'build'`),`vite dev` 不会注册其钩子。
31
+
32
+ ## 输出示例
33
+
34
+ ```
35
+ 运行指令:vite build --mode sit
36
+ 当前运行环境:sit
37
+ 当前打包分支:main
38
+ 分支最后提交id:4a4f802fb58f59bc13111f264c401012345e852d
39
+ 打包开始时间:2026/6/22 17:30:33
40
+ 打包结束时间:2026/6/22 17:30:35
41
+ 打包花费时长:2.12s
42
+ 当前node版本:v22.22.1
43
+ 当前v8内核版本:12.4.254.21-node.19
44
+ NODE_ENV:production
45
+
46
+ 全局变量:
47
+ VITE_APP_ENV=sit
48
+ VITE_APP_BASE_API=/api
49
+ ```
50
+
51
+ 输出字段说明:
52
+
53
+ | 字段 | 来源 |
54
+ | -------------- | ----------------------------------------------- |
55
+ | 运行指令 | `process.env.npm_lifecycle_script` |
56
+ | 当前运行环境 | `env.VITE_APP_ENV` |
57
+ | 当前打包分支 | `git rev-parse --abbrev-ref HEAD`(失败时为空) |
58
+ | 分支最后提交id | `git rev-parse HEAD`(失败时为空) |
59
+ | 打包开始时间 | `buildStart` 钩子触发时刻 |
60
+ | 打包结束时间 | `buildEnd` 钩子触发时刻 |
61
+ | 打包花费时长 | `buildEnd - buildStart`(秒,保留 2 位小数) |
62
+ | 当前node版本 | `process.version` |
63
+ | 当前v8内核版本 | `process.versions.v8` |
64
+ | NODE_ENV | `process.env.NODE_ENV` |
65
+ | 全局变量 | `env` 中所有以 `VITE_` 开头的键值对 |
66
+
67
+ ## API
68
+
69
+ ### `printBuildInfo(env)`
70
+
71
+ | 参数 | 类型 | 必填 | 说明 |
72
+ | ----- | ------------------------ | ---- | -------------------------------------------------------------------- |
73
+ | `env` | `Record<string, string>` | 是 | Vite `loadEnv()` 返回的环境变量对象。只有 `VITE_` 前缀的键会被写入。 |
74
+
75
+ 返回值为 Vite 插件对象:
76
+
77
+ | 属性 | 值 |
78
+ | --------- | ------------------ |
79
+ | `name` | `'printBuildInfo'` |
80
+ | `enforce` | `'post'` |
81
+ | `apply` | `'build'` |
82
+
83
+ ## 输出位置
84
+
85
+ `buildInfo.txt` 写入 Vite 的 `config.root`(即调用方项目根目录)。不依赖 `process.cwd()`,因此在 monorepo / 通过 `--config` 指定外部配置文件等场景下也能写到正确位置。
86
+
87
+ ## 注意事项
88
+
89
+ - 非 git 仓库或未安装 git 时,分支与提交 id 字段会留空,不会中断构建。
90
+ - `buildEnd` 在同一次构建中可能被多次触发,插件内部做了幂等保护,文件只会写一次。
91
+ - 构建失败时(`buildEnd(err)` 收到 error)不会写入文件。
92
+
93
+ ## 许可证
94
+
95
+ MIT
package/index.js ADDED
@@ -0,0 +1,68 @@
1
+ import { execSync } from 'node:child_process'
2
+ import fs from 'node:fs'
3
+ import path from 'node:path'
4
+
5
+ /**
6
+ * 执行 git 命令并返回 trim 后的输出;命令失败时返回空字符串
7
+ * @param {string} cmd
8
+ * @returns {string}
9
+ */
10
+ const safeGit = cmd => {
11
+ try {
12
+ return execSync(cmd, { encoding: 'utf-8', stdio: ['ignore', 'pipe', 'ignore'] }).trim()
13
+ } catch {
14
+ return ''
15
+ }
16
+ }
17
+
18
+ /**
19
+ * Vite 插件:在构建结束时将打包信息写入项目根目录下的 buildInfo.txt
20
+ * @param {Record<string, string>} env Vite loadEnv 返回的环境变量对象
21
+ * @returns {import('vite').Plugin}
22
+ */
23
+ export const printBuildInfo = env => {
24
+ let projectRoot = process.cwd()
25
+ let startTime = 0
26
+ let written = false
27
+
28
+ return {
29
+ name: 'printBuildInfo',
30
+ enforce: 'post',
31
+ apply: 'build',
32
+ configResolved(config) {
33
+ projectRoot = config.root || process.cwd()
34
+ },
35
+ buildStart() {
36
+ startTime = Date.now()
37
+ },
38
+ buildEnd(err) {
39
+ if (err || written) return
40
+ written = true
41
+
42
+ const endTime = Date.now()
43
+ const lines = [
44
+ `运行指令:${process.env.npm_lifecycle_script ?? ''}`,
45
+ `当前运行环境:${env.VITE_APP_ENV ?? ''}`,
46
+ `当前打包分支:${safeGit('git rev-parse --abbrev-ref HEAD')}`,
47
+ `分支最后提交id:${safeGit('git rev-parse HEAD')}`,
48
+ `打包开始时间:${new Date(startTime).toLocaleString()}`,
49
+ `打包结束时间:${new Date(endTime).toLocaleString()}`,
50
+ `打包花费时长:${((endTime - startTime) / 1000).toFixed(2)}s`,
51
+ `当前node版本:${process.version}`,
52
+ `当前v8内核版本:${process.versions.v8}`,
53
+ `NODE_ENV:${process.env.NODE_ENV ?? ''}`,
54
+ '',
55
+ '全局变量:'
56
+ ]
57
+
58
+ for (const key of Object.keys(env)) {
59
+ if (key.startsWith('VITE_')) {
60
+ lines.push(`${key}=${env[key]}`)
61
+ }
62
+ }
63
+
64
+ const outputPath = path.resolve(projectRoot, 'buildInfo.txt')
65
+ fs.writeFileSync(outputPath, lines.join('\n'), 'utf-8')
66
+ }
67
+ }
68
+ }
package/package.json CHANGED
@@ -1,6 +1,21 @@
1
1
  {
2
2
  "name": "@frefly/print-build-info",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "1.0.0",
4
+ "description": "前端打包信息输出配置",
5
+ "type": "module",
6
+ "main": "index.js",
7
+ "exports": {
8
+ ".": "./index.js"
9
+ },
10
+ "publishConfig": {
11
+ "access": "public"
12
+ },
13
+ "files": [
14
+ "index.js",
15
+ "README.md"
16
+ ],
17
+ "license": "MIT",
18
+ "scripts": {
19
+ "release": "pnpm publish --no-git-checks"
20
+ }
6
21
  }