smart-review 1.0.3 → 1.0.4

package/README.en-US.md

@@ -124,6 +124,10 @@ Add to `package.json` if you use Husky:
 }
 ```
 
+#### Interrupt & Terminal Compatibility
+- Works in Git Bash, CMD, and PowerShell
+- Press `q` or `Esc` during review to interrupt and print completed results
+- Interruptions do not fail the review; only blocking risks stop the commit
 ## ⚙️ Config
 
 Main config `.smart-review/smart-review.json` example:

package/README.md

@@ -130,7 +130,10 @@ node bin/review.js --files test/src/large-test-file.js
   }
 }
 ```
-
+#### 中断与终端兼容
+- 支持在 Git Bash、CMD、PowerShell 中进行交互中断
+- 审查过程中输入 `q` 或按 `Esc` 可中断审查并输出已完成结果
+- 中断不会被视为审查失败，只有存在阻断风险才会阻止提交
 ## ⚙️ 配置文件
 
 ### 主配置文件 `.smart-review/smart-review.json`

package/bin/install.js

@@ -264,6 +264,8 @@ class Installer {
 
 echo "${t(loc, 'hook_start_review')}"
 
+trap 'echo "${t(loc, 'interrupt_cancelled')}"; exit 0' INT TERM
+
 # 获取暂存区文件
 STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM)
 
@@ -283,9 +285,14 @@ ROOT_BIN="$REPO_ROOT/node_modules/.bin/smart-review"
 
 FOUND_CMD=""
 FOUND_IS_ENTRY=0
+FOUND_ENTRY_CMD=""
 
 if [ -f "$ROOT_BIN" ]; then
   FOUND_CMD="$ROOT_BIN"
+  ROOT_ENTRY="$REPO_ROOT/node_modules/smart-review/bin/review.js"
+  if [ -f "$ROOT_ENTRY" ]; then
+    FOUND_ENTRY_CMD="$ROOT_ENTRY"
+  fi
 else
   MAX_ASCEND=6
   while IFS= read -r file; do
@@ -296,9 +303,13 @@ else
       candidate_bin="$REPO_ROOT/$dir/node_modules/.bin/smart-review"
       candidate_entry="$REPO_ROOT/$dir/node_modules/smart-review/bin/review.js"
       if [ -f "$candidate_bin" ]; then
-        FOUND_CMD="$candidate_bin"; FOUND_IS_ENTRY=0; break 2
+        FOUND_CMD="$candidate_bin"; FOUND_IS_ENTRY=0;
+        if [ -f "$candidate_entry" ]; then
+          FOUND_ENTRY_CMD="$candidate_entry"
+        fi
+        break 2
       elif [ -f "$candidate_entry" ]; then
-        FOUND_CMD="$candidate_entry"; FOUND_IS_ENTRY=1; break 2
+        FOUND_CMD="$candidate_entry"; FOUND_IS_ENTRY=1; FOUND_ENTRY_CMD="$candidate_entry"; break 2
       fi
       dir=$(dirname "$dir")
       depth=$((depth + 1))
@@ -319,13 +330,89 @@ if [ -z "$FOUND_CMD" ]; then
 fi
 
 echo "${t(loc, 'hook_use_command_prefix')} $FOUND_CMD --staged"
-if [ $FOUND_IS_ENTRY -eq 1 ]; then
-  node "$FOUND_CMD" --staged
+USE_WINPTY=0
+if command -v uname >/dev/null 2>&1; then
+  KERNEL=$(uname -s)
 else
-  "$FOUND_CMD" --staged
+  KERNEL=""
 fi
-
+IS_MSYS=0
+if [[ "$KERNEL" == MINGW* || "$KERNEL" == MSYS* || -n "$MSYSTEM" ]]; then
+  IS_MSYS=1
+fi
+HAS_TTY=0
+if [ -t 0 ] || [ -t 1 ]; then
+  HAS_TTY=1
+fi
+TTY_DEVICE=""
+if [ $HAS_TTY -eq 1 ] && [ -r /dev/tty ]; then
+  TTY_DEVICE="/dev/tty"
+elif [ $HAS_TTY -eq 1 ] && [ -r "CONIN$" ]; then
+  TTY_DEVICE="CONIN$"
+elif [ -r /dev/tty ]; then
+  TTY_DEVICE="/dev/tty"
+elif [ -r "CONIN$" ]; then
+  TTY_DEVICE="CONIN$"
+fi
+if [ -n "$TTY_DEVICE" ]; then
+  export SMART_REVIEW_TTY="$TTY_DEVICE"
+fi
+if [ $IS_MSYS -eq 1 ] && [ $HAS_TTY -eq 1 ]; then
+  if command -v winpty >/dev/null 2>&1; then
+    USE_WINPTY=1
+  fi
+fi
+run_direct() {
+  if [ $USE_WINPTY -eq 1 ]; then
+    if [ -n "$FOUND_ENTRY_CMD" ]; then
+      winpty node "$FOUND_ENTRY_CMD" --staged
+    else
+      winpty "$FOUND_CMD" --staged
+    fi
+  else
+    if [ -n "$FOUND_ENTRY_CMD" ]; then
+      node "$FOUND_ENTRY_CMD" --staged
+    else
+      "$FOUND_CMD" --staged
+    fi
+  fi
+}
+run_with_device() {
+  if [ -n "$TTY_DEVICE" ]; then
+    "$@" < "$TTY_DEVICE"
+  else
+    "$@"
+  fi
+}
+TMP_ERR=""
+if command -v mktemp >/dev/null 2>&1; then
+  TMP_ERR=$(mktemp -t smart-review-err.XXXXXX)
+else
+  TMP_ERR="/tmp/smart-review-err-$$"
+fi
+run_direct 2> "$TMP_ERR"
 EXIT_CODE=$?
+if [ $EXIT_CODE -ne 0 ] && [ -s "$TMP_ERR" ] && grep -qi "stdin is not a tty" "$TMP_ERR"; then
+  if [ $USE_WINPTY -eq 1 ]; then
+    if [ -n "$FOUND_ENTRY_CMD" ]; then
+      run_with_device winpty node "$FOUND_ENTRY_CMD" --staged
+    else
+      run_with_device winpty "$FOUND_CMD" --staged
+    fi
+  else
+    if [ -n "$FOUND_ENTRY_CMD" ]; then
+      run_with_device node "$FOUND_ENTRY_CMD" --staged
+    else
+      run_with_device "$FOUND_CMD" --staged
+    fi
+  fi
+  EXIT_CODE=$?
+fi
+rm -f "$TMP_ERR"
+if [ $EXIT_CODE -eq 130 ] || [ $EXIT_CODE -eq 143 ]; then
+  echo "${t(loc, 'interrupt_cancelled')}"
+  exit 0
+fi
 if [ $EXIT_CODE -ne 0 ]; then
   echo "${t(loc, 'hook_review_fail')}"
   exit 1
@@ -336,18 +423,98 @@ fi
 `;
 
     fs.writeFileSync(preCommitHook, hookContent);
-    // Windows 兼容：提供 CMD 包装器，调用 bash 执行同名脚本
+    const escapeCmdText = (value) => String(value).replace(/\\/g, '\\\\').replace(/'/g, "\\'");
+    const cmdMessages = {
+      start: escapeCmdText(t(loc, 'hook_start_review')),
+      noStaged: escapeCmdText(t(loc, 'hook_no_staged')),
+      foundHeader: escapeCmdText(t(loc, 'hook_found_staged_header')),
+      cdFail: escapeCmdText(t(loc, 'hook_cd_repo_fail')),
+      cmdNotFound1: escapeCmdText(t(loc, 'hook_cmd_not_found1')),
+      cmdNotFound2: escapeCmdText(t(loc, 'hook_cmd_not_found2')),
+      cmdMissingContinue: escapeCmdText(t(loc, 'hook_cmd_missing_continue')),
+      useCmdPrefix: escapeCmdText(t(loc, 'hook_use_command_prefix')),
+      reviewFail: escapeCmdText(t(loc, 'hook_review_fail')),
+      reviewPass: escapeCmdText(t(loc, 'hook_review_pass')),
+      interruptCancelled: escapeCmdText(t(loc, 'interrupt_cancelled'))
+    };
+    const cmdNodeScript = [
+      "const { execSync, spawnSync } = require('child_process');",
+      "const fs = require('fs');",
+      "const path = require('path');",
+      `const MSG = { start: '${cmdMessages.start}', noStaged: '${cmdMessages.noStaged}', foundHeader: '${cmdMessages.foundHeader}', cdFail: '${cmdMessages.cdFail}', cmdNotFound1: '${cmdMessages.cmdNotFound1}', cmdNotFound2: '${cmdMessages.cmdNotFound2}', cmdMissingContinue: '${cmdMessages.cmdMissingContinue}', useCmdPrefix: '${cmdMessages.useCmdPrefix}', reviewFail: '${cmdMessages.reviewFail}', reviewPass: '${cmdMessages.reviewPass}', interruptCancelled: '${cmdMessages.interruptCancelled}' };`,
+      "const log = (value) => { if (value) console.log(value); };",
+      "log(MSG.start);",
+      "let staged = '';",
+      "try { staged = execSync('git diff --cached --name-only --diff-filter=ACM', { encoding: 'utf8' }); } catch (e) {}",
+      "const stagedFiles = staged.split(/\\r?\\n/).filter(Boolean);",
+      "if (!stagedFiles.length) { log(MSG.noStaged); process.exit(0); }",
+      "log(MSG.foundHeader);",
+      "log(stagedFiles.join('\\n'));",
+      "let repoRoot = '';",
+      "try { repoRoot = execSync('git rev-parse --show-toplevel', { encoding: 'utf8' }).trim(); } catch (e) {}",
+      "if (!repoRoot) { log(MSG.cdFail); process.exit(1); }",
+      "const rootBin = path.join(repoRoot, 'node_modules', '.bin', 'smart-review');",
+      "const rootEntry = path.join(repoRoot, 'node_modules', 'smart-review', 'bin', 'review.js');",
+      "let foundCmd = '';",
+      "let foundEntry = '';",
+      "if (fs.existsSync(rootBin)) { foundCmd = rootBin; if (fs.existsSync(rootEntry)) { foundEntry = rootEntry; } }",
+      "if (!foundCmd) {",
+      "  const maxAscend = 6;",
+      "  outer: for (const file of stagedFiles) {",
+      "    let dir = path.dirname(file);",
+      "    let depth = 0;",
+      "    while (dir && dir !== '.' && depth < maxAscend) {",
+      "      const candidateBin = path.join(repoRoot, dir, 'node_modules', '.bin', 'smart-review');",
+      "      const candidateEntry = path.join(repoRoot, dir, 'node_modules', 'smart-review', 'bin', 'review.js');",
+      "      if (fs.existsSync(candidateBin)) { foundCmd = candidateBin; if (fs.existsSync(candidateEntry)) { foundEntry = candidateEntry; } break outer; }",
+      "      if (fs.existsSync(candidateEntry)) { foundCmd = candidateEntry; foundEntry = candidateEntry; break outer; }",
+      "      dir = path.dirname(dir);",
+      "      depth++;",
+      "    }",
+      "  }",
+      "}",
+      "if (!foundCmd) {",
+      "  try { execSync('where smart-review', { stdio: 'ignore' }); foundCmd = 'smart-review'; } catch (e) {}",
+      "}",
+      "if (!foundCmd) { log(MSG.cmdNotFound1); log(MSG.cmdNotFound2); log(MSG.cmdMissingContinue); process.exit(0); }",
+      "log(MSG.useCmdPrefix + ' ' + foundCmd + ' --staged');",
+      "const hasTty = !!(process.stdin && process.stdin.isTTY) || !!(process.stdout && process.stdout.isTTY);",
+      "const tryTty = (p) => { try { const fd = fs.openSync(p, 'r'); fs.closeSync(fd); return p; } catch (e) { return ''; } };",
+      "const ensureTty = () => {",
+      "  if (process.env.SMART_REVIEW_TTY) return;",
+      "  let tty = '';",
+      "  if (hasTty) { tty = tryTty('\\\\\\\\.\\\\CONIN$') || tryTty('CONIN$'); }",
+      "  if (!tty) { tty = tryTty('\\\\\\\\.\\\\CONIN$') || tryTty('CONIN$'); }",
+      "  if (tty) { process.env.SMART_REVIEW_TTY = tty; process.env.SMART_REVIEW_FORCE_TTY = '1'; }",
+      "};",
+      "const args = ['--staged'];",
+      "const runOnce = (capture) => {",
+      "  if (foundEntry) {",
+      "    return spawnSync(process.execPath, [foundEntry, ...args], { stdio: capture ? 'pipe' : 'inherit' });",
+      "  }",
+      "  return spawnSync(foundCmd, args, { stdio: capture ? 'pipe' : 'inherit', shell: true });",
+      "};",
+      "let result = runOnce(true);",
+      "if (result.stdout) process.stdout.write(result.stdout);",
+      "if (result.stderr) process.stderr.write(result.stderr);",
+      "let code = Number.isInteger(result.status) ? result.status : (Number.isInteger(result.code) ? result.code : 0);",
+      "const errText = result.stderr ? String(result.stderr) : '';",
+      "if (code !== 0 && /stdin is not a tty/i.test(errText)) {",
+      "  ensureTty();",
+      "  result = runOnce(false);",
+      "  code = Number.isInteger(result.status) ? result.status : (Number.isInteger(result.code) ? result.code : 0);",
+      "}",
+      "if (code === 130 || code === 143) { log(MSG.interruptCancelled); process.exit(0); }",
+      "if (code !== 0) { log(MSG.reviewFail); process.exit(1); }",
+      "log(MSG.reviewPass); process.exit(0);"
+    ].join('');
+    // Windows 兼容：提供 CMD 包装器，避免 bash 在 CMD 下的 TTY 问题
     try {
       const preCommitCmd = path.join(gitHooksDir, 'pre-commit.cmd');
       const cmdContent = [
         '@echo off',
         'SETLOCAL',
-        'set HOOK=%~dp0pre-commit',
-        'if not exist "%HOOK%" (',
-        '  echo [smart-review] pre-commit hook missing.',
-        '  exit /b 1',
-        ')',
-        'bash "%HOOK%"',
+        `node -e "${cmdNodeScript}"`,
         'exit /b %ERRORLEVEL%\r\n'
       ].join('\r\n');
       fs.writeFileSync(preCommitCmd, cmdContent);
@@ -416,4 +583,4 @@ fi
 
 // 运行安装
 const installer = new Installer();
-(async () => { await installer.install(); })();
+(async () => { await installer.install(); })();