scrum-skills 0.3.2 → 0.3.3

package/tools/git-commit.mjs

@@ -1,216 +1,216 @@
-#!/usr/bin/env node
-/**
- * 「自动提交」：把这次交付整份提交进本地仓库（git add -A + git commit）。
- *
- * 只提交，不 push、不改任何文件内容。所以这里的全部力气都花在「别在错误的时机动手」：
- *   · 不是 git 仓库 / 分离头指针 / 正在合并、摘取、回滚、变基 / 工作区有冲突 → 拒绝并说清原因；
- *   · 工作区干净 → 拒绝，不造空提交；
- *   · 提交信息首行必须是 Conventional Commits（feat: / fix: / chore: …），非法时连 git add 都不做。
- *
- * 用法（CLI 调试；看板走 /api/agile/git/* 两个接口）:
- *   node tools/git-commit.mjs status [目录]
- *   node tools/git-commit.mjs commit <信息文件|-> [目录]
- */
-import { existsSync, readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
-import { execFileSync } from 'node:child_process';
-import { pathToFileURL } from 'node:url';
-
-const TIMEOUT = 30000;
-const MAX_MESSAGE = 8000;
-
-/** 首行：type(scope)!: 内容。`!` 留给破坏性变更 */
-export const CONVENTIONAL_RE =
-  /^(feat|fix|chore|docs|style|refactor|perf|test|build|ci|revert)(\([^()\n]{1,32}\))?!?: \S/;
-
-/** 这些文件还在，说明仓库卡在某个多步操作中间，这时候提交会把半截状态钉进历史 */
-const IN_PROGRESS = [
-  ['MERGE_HEAD', '正在合并（MERGE_HEAD 还在），先把冲突处理完再提交'],
-  ['CHERRY_PICK_HEAD', '正在摘取提交（CHERRY_PICK_HEAD 还在），先处理完再提交'],
-  ['REVERT_HEAD', '正在回滚提交（REVERT_HEAD 还在），先处理完再提交'],
-  ['rebase-merge', '正在变基（rebase-merge 还在），先处理完再提交'],
-  ['rebase-apply', '正在变基或应用补丁（rebase-apply 还在），先处理完再提交'],
-];
-
-const CONFLICT_CODES = new Set(['DD', 'AU', 'UD', 'UA', 'DU', 'AA', 'UU']);
-
-/**
- * 统一走 execFileSync：参数按数组传，不经过 shell，中文路径也不被转义。
- * （git 默认会把非 ASCII 路径写成 "\346\226\207" 这种转义，看板上读不了）
- */
-const git = (root, args, opts = {}) =>
-  execFileSync('git', ['-c', 'core.quotepath=false', '-C', root, ...args], {
-    encoding: 'utf8',
-    stdio: ['ignore', 'pipe', 'pipe'],
-    timeout: TIMEOUT,
-    windowsHide: true,
-    ...opts,
-  });
-
-const stderrOf = e => String(e?.stderr ?? e?.message ?? '').trim();
-
-const parseStatusLine = line => ({
-  code: line.slice(0, 2).trim(),
-  path: line.slice(3).replace(/^"(.*)"$/, '$1'),
-});
-
-/**
- * 提交前预览：这个目录能不能提交、提交了会带走哪些文件。
- * 永远不抛错——看板要把它整个显示出来，包括「不是仓库」这种情况。
- */
-export function commitPreview(root = process.cwd()) {
-  const dir = resolve(root);
-  const base = { root: dir, isRepo: false, branch: null, blocked: null, files: [], clean: true, conflicted: false };
-
-  let inside = '';
-  try {
-    inside = git(dir, ['rev-parse', '--is-inside-work-tree']).trim();
-  } catch {
-    return base;
-  }
-  if (inside !== 'true') return base;
-
-  let branch = null;
-  try {
-    branch = git(dir, ['rev-parse', '--abbrev-ref', 'HEAD']).trim() || null;
-  } catch {
-    // 空仓库还没有 HEAD：不算错误，首次提交照样能做
-  }
-  const detached = branch === 'HEAD';
-
-  let gitDir = '';
-  try {
-    gitDir = git(dir, ['rev-parse', '--absolute-git-dir']).trim();
-  } catch {}
-
-  let files = [];
-  try {
-    files = git(dir, ['status', '--porcelain=v1', '-uall'])
-      .split('\n')
-      .filter(Boolean)
-      .map(parseStatusLine);
-  } catch {
-    files = [];
-  }
-  const conflicted = files.some(f => CONFLICT_CODES.has(f.code));
-
-  const inProgress = gitDir ? IN_PROGRESS.find(([name]) => existsSync(resolve(gitDir, name))) : null;
-  let blocked = null;
-  if (inProgress) blocked = inProgress[1];
-  else if (detached) blocked = '当前是分离头指针（detached HEAD），在这里提交会丢，先切回分支';
-  else if (conflicted) blocked = '工作区里还有冲突（UU / AA / DD），先把冲突解决完再提交';
-
-  return {
-    ...base,
-    isRepo: true,
-    branch: detached ? null : branch,
-    blocked,
-    files,
-    clean: files.length === 0,
-    conflicted,
-  };
-}
-
-/**
- * 提交信息归一：CRLF → LF、去掉行尾空白、压掉连续空行。
- * 首行必须符合 Conventional Commits，空信息直接拒——不然会写出一个没意义的提交。
- */
-export function normalizeCommitMessage(message) {
-  const text = String(message ?? '')
-    .replace(/\r\n?/g, '\n')
-    .replace(/[ \t]+$/gm, '')
-    .replace(/\n{3,}/g, '\n\n')
-    .trim();
-  if (!text) throw new Error('提交信息是空的：先在弹窗里看清这次改了什么');
-  const subject = text.split('\n')[0];
-  if (!CONVENTIONAL_RE.test(subject)) {
-    throw new Error(`提交信息首行要符合 Conventional Commits（形如 "feat: 一句话"），现在是「${subject.slice(0, 40)}」`);
-  }
-  if (text.length > MAX_MESSAGE) throw new Error(`提交信息太长了（${text.length} 字符，上限 ${MAX_MESSAGE}），删掉一些再提交`);
-  return text;
-}
-
-/**
- * 真提交：add -A → commit -F -（多行信息走 stdin，避开 shell 引号）→ 回短 hash。
- * 任何一步失败都抛出人话，看板原样显示。
- */
-export function commitAll(root = process.cwd(), message = '') {
-  const dir = resolve(root);
-  const text = normalizeCommitMessage(message);
-
-  const preview = commitPreview(dir);
-  if (!preview.isRepo) throw new Error('这个目录不是 git 仓库，没法自动提交（先 git init）');
-  if (preview.blocked) throw new Error(preview.blocked);
-  if (preview.clean) throw new Error('没有未提交的改动，不需要提交');
-
-  try {
-    git(dir, ['add', '-A']);
-  } catch (e) {
-    throw new Error(`git add 失败：${stderrOf(e) || '未知原因'}`);
-  }
-
-  try {
-    git(dir, ['commit', '-F', '-'], { stdio: ['pipe', 'pipe', 'pipe'], input: text });
-  } catch (e) {
-    const err = stderrOf(e);
-    if (/who are you|auto-detect email|user\.name|user\.email/i.test(err)) {
-      throw new Error('git 还没配提交身份，先跑：git config user.name "你的名字"、git config user.email "你的邮箱"');
-    }
-    throw new Error(`git commit 失败：${err || '未知原因'}`);
-  }
-
-  const hash = git(dir, ['rev-parse', '--short', 'HEAD']).trim();
-  return {
-    hash,
-    subject: text.split('\n')[0],
-    branch: preview.branch,
-    files: preview.files.length,
-  };
-}
-
-function main() {
-  const [cmd, ...rest] = process.argv.slice(2);
-  const positional = rest.filter(a => !a.startsWith('--'));
-
-  if (cmd === 'status') {
-    const p = commitPreview(positional[0] ?? process.cwd());
-    if (!p.isRepo) {
-      console.log('· 不是 git 仓库（没法自动提交）');
-      process.exit(2);
-    }
-    console.log(`· 分支: ${p.branch ?? '(分离头指针)'}`);
-    console.log(`· 待提交: ${p.files.length} 个文件`);
-    for (const f of p.files) console.log(`  ${f.code.padEnd(2)} ${f.path}`);
-    if (p.blocked) console.log(`· 现在不能提交: ${p.blocked}`);
-    process.exit(p.blocked ? 3 : 0);
-  }
-
-  if (cmd === 'commit') {
-    const src = positional[0];
-    if (!src) {
-      console.error('用法: node tools/git-commit.mjs commit <信息文件|-> [目录]');
-      process.exit(1);
-    }
-    let message;
-    try {
-      message = src === '-' ? readFileSync(0, 'utf8') : readFileSync(resolve(src), 'utf8');
-    } catch (e) {
-      console.error(`✘ 读不到提交信息文件: ${e.message}`);
-      process.exit(3);
-    }
-    try {
-      const r = commitAll(positional[1] ?? process.cwd(), message);
-      console.log(`✔ 已提交 ${r.hash} · ${r.files} 个文件 · 分支 ${r.branch ?? '(分离头指针)'}`);
-      return;
-    } catch (e) {
-      console.error(`✘ ${e.message}`);
-      process.exit(4);
-    }
-  }
-
-  console.error('用法:\n  node tools/git-commit.mjs status [目录]\n  node tools/git-commit.mjs commit <信息文件|-> [目录]');
-  process.exit(1);
-}
-
-const entry = process.argv[1] ? pathToFileURL(resolve(process.argv[1])).href : '';
-if (entry && entry === import.meta.url) main();
+#!/usr/bin/env node
+/**
+ * 「自动提交」：把这次交付整份提交进本地仓库（git add -A + git commit）。
+ *
+ * 只提交，不 push、不改任何文件内容。所以这里的全部力气都花在「别在错误的时机动手」：
+ *   · 不是 git 仓库 / 分离头指针 / 正在合并、摘取、回滚、变基 / 工作区有冲突 → 拒绝并说清原因；
+ *   · 工作区干净 → 拒绝，不造空提交；
+ *   · 提交信息首行必须是 Conventional Commits（feat: / fix: / chore: …），非法时连 git add 都不做。
+ *
+ * 用法（CLI 调试；看板走 /api/agile/git/* 两个接口）:
+ *   node tools/git-commit.mjs status [目录]
+ *   node tools/git-commit.mjs commit <信息文件|-> [目录]
+ */
+import { existsSync, readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { execFileSync } from 'node:child_process';
+import { pathToFileURL } from 'node:url';
+
+const TIMEOUT = 30000;
+const MAX_MESSAGE = 8000;
+
+/** 首行：type(scope)!: 内容。`!` 留给破坏性变更 */
+export const CONVENTIONAL_RE =
+  /^(feat|fix|chore|docs|style|refactor|perf|test|build|ci|revert)(\([^()\n]{1,32}\))?!?: \S/;
+
+/** 这些文件还在，说明仓库卡在某个多步操作中间，这时候提交会把半截状态钉进历史 */
+const IN_PROGRESS = [
+  ['MERGE_HEAD', '正在合并（MERGE_HEAD 还在），先把冲突处理完再提交'],
+  ['CHERRY_PICK_HEAD', '正在摘取提交（CHERRY_PICK_HEAD 还在），先处理完再提交'],
+  ['REVERT_HEAD', '正在回滚提交（REVERT_HEAD 还在），先处理完再提交'],
+  ['rebase-merge', '正在变基（rebase-merge 还在），先处理完再提交'],
+  ['rebase-apply', '正在变基或应用补丁（rebase-apply 还在），先处理完再提交'],
+];
+
+const CONFLICT_CODES = new Set(['DD', 'AU', 'UD', 'UA', 'DU', 'AA', 'UU']);
+
+/**
+ * 统一走 execFileSync：参数按数组传，不经过 shell，中文路径也不被转义。
+ * （git 默认会把非 ASCII 路径写成 "\346\226\207" 这种转义，看板上读不了）
+ */
+const git = (root, args, opts = {}) =>
+  execFileSync('git', ['-c', 'core.quotepath=false', '-C', root, ...args], {
+    encoding: 'utf8',
+    stdio: ['ignore', 'pipe', 'pipe'],
+    timeout: TIMEOUT,
+    windowsHide: true,
+    ...opts,
+  });
+
+const stderrOf = e => String(e?.stderr ?? e?.message ?? '').trim();
+
+const parseStatusLine = line => ({
+  code: line.slice(0, 2).trim(),
+  path: line.slice(3).replace(/^"(.*)"$/, '$1'),
+});
+
+/**
+ * 提交前预览：这个目录能不能提交、提交了会带走哪些文件。
+ * 永远不抛错——看板要把它整个显示出来，包括「不是仓库」这种情况。
+ */
+export function commitPreview(root = process.cwd()) {
+  const dir = resolve(root);
+  const base = { root: dir, isRepo: false, branch: null, blocked: null, files: [], clean: true, conflicted: false };
+
+  let inside = '';
+  try {
+    inside = git(dir, ['rev-parse', '--is-inside-work-tree']).trim();
+  } catch {
+    return base;
+  }
+  if (inside !== 'true') return base;
+
+  let branch = null;
+  try {
+    branch = git(dir, ['rev-parse', '--abbrev-ref', 'HEAD']).trim() || null;
+  } catch {
+    // 空仓库还没有 HEAD：不算错误，首次提交照样能做
+  }
+  const detached = branch === 'HEAD';
+
+  let gitDir = '';
+  try {
+    gitDir = git(dir, ['rev-parse', '--absolute-git-dir']).trim();
+  } catch {}
+
+  let files = [];
+  try {
+    files = git(dir, ['status', '--porcelain=v1', '-uall'])
+      .split('\n')
+      .filter(Boolean)
+      .map(parseStatusLine);
+  } catch {
+    files = [];
+  }
+  const conflicted = files.some(f => CONFLICT_CODES.has(f.code));
+
+  const inProgress = gitDir ? IN_PROGRESS.find(([name]) => existsSync(resolve(gitDir, name))) : null;
+  let blocked = null;
+  if (inProgress) blocked = inProgress[1];
+  else if (detached) blocked = '当前是分离头指针（detached HEAD），在这里提交会丢，先切回分支';
+  else if (conflicted) blocked = '工作区里还有冲突（UU / AA / DD），先把冲突解决完再提交';
+
+  return {
+    ...base,
+    isRepo: true,
+    branch: detached ? null : branch,
+    blocked,
+    files,
+    clean: files.length === 0,
+    conflicted,
+  };
+}
+
+/**
+ * 提交信息归一：CRLF → LF、去掉行尾空白、压掉连续空行。
+ * 首行必须符合 Conventional Commits，空信息直接拒——不然会写出一个没意义的提交。
+ */
+export function normalizeCommitMessage(message) {
+  const text = String(message ?? '')
+    .replace(/\r\n?/g, '\n')
+    .replace(/[ \t]+$/gm, '')
+    .replace(/\n{3,}/g, '\n\n')
+    .trim();
+  if (!text) throw new Error('提交信息是空的：先在弹窗里看清这次改了什么');
+  const subject = text.split('\n')[0];
+  if (!CONVENTIONAL_RE.test(subject)) {
+    throw new Error(`提交信息首行要符合 Conventional Commits（形如 "feat: 一句话"），现在是「${subject.slice(0, 40)}」`);
+  }
+  if (text.length > MAX_MESSAGE) throw new Error(`提交信息太长了（${text.length} 字符，上限 ${MAX_MESSAGE}），删掉一些再提交`);
+  return text;
+}
+
+/**
+ * 真提交：add -A → commit -F -（多行信息走 stdin，避开 shell 引号）→ 回短 hash。
+ * 任何一步失败都抛出人话，看板原样显示。
+ */
+export function commitAll(root = process.cwd(), message = '') {
+  const dir = resolve(root);
+  const text = normalizeCommitMessage(message);
+
+  const preview = commitPreview(dir);
+  if (!preview.isRepo) throw new Error('这个目录不是 git 仓库，没法自动提交（先 git init）');
+  if (preview.blocked) throw new Error(preview.blocked);
+  if (preview.clean) throw new Error('没有未提交的改动，不需要提交');
+
+  try {
+    git(dir, ['add', '-A']);
+  } catch (e) {
+    throw new Error(`git add 失败：${stderrOf(e) || '未知原因'}`);
+  }
+
+  try {
+    git(dir, ['commit', '-F', '-'], { stdio: ['pipe', 'pipe', 'pipe'], input: text });
+  } catch (e) {
+    const err = stderrOf(e);
+    if (/who are you|auto-detect email|user\.name|user\.email/i.test(err)) {
+      throw new Error('git 还没配提交身份，先跑：git config user.name "你的名字"、git config user.email "你的邮箱"');
+    }
+    throw new Error(`git commit 失败：${err || '未知原因'}`);
+  }
+
+  const hash = git(dir, ['rev-parse', '--short', 'HEAD']).trim();
+  return {
+    hash,
+    subject: text.split('\n')[0],
+    branch: preview.branch,
+    files: preview.files.length,
+  };
+}
+
+function main() {
+  const [cmd, ...rest] = process.argv.slice(2);
+  const positional = rest.filter(a => !a.startsWith('--'));
+
+  if (cmd === 'status') {
+    const p = commitPreview(positional[0] ?? process.cwd());
+    if (!p.isRepo) {
+      console.log('· 不是 git 仓库（没法自动提交）');
+      process.exit(2);
+    }
+    console.log(`· 分支: ${p.branch ?? '(分离头指针)'}`);
+    console.log(`· 待提交: ${p.files.length} 个文件`);
+    for (const f of p.files) console.log(`  ${f.code.padEnd(2)} ${f.path}`);
+    if (p.blocked) console.log(`· 现在不能提交: ${p.blocked}`);
+    process.exit(p.blocked ? 3 : 0);
+  }
+
+  if (cmd === 'commit') {
+    const src = positional[0];
+    if (!src) {
+      console.error('用法: node tools/git-commit.mjs commit <信息文件|-> [目录]');
+      process.exit(1);
+    }
+    let message;
+    try {
+      message = src === '-' ? readFileSync(0, 'utf8') : readFileSync(resolve(src), 'utf8');
+    } catch (e) {
+      console.error(`✘ 读不到提交信息文件: ${e.message}`);
+      process.exit(3);
+    }
+    try {
+      const r = commitAll(positional[1] ?? process.cwd(), message);
+      console.log(`✔ 已提交 ${r.hash} · ${r.files} 个文件 · 分支 ${r.branch ?? '(分离头指针)'}`);
+      return;
+    } catch (e) {
+      console.error(`✘ ${e.message}`);
+      process.exit(4);
+    }
+  }
+
+  console.error('用法:\n  node tools/git-commit.mjs status [目录]\n  node tools/git-commit.mjs commit <信息文件|-> [目录]');
+  process.exit(1);
+}
+
+const entry = process.argv[1] ? pathToFileURL(resolve(process.argv[1])).href : '';
+if (entry && entry === import.meta.url) main();