hbuilder-build-move 0.0.6 → 0.0.7

package/README.md

@@ -1,9 +1,88 @@
-# HBuilderX 工具打包 H5 资源后，将资源移动到指定目录
+# hbuilder-build-move
+
+HBuilderX 打包 H5 之后，一条命令把产物从 `unpackage/dist/build/web` 同步到项目里指定的目录，并顺手 `git add / commit / push`。
+
+省掉每次发版都要做的三件事：手动复制、手动粘贴、手动提交。
+
+## 安装
+
+```shell
+npm i -g hbuilder-build-move
+```
+
+命令名是 `hbm`，装完直接可用（不想全局装也可以用 `npx hbm`）。
+
+环境要求：
+
+- Node.js 18 及以上
+- 项目已初始化 git，且命令行能正常 `git push`（SSH key 或凭据已配好）
+
+## 用法
+
+在 **HBuilderX 项目根目录** 下执行：
 
 ```shell
-hbm build_commit_info
-# 目标目录默认值是 build/h5，可以自定义，例如：
-hbm build_commit_info -t dist
+# 打包完成后，提交并推送，commit 信息为「更新首页样式」
+hbm 更新首页样式
+
+# 目标目录默认是 build/h5，可以改成别的
+hbm 更新首页样式 -t dist
+
+# 目标目录可以是多级路径，不存在会自动创建
+hbm 更新首页样式 -t static/h5
 ```
 
+| 参数 | 说明 | 默认值 |
+| --- | --- | --- |
+| `[string]` | git commit 信息，最终会拼成 `build: <你的信息>` | `test` |
+| `-t, --target <path>` | 产物输出目录，相对项目根目录 | `build/h5` |
+| `-V, --version` | 查看版本 | - |
+| `-h, --help` | 查看帮助 | - |
+
+## 执行流程
+
+1. 从当前工作目录向上查找，第一个含 `package.json` 或 `.git` 的目录认作项目根目录
+2. 检查项目根目录下有没有 `.git`，没有就报错退出
+3. 检查 `unpackage/dist/build/web/index.html` 是否存在，不存在说明还没打包，报错退出
+4. 目标目录：不存在则创建；已存在则整个删掉重建
+5. 递归把产物拷到目标目录（源产物保留）
+6. 依次执行 `git add .`、`git commit -m "build: <信息>"`、`git push`，任何一步失败立即中断
+
+跑起来的样子：
+
 ![image](assets/image.png)
+
+## 注意事项
+
+- **在项目根目录或其子目录里运行。** 它会从当前目录往上找第一个含 `package.json` 或 `.git` 的目录当项目根，在项目外执行会认错根目录。
+- **目标目录会被整体删除。** `-t` 不要指向源码目录，比如 `-t src` 会把 `src` 删掉再复制作物进去。
+- **`git add .` 是全量提交。** 跑之前确认工作区没有别的半成品改动，否则会被一并提交。建议在 `.gitignore` 里忽略 `unpackage/`，否则打包产物源目录也会进版本库。
+- **只处理 H5 产物。** 小程序、App 平台的构建目录结构不同，不适用。
+- **名字叫 move，实际是 copy。** 源产物 `unpackage/dist/build/web` 不会删除。
+- 不传 commit 信息时，提交记录是 `build: test`，翻历史时容易认不出来，建议养成带信息的习惯。
+
+## 作为模块调用
+
+`main` 指向搬运函数本身，也可以不装命令行、直接引：
+
+```js
+const move = require("hbuilder-build-move");
+
+// 把当前项目的产物搬到 build/h5，并提交推送
+await move("./unpackage/dist/build/web", "build/h5", "build: 更新首页");
+```
+
+定位项目根的方式和命令行一致，同样从 `process.cwd()` 往上找。
+
+## 开发
+
+```shell
+npm install
+npm test
+```
+
+测试用 Node 自带的 test runner，不需要额外依赖。每个用例都会在临时目录里建一个真实 git 仓库，并拿本地裸仓库充当 origin，完整跑一遍复制、`git add`、`commit`、`push` —— 全程离线，不碰你的仓库，也不碰 GitHub。
+
+## License
+
+ISC

package/index.mjs

@@ -17,7 +17,7 @@ const data = fs.readFileSync(filePath, "utf8");
 const packageJson = JSON.parse(data);
 
 program
-  .name(packageJson.name)
+  .name("hbm")
   .description(packageJson.description)
   .version(packageJson.version);
 

package/move.js

@@ -37,21 +37,13 @@ async function main(src, dest, commitInfo) {
     handleError("未找打包完成的H5资源");
   }
   const targetDir = path.join(projectRoot, dest);
-  if (!fs.existsSync(targetDir)) {
-    fs.mkdirSync(targetDir, { recursive: true });
-    console.log(dest + " 目录创建完成");
-  } else {
-    // 删除目标目录下的文件
-    const result = spawnSync("rm", ["-rf", targetDir]);
-    console.log("result: ", result);
-
-    if (result.status !== 0) {
-      handleError("❌ 删除旧文件失败");
-      process.exit(1); // 终止后续命令
-    } else {
-      console.log("🎉 删除旧文件成功");
-    }
+  if (fs.existsSync(targetDir)) {
+    // 整体删除重建，保证目录内容与本次打包结果完全一致
+    fs.rmSync(targetDir, { recursive: true, force: true });
+    console.log("🎉 删除旧文件成功");
   }
+  fs.mkdirSync(targetDir, { recursive: true });
+  console.log(dest + " 目录创建完成");
   console.log("源目录 :>> ", path.join(projectRoot, src));
   console.log("目标目录 :>> ", targetDir);
 
@@ -82,7 +74,6 @@ async function main(src, dest, commitInfo) {
   }
 
   console.log("🎉 所有文件复制完成 ");
-  spawnSync("cd", [projectRoot]);
   const cwd = process.cwd();
   console.log("当前执行路径：", cwd);
 
@@ -93,7 +84,10 @@ async function main(src, dest, commitInfo) {
   ];
 
   for (const command of gitCommands) {
-    const result = spawnSync(command.cmd, command.args, { stdio: "inherit" });
+    const result = spawnSync(command.cmd, command.args, {
+      stdio: "inherit",
+      cwd: projectRoot,
+    });
     if (result.status !== 0) {
       handleError(`❌ 命令 ${command.cmd} 执行失败`);
       process.exit(1); // 终止后续命令

package/package.json

@@ -1,18 +1,22 @@
 {
   "name": "hbuilder-build-move",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "将打包好的资源移动到项目指定的目录下",
   "keywords": [
     "Hbuilder",
     "h5",
     "build"
   ],
-  "main": "index.js",
+  "main": "move.js",
   "bin": {
     "hbm": "index.mjs"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node --test",
+    "prepublishOnly": "npm test"
+  },
+  "engines": {
+    "node": ">=18"
   },
   "author": "hxf",
   "license": "ISC",

package/test/move.test.js

@@ -0,0 +1,165 @@
+"use strict";
+
+const { test, after } = require("node:test");
+const assert = require("node:assert");
+const fs = require("node:fs");
+const os = require("node:os");
+const path = require("node:path");
+const { spawnSync } = require("node:child_process");
+
+const PKG_DIR = path.resolve(__dirname, "..");
+const MOVE_JS = path.join(PKG_DIR, "move.js");
+const move = require(MOVE_JS);
+
+const sandboxes = [];
+
+after(() => {
+  for (const dir of sandboxes) fs.rmSync(dir, { recursive: true, force: true });
+});
+
+function git(args, cwd) {
+  const result = spawnSync("git", args, { cwd, encoding: "utf8" });
+  if (result.status !== 0) {
+    throw new Error(
+      `git ${args.join(" ")} 失败 (status=${result.status})\nSTDOUT:\n${result.stdout}\nSTDERR:\n${result.stderr}`
+    );
+  }
+  return result.stdout.trim();
+}
+
+function newSandboxDir() {
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), "hbm-test-"));
+  sandboxes.push(dir);
+  return dir;
+}
+
+/**
+ * 建一个和真实使用一致的仓库：本地仓库已 init、已有首次提交、已关联 origin。
+ * origin 用本地裸仓库代替 GitHub，push 走文件系统，不依赖网络和凭据。
+ */
+function makeRepo({ withBuild = true } = {}) {
+  const root = newSandboxDir();
+  const remote = path.join(root, "origin.git");
+  const repo = path.join(root, "repo");
+  fs.mkdirSync(repo);
+
+  git(["init", "--bare", "-b", "main", remote], root);
+  git(["init", "-b", "main"], repo);
+  git(["config", "user.name", "hbm-test"], repo);
+  git(["config", "user.email", "hbm-test@example.com"], repo);
+  git(["config", "commit.gpgsign", "false"], repo);
+  git(["remote", "add", "origin", remote], repo);
+  fs.writeFileSync(path.join(repo, "README.md"), "# sandbox\n");
+  git(["add", "."], repo);
+  git(["commit", "-m", "init"], repo);
+  git(["push", "-u", "origin", "main"], repo);
+
+  if (withBuild) {
+    const web = path.join(repo, "unpackage", "dist", "build", "web");
+    fs.mkdirSync(path.join(web, "static"), { recursive: true });
+    fs.writeFileSync(path.join(web, "index.html"), "<!DOCTYPE html><h1>built</h1>\n");
+    fs.writeFileSync(path.join(web, "static", "app.js"), "console.log('built');\n");
+  }
+
+  return { root, repo, remote };
+}
+
+/** 失败路径走子进程：move 里的 handleError 会直接 process.exit */
+function runMoveInChild(cwd, src, dest, message) {
+  const code =
+    `require(${JSON.stringify(MOVE_JS)})` +
+    `(${JSON.stringify(src)}, ${JSON.stringify(dest)}, ${JSON.stringify(message)});`;
+  return spawnSync(process.execPath, ["-e", code], { cwd, encoding: "utf8" });
+}
+
+/** move 靠 process.cwd() 找项目根，测试期间临时切目录，结束后务必恢复 */
+async function inDir(dir, fn) {
+  const prev = process.cwd();
+  process.chdir(dir);
+  try {
+    return await fn();
+  } finally {
+    process.chdir(prev);
+  }
+}
+
+test("package.json 的 main 指向真实存在的入口，require 包根目录能拿到函数", () => {
+  const entry = require.resolve(PKG_DIR);
+  assert.ok(fs.existsSync(entry), `main 指向的文件不存在: ${entry}`);
+  assert.strictEqual(path.resolve(entry), MOVE_JS);
+  assert.strictEqual(typeof require(PKG_DIR), "function");
+});
+
+test("项目没有初始化 git 时报错并以 1 退出", () => {
+  const dir = newSandboxDir();
+  fs.writeFileSync(path.join(dir, "package.json"), "{}\n");
+
+  const result = runMoveInChild(dir, "./unpackage/dist/build/web", "build/h5", "build: t");
+
+  assert.strictEqual(result.status, 1);
+  assert.match(result.stderr, /没有配置Git/);
+});
+
+test("没有打包产物时报错并以 1 退出", () => {
+  const { repo } = makeRepo({ withBuild: false });
+
+  const result = runMoveInChild(repo, "./unpackage/dist/build/web", "build/h5", "build: t");
+
+  assert.strictEqual(result.status, 1);
+  assert.match(result.stderr, /未找打包完成的H5资源/);
+});
+
+test("正常流程：清空旧目标目录、递归复制、提交并推送到远端", async () => {
+  const { root, repo, remote } = makeRepo();
+
+  // 目标目录里预置旧文件，验证会被整体清掉
+  fs.mkdirSync(path.join(repo, "build", "h5"), { recursive: true });
+  fs.writeFileSync(path.join(repo, "build", "h5", "stale.txt"), "old file\n");
+
+  await inDir(repo, () => move("./unpackage/dist/build/web", "build/h5", "build: v1"));
+
+  const target = path.join(repo, "build", "h5");
+  assert.ok(!fs.existsSync(path.join(target, "stale.txt")), "旧文件应被删除");
+  assert.strictEqual(
+    fs.readFileSync(path.join(target, "index.html"), "utf8"),
+    "<!DOCTYPE html><h1>built</h1>\n"
+  );
+  assert.strictEqual(
+    fs.readFileSync(path.join(target, "static", "app.js"), "utf8"),
+    "console.log('built');\n"
+  );
+
+  // 名字叫 move，实际是 copy，源产物必须还在
+  assert.ok(fs.existsSync(path.join(repo, "unpackage", "dist", "build", "web", "index.html")));
+
+  // 已提交、已推送
+  assert.strictEqual(git(["log", "-1", "--format=%s"], repo), "build: v1");
+  assert.strictEqual(git(["status", "--porcelain"], repo), "");
+  assert.strictEqual(git(["--git-dir", remote, "log", "-1", "--format=%s"], root), "build: v1");
+});
+
+test("目标目录不存在时自动创建，支持多级路径", async () => {
+  const { repo } = makeRepo();
+
+  await inDir(repo, () => move("./unpackage/dist/build/web", "static/h5/v1", "build: nested"));
+
+  const target = path.join(repo, "static", "h5", "v1");
+  assert.ok(fs.existsSync(path.join(target, "index.html")));
+  assert.ok(fs.existsSync(path.join(target, "static", "app.js")));
+  assert.strictEqual(git(["log", "-1", "--format=%s"], repo), "build: nested");
+});
+
+test("在子目录里运行也能定位到项目根，并把仓库根的全部改动一起提交", async () => {
+  const { repo } = makeRepo();
+
+  // 在产物目录里执行，模拟「在编辑器终端里从当前文件所在目录运行」
+  const sub = path.join(repo, "unpackage", "dist", "build", "web");
+  await inDir(sub, () => move("./unpackage/dist/build/web", "build/h5", "build: from subdir"));
+
+  // 产物落在仓库根下的 build/h5，而不是子目录里再套一层
+  assert.ok(fs.existsSync(path.join(repo, "build", "h5", "index.html")));
+  assert.ok(!fs.existsSync(path.join(sub, "build")));
+  // 工作区干净：说明 git add 是在仓库根执行的，没有漏掉其他改动
+  assert.strictEqual(git(["status", "--porcelain"], repo), "");
+  assert.strictEqual(git(["log", "-1", "--format=%s"], repo), "build: from subdir");
+});