build-version-tracker 0.0.1

package/README.md

@@ -0,0 +1,361 @@
+# Build Version Tracker
+
+一个通用的构建工具插件，用于版本跟踪和构建自动化（支持 Webpack 和 Vite）。
+
+## 功能特性
+
+- 📦 自动生成构建版本信息
+- 🔍 记录构建人、分支和时间
+- 📄 生成版本文件 (version.txt)
+- 🗜️ 自动打包构建产物为 ZIP 文件
+- 🌐 支持环境变量配置
+- ⚡ 同时支持 Webpack 和 Vite 构建工具
+- 🔧 支持 ES 模块和 CommonJS 模块
+
+## 安装
+
+### 基本安装
+
+```bash
+npm install build-version-tracker
+# 或
+pnpm add build-version-tracker
+# 或
+yarn add build-version-tracker
+```
+
+### 依赖安装
+
+插件需要以下依赖才能正常工作，请根据您的使用场景安装：
+
+#### 如果使用 Webpack 插件：
+```bash
+npm install adm-zip webpack
+# 或
+pnpm add adm-zip webpack
+# 或
+yarn add adm-zip webpack
+```
+
+#### 如果使用 Vite 插件：
+```bash
+npm install adm-zip
+# 或
+pnpm add adm-zip
+# 或
+yarn add adm-zip
+```
+
+#### 一次性安装所有依赖：
+ ```bash
+ npm install build-version-tracker adm-zip webpack
+ # 或
+ pnpm add build-version-tracker adm-zip webpack
+ # 或
+ yarn add build-version-tracker adm-zip webpack
+ ```
+
+## 本地开发测试
+
+### 使用 npm link 进行本地测试
+
+如果您想在本地其他项目中测试该插件，可以使用 `npm link` 方法：
+
+#### 1. 在插件项目中创建全局链接
+
+```bash
+# 进入插件项目目录
+cd build-version-tracker
+
+# 构建插件
+npm run build
+
+# 创建全局链接
+npm link
+```
+
+#### 2. 在测试项目中链接插件
+
+```bash
+# 进入测试项目目录
+cd /path/to/your/test-project
+
+# 链接插件
+npm link build-version-tracker
+
+# 安装插件的 peerDependencies
+npm install adm-zip webpack
+```
+
+#### 3. 在测试项目中使用插件
+
+```javascript
+// Webpack 配置示例
+const BuildVersionTracker = require('build-version-tracker');
+
+module.exports = {
+  // ... 其他配置
+  plugins: [
+    new BuildVersionTracker({
+      distPath: 'dist',
+      isBuild: true
+    })
+  ]
+};
+```
+
+#### 4. 取消链接（测试完成后）
+
+```bash
+# 在测试项目中取消链接
+npm unlink build-version-tracker
+
+# 重新安装正式版本（如果需要）
+npm install build-version-tracker
+
+# 在插件项目中取消全局链接
+cd build-version-tracker
+npm unlink
+```
+
+### 使用 pnpm link（如果使用 pnpm）
+
+```bash
+# 在插件项目中
+pnpm link --global
+
+# 在测试项目中
+pnpm link --global build-version-tracker
+```
+
+### 使用 yarn link（如果使用 yarn）
+
+```bash
+# 在插件项目中
+yarn link
+
+# 在测试项目中
+yarn link build-version-tracker
+```
+
+## 使用方法
+
+### Webpack 插件使用
+
+#### CommonJS 语法
+```javascript
+const BuildVersionTracker = require('build-version-tracker');
+
+module.exports = {
+  // ... 其他配置
+  plugins: [
+    new BuildVersionTracker({
+      distPath: 'dist',     // 构建输出目录，默认 'dist'
+      isBuild: false,      // 是否启用构建，默认 false
+      htmlName: 'index.html' // HTML 文件名，默认 'index.html'
+    })
+  ]
+};
+```
+
+#### ES 模块语法
+```javascript
+import BuildVersionTracker from 'build-version-tracker';
+
+export default {
+  // ... 其他配置
+  plugins: [
+    new BuildVersionTracker({
+      distPath: 'dist',
+      isBuild: false,
+      htmlName: 'index.html'
+    })
+  ]
+};
+```
+
+### Vite 插件使用
+
+#### CommonJS 语法
+```javascript
+const viteVersionPlugin = require('build-version-tracker/vite');
+
+export default {
+  plugins: [
+    viteVersionPlugin({
+      distPath: 'dist',     // 构建输出目录，默认 'dist'
+      isBuild: false,      // 是否启用构建，默认 false
+      htmlName: 'index.html' // HTML 文件名，默认 'index.html'
+    })
+  ]
+};
+```
+
+#### ES 模块语法
+```javascript
+import viteVersionPlugin from 'build-version-tracker/vite';
+
+export default {
+  plugins: [
+    viteVersionPlugin({
+      distPath: 'dist',
+      isBuild: false,
+      htmlName: 'index.html'
+    })
+  ]
+};
+```
+
+### 配置说明
+
+插件完全通过配置参数控制行为，不依赖环境变量。
+
+## 示例
+
+### Webpack 基础使用
+
+```javascript
+// webpack.config.js
+const BuildVersionTracker = require('build-version-tracker');
+
+module.exports = {
+  mode: 'production',
+  entry: './src/index.js',
+  output: {
+    path: path.resolve(__dirname, 'dist'),
+    filename: 'bundle.js'
+  },
+  plugins: [
+    new BuildVersionTracker()
+  ]
+};
+```
+
+### Vite 基础使用
+
+```javascript
+// vite.config.js
+import viteVersionPlugin from 'build-version-tracker/vite';
+
+export default {
+  plugins: [
+    viteVersionPlugin()
+  ],
+  build: {
+    outDir: 'dist'
+  }
+};
+```
+
+### 自定义配置
+
+```javascript
+// Webpack 自定义配置
+new BuildVersionTracker({
+  distPath: 'build',                    // 自定义输出目录
+  isBuild: true,                        // 启用构建功能
+  htmlName: 'app.html'                  // 自定义 HTML 文件名
+})
+
+// Vite 自定义配置
+viteVersionPlugin({
+  distPath: 'build',
+  isBuild: true,                        // 启用构建功能
+  htmlName: 'app.html'
+})
+
+// 明确配置构建参数（推荐方式）
+new BuildVersionTracker({
+  distPath: 'dist',        // 明确指定输出目录
+  isBuild: true,           // 明确控制构建行为
+  htmlName: 'index.html'
+})
+```
+
+## 输出文件
+
+插件会在构建完成后生成以下文件：
+
+1. **version.txt**: 包含构建信息的文本文件
+2. **dist.zip**: 构建产物的压缩包
+3. **HTML 文件更新**: 在 body 标签后插入版本信息脚本
+
+### version.txt 内容示例
+
+```
+构建人： username, 构建分支：main, 构建时间：2024-01-01 12:00:00，构建后文件位于：dist
+```
+
+### HTML 文件更新示例
+
+构建后，HTML 文件会在 `</body>` 标签前插入版本信息脚本：
+
+```html
+<script>console.log("%c构建人： username, 构建分支：main, 构建时间：2024-01-01 12:00:00", 'color:blue')</script>
+</body>
+```
+
+## API
+
+### Webpack 插件选项
+
+| 参数 | 类型 | 默认值 | 描述 |
+|------|------|--------|------|
+| distPath | string | 'dist' | 构建输出目录 |
+| isBuild | boolean | false | 是否启用构建功能 |
+| htmlName | string | 'index.html' | HTML 文件名 |
+
+### Vite 插件选项
+
+| 参数 | 类型 | 默认值 | 描述 |
+|------|------|--------|------|
+| distPath | string | 'dist' | 构建输出目录 |
+| isBuild | boolean | false | 是否启用构建功能 |
+| htmlName | string | 'index.html' | HTML 文件名 |
+
+## 开发
+
+### 项目结构
+
+```
+src/
+├── index.js          # Webpack 插件实现
+├── vite-plugin.js    # Vite 插件实现
+└── utils.js          # 公共工具函数
+```
+
+### 构建项目
+
+```bash
+pnpm run build
+# 或
+npm run build
+```
+
+### 运行测试
+
+```bash
+pnpm test
+# 或
+npm test
+```
+
+## 许可证
+
+MIT
+
+## 贡献
+
+欢迎提交 Issue 和 Pull Request！
+
+- **提交 Issue**: [GitHub Issues](https://github.com/mingyangya/build-version-tracker/issues)
+- **提交 Pull Request**: [GitHub Pull Requests](https://github.com/mingyangya/build-version-tracker/pulls)
+- **项目仓库**: [GitHub Repository](https://github.com/mingyangya/build-version-tracker)
+
+## 更新日志
+
+### v0.0.1
+- 初始版本发布
+- 支持 Webpack 和 Vite 构建工具
+- 支持 ES 模块和 CommonJS 模块
+- 自动生成版本信息和打包构建产物

package/dist/index.es

@@ -0,0 +1,35 @@
+import { g as m, k as h, w as d, u, p as g } from "./utils-DMG0M2rI.mjs";
+import i from "path";
+const { packageName: n } = m(), P = h(n, "Plugin"), s = n, f = class {
+  constructor(a) {
+    this.options = a || {};
+  }
+  apply(a) {
+    const t = this.options.distPath || "dist", c = this.options.isBuild || !1, r = this.options.htmlName || "index.html";
+    a.hooks.afterEmit.tapAsync(s, async (w, e) => {
+      if (!c) {
+        console.log(`⏭️ ${s} 构建已禁用，跳过版本信息生成`), e();
+        return;
+      }
+      try {
+        console.log(`📝 ${s} 开始生成版本信息...`);
+        const o = await d(t);
+        u(o, t, r);
+        const l = i.resolve(process.cwd(), t), p = i.resolve(process.cwd(), `${t}.zip`);
+        await g({
+          distDirPath: l,
+          outputZipPath: p
+        }), console.log(`✅ ${s} 版本信息生成完成`), e();
+      } catch (o) {
+        console.error(`❌ ${s} 版本信息生成失败:`, o), e(o);
+      }
+    });
+  }
+};
+Object.defineProperty(f, "name", {
+  value: P,
+  writable: !1
+});
+export {
+  f as default
+};

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";const s=require("./utils-BUNhE9qT.js"),n=require("path"),{packageName:c}=s.getPackageInfo(),m=s.kebabToPascalCase(c,"Plugin"),t=c,r=class{constructor(i){this.options=i||{}}apply(i){const o=this.options.distPath||"dist",l=this.options.isBuild||!1,p=this.options.htmlName||"index.html";i.hooks.afterEmit.tapAsync(t,async(d,a)=>{if(!l){console.log(`⏭️ ${t} 构建已禁用，跳过版本信息生成`),a();return}try{console.log(`📝 ${t} 开始生成版本信息...`);const e=await s.writeVersion(o);s.updateMainHtml(e,o,p);const u=n.resolve(process.cwd(),o),h=n.resolve(process.cwd(),`${o}.zip`);await s.packAndRenameDist({distDirPath:u,outputZipPath:h}),console.log(`✅ ${t} 版本信息生成完成`),a()}catch(e){console.error(`❌ ${t} 版本信息生成失败:`,e),a(e)}})}};Object.defineProperty(r,"name",{value:m,writable:!1});module.exports=r;

package/dist/utils-BUNhE9qT.js

@@ -0,0 +1 @@
+"use strict";const u=require("child_process"),m=require("adm-zip"),c=require("fs"),i=require("path");async function g({distDirPath:e,outputZipPath:t,distName:n="dist"}){try{if(!c.existsSync(e)||!c.statSync(e).isDirectory())throw new Error(`dist 文件夹不存在或不是目录：${e}`);const r=new m;r.addLocalFolder(e,n),r.writeZip(t),console.log(`✅ 操作完成！最终压缩包已保存至：${i.resolve(t)}`)}catch(r){throw console.error("❌ 打包/重命名失败：",r),r}}const p=()=>new Promise(e=>{u.exec("git config user.name",(t,n)=>{if(t){e("unknown");return}e(n.trim())})}),f=()=>new Promise(e=>{u.exec("git rev-parse --abbrev-ref HEAD",(t,n)=>{if(t){e("unknown");return}e(n.trim())})});function S(e){const t=e.getFullYear().toString().slice(0,4),n=(e.getMonth()+1).toString().padStart(2,"0"),r=e.getDate().toString().padStart(2,"0"),o=e.getHours().toString().padStart(2,"0"),s=e.getMinutes().toString().padStart(2,"0"),a=e.getSeconds().toString().padStart(2,"0");return`${t}-${n}-${r} ${o}:${s}:${a}`}const w=async e=>{const t=await p(),n=await f(),r=S(new Date),o=`构建人： ${t}, 构建分支：${n}, 构建时间：${r}`,s=`${o}，构建后文件位于：${e}`,a=i.resolve(process.cwd(),`${e}/version.txt`);console.log("-------------fileDistName------------",a);try{c.writeFileSync(a,s)}catch(l){throw console.error("❌ 写入版本信息失败：",l),l}return console.log(`%c======${s}======`,"color:blue"),o};function y(e,t,n="index.html"){const r=i.resolve(process.cwd(),`${t}/${n}`);if(c.existsSync(r)){let o=c.readFileSync(r,"utf-8");o=o.replace("</body>",`<script>console.log("%c${e}", 'color:blue')<\/script></body>`),c.writeFileSync(r,o,"utf-8")}}function $(){const e=i.resolve(__dirname,"../package.json"),t=JSON.parse(c.readFileSync(e,"utf-8")),n=t.name;return{packageJson:t,packageName:n}}function d(e,t=""){return e.split("-").map(n=>n.charAt(0).toUpperCase()+n.slice(1)).join("")+t}exports.getPackageInfo=$;exports.kebabToPascalCase=d;exports.packAndRenameDist=g;exports.updateMainHtml=y;exports.writeVersion=w;

package/dist/utils-DMG0M2rI.mjs

@@ -0,0 +1,69 @@
+import { exec as m } from "child_process";
+import p from "adm-zip";
+import c from "fs";
+import i from "path";
+async function d({ distDirPath: t, outputZipPath: e, distName: r = "dist" }) {
+  try {
+    if (!c.existsSync(t) || !c.statSync(t).isDirectory())
+      throw new Error(`dist 文件夹不存在或不是目录：${t}`);
+    const n = new p();
+    n.addLocalFolder(t, r), n.writeZip(e), console.log(`✅ 操作完成！最终压缩包已保存至：${i.resolve(e)}`);
+  } catch (n) {
+    throw console.error("❌ 打包/重命名失败：", n), n;
+  }
+}
+const g = () => new Promise((t) => {
+  m("git config user.name", (e, r) => {
+    if (e) {
+      t("unknown");
+      return;
+    }
+    t(r.trim());
+  });
+}), u = () => new Promise((t) => {
+  m("git rev-parse --abbrev-ref HEAD", (e, r) => {
+    if (e) {
+      t("unknown");
+      return;
+    }
+    t(r.trim());
+  });
+});
+function f(t) {
+  const e = t.getFullYear().toString().slice(0, 4), r = (t.getMonth() + 1).toString().padStart(2, "0"), n = t.getDate().toString().padStart(2, "0"), o = t.getHours().toString().padStart(2, "0"), s = t.getMinutes().toString().padStart(2, "0"), a = t.getSeconds().toString().padStart(2, "0");
+  return `${e}-${r}-${n} ${o}:${s}:${a}`;
+}
+const h = async (t) => {
+  const e = await g(), r = await u(), n = f(/* @__PURE__ */ new Date()), o = `构建人： ${e}, 构建分支：${r}, 构建时间：${n}`, s = `${o}，构建后文件位于：${t}`, a = i.resolve(process.cwd(), `${t}/version.txt`);
+  console.log("-------------fileDistName------------", a);
+  try {
+    c.writeFileSync(a, s);
+  } catch (l) {
+    throw console.error("❌ 写入版本信息失败：", l), l;
+  }
+  return console.log(`%c======${s}======`, "color:blue"), o;
+};
+function k(t, e, r = "index.html") {
+  const n = i.resolve(process.cwd(), `${e}/${r}`);
+  if (c.existsSync(n)) {
+    let o = c.readFileSync(n, "utf-8");
+    o = o.replace("</body>", `<script>console.log("%c${t}", 'color:blue')<\/script></body>`), c.writeFileSync(n, o, "utf-8");
+  }
+}
+function b() {
+  const t = i.resolve(__dirname, "../package.json"), e = JSON.parse(c.readFileSync(t, "utf-8")), r = e.name;
+  return {
+    packageJson: e,
+    packageName: r
+  };
+}
+function N(t, e = "") {
+  return t.split("-").map((r) => r.charAt(0).toUpperCase() + r.slice(1)).join("") + e;
+}
+export {
+  b as g,
+  N as k,
+  d as p,
+  k as u,
+  h as w
+};

package/dist/vite-plugin.es

@@ -0,0 +1,43 @@
+import { g as d, k as u, w as m, u as p, p as g } from "./utils-DMG0M2rI.mjs";
+import l from "path";
+const { packageName: n } = d(), f = u(n, "VitePlugin"), e = n;
+function h(s = {}) {
+  const t = s.distPath || "dist", o = s.isBuild || !1, i = s.htmlName || "index.html";
+  return {
+    name: e,
+    // 构建开始前的钩子
+    buildStart() {
+      console.log(`🚀 ${e} 开始构建...`);
+    },
+    // 构建结束后的钩子
+    buildEnd() {
+      o && console.log(`📝 ${e} 准备生成版本信息...`);
+    },
+    // 关闭钩子（构建完全结束后）
+    async closeBundle() {
+      if (!o) {
+        console.log(`⏭️ ${e} 构建已禁用，跳过版本信息生成`);
+        return;
+      }
+      try {
+        console.log(`📝 ${e} 开始生成版本信息...`);
+        const a = await m(t);
+        p(a, t, i);
+        const c = l.resolve(process.cwd(), t), r = l.resolve(process.cwd(), `${t}.zip`);
+        await g({
+          distDirPath: c,
+          outputZipPath: r
+        }), console.log(`✅ ${e} 版本信息生成完成`);
+      } catch (a) {
+        throw console.error(`❌ ${e} 版本信息生成失败:`, a), a;
+      }
+    }
+  };
+}
+Object.defineProperty(h, "name", {
+  value: f,
+  writable: !1
+});
+export {
+  h as default
+};

package/dist/vite-plugin.js

@@ -0,0 +1 @@
+"use strict";const t=require("./utils-BUNhE9qT.js"),c=require("path"),{packageName:i}=t.getPackageInfo(),m=t.kebabToPascalCase(i,"VitePlugin"),e=i;function l(a={}){const s=a.distPath||"dist",n=a.isBuild||!1,r=a.htmlName||"index.html";return{name:e,buildStart(){console.log(`🚀 ${e} 开始构建...`)},buildEnd(){n&&console.log(`📝 ${e} 准备生成版本信息...`)},async closeBundle(){if(!n){console.log(`⏭️ ${e} 构建已禁用，跳过版本信息生成`);return}try{console.log(`📝 ${e} 开始生成版本信息...`);const o=await t.writeVersion(s);t.updateMainHtml(o,s,r);const u=c.resolve(process.cwd(),s),d=c.resolve(process.cwd(),`${s}.zip`);await t.packAndRenameDist({distDirPath:u,outputZipPath:d}),console.log(`✅ ${e} 版本信息生成完成`)}catch(o){throw console.error(`❌ ${e} 版本信息生成失败:`,o),o}}}}Object.defineProperty(l,"name",{value:m,writable:!1});module.exports=l;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "build-version-tracker",
+  "description": "A universal build tool plugin for version tracking and build automation (supports Webpack and Vite)",
+  "keywords": ["build", "version", "tracker", "automation", "webpack", "vite", "plugin"],
+  "private": false,
+  "version": "0.0.1",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./vite": {
+      "import": "./dist/vite-plugin.js",
+      "require": "./dist/vite-plugin.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "test": "node ./test-simple.js"
+  },
+  "peerDependencies": {
+    "adm-zip": "^0.5.16",
+    "webpack": "^5.88.0"
+  },
+  "devDependencies": {
+    "vite": "^5.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mingyangya/build-version-tracker.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mingyangya/build-version-tracker/issues"
+  },
+  "homepage": "https://github.com/mingyangya/build-version-tracker#readme",
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}