safeey-cli 0.2.1 → 0.6.1

package/src/spinner.js

@@ -0,0 +1,97 @@
+// src/spinner.js — lightweight progress UX for the scan.
+//
+// Writes to stderr (so --json/--sarif on stdout stays clean), animates in place
+// on a TTY, and degrades to plain one-line-per-phase output when not a TTY
+// (e.g. CI logs). The goal is simply to carry the user along: show that files
+// are being scanned, then dependencies, then history, then grading.
+
+const FRAMES = ["\u280b", "\u2819", "\u2839", "\u2838", "\u283c", "\u2834", "\u2826", "\u2827", "\u2807", "\u280f"];
+const GREEN = "\x1b[32m", DIM = "\x1b[2m", RESET = "\x1b[0m";
+
+class Spinner {
+  constructor(stream = process.stderr) {
+    this.stream = stream;
+    this.tty = !!stream.isTTY;
+    this.text = "";
+    this.frame = 0;
+    this.timer = null;
+    this.start = Date.now();
+    this.lastPlain = "";
+  }
+
+  _render() {
+    if (!this.tty) return;
+    const f = FRAMES[(this.frame = (this.frame + 1) % FRAMES.length)];
+    this.stream.write(`\r\x1b[2K  ${GREEN}${f}${RESET} ${this.text}`);
+  }
+
+  begin(text) {
+    this.text = text;
+    if (this.tty) {
+      if (!this.timer) this.timer = setInterval(() => this._render(), 80);
+      this._render();
+    } else {
+      this.stream.write(`  ${text}\n`);
+      this.lastPlain = text;
+    }
+    return this;
+  }
+
+  // Update the current line's text (in place on a TTY; new line otherwise,
+  // but only when the headline phase changes, to avoid log spam).
+  update(text, { phaseChanged = false } = {}) {
+    this.text = text;
+    if (this.tty) this._render();
+    else if (phaseChanged && text !== this.lastPlain) { this.stream.write(`  ${text}\n`); this.lastPlain = text; }
+  }
+
+  // Stop and erase the line (TTY), so the report/output prints cleanly after.
+  stop() {
+    if (this.timer) { clearInterval(this.timer); this.timer = null; }
+    if (this.tty) this.stream.write("\r\x1b[2K");
+  }
+
+  // Stop and leave a final check-marked line in place.
+  done(text) {
+    if (this.timer) { clearInterval(this.timer); this.timer = null; }
+    const secs = ((Date.now() - this.start) / 1000).toFixed(1);
+    if (this.tty) {
+      this.stream.write(`\r\x1b[2K  ${GREEN}\u2714${RESET} ${text} ${DIM}(${secs}s)${RESET}\n`);
+    } else {
+      this.stream.write(`  \u2714 ${text} (${secs}s)\n`);
+    }
+  }
+}
+
+// Build an onProgress handler for scan() that drives a spinner. Throttled so we
+// don't repaint on every single file.
+function attachProgress(spinner) {
+  let lastPaint = 0;
+  let curPhase = null;
+  return (ev) => {
+    const now = Date.now();
+    if (ev.phase !== curPhase) {
+      curPhase = ev.phase;
+      const headline = {
+        discover: "Discovering files\u2026",
+        scan: "Scanning source\u2026",
+        osv: "Checking dependencies against OSV.dev\u2026",
+        history: "Scanning git history for secrets\u2026",
+        grade: "Grading results\u2026",
+      }[ev.phase] || ev.phase;
+      spinner.update(headline, { phaseChanged: true });
+      lastPaint = now;
+      return;
+    }
+    if (ev.phase === "scan" && ev.total) {
+      if (now - lastPaint < 60) return; // throttle
+      lastPaint = now;
+      const name = ev.file ? ` ${DIM}${truncate(ev.file, 40)}${RESET}` : "";
+      spinner.update(`Scanning source ${ev.current}/${ev.total}\u2026${name}`);
+    }
+  };
+}
+
+function truncate(s, n) { return s.length <= n ? s : "\u2026" + s.slice(-(n - 1)); }
+
+module.exports = { Spinner, attachProgress };