logshield-cli 0.3.4 → 0.3.6

package/CHANGELOG.md

@@ -0,0 +1,61 @@
+# Changelog
+
+## v0.3.6
+
+### Fixed
+
+- `--summary` output now correctly written to stderr (safe for piping & redirects)
+
+### Improved
+
+- CLI documentation clarity
+- Blog and docs structure consistency
+- Shared `styles.css` and `main.js` across site pages
+
+### Notes
+
+- No breaking changes
+
+## v0.3.5
+
+### Fixed
+
+- Corrected CLI version injection in built CJS output
+- Ensured published npm package reflects actual CLI version
+
+### Improved
+
+- Deterministic `--dry-run` report formatting (aligned, CI-safe)
+- Dry-run output now strictly non-contextual and stdout-only
+
+### Notes
+
+- No engine or rule behavior changes
+- Pure CLI/build correctness release
+
+---
+
+## v0.3.4
+
+### Fixed
+
+- README CI badge link on npmjs.com
+
+---
+
+## v0.3.3
+
+### Added
+
+- `--dry-run` mode to detect secrets without modifying output
+- CI-friendly detection workflow (`--dry-run --fail-on-detect`)
+
+### Improved
+
+- CLI UX consistency
+- README documentation clarity
+
+### Notes
+
+- No breaking changes
+- Engine behavior unchanged

package/dist/cli/index.cjs

@@ -9,9 +9,6 @@ var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __esm = (fn, res) => function __init() {
   return fn && (res = (0, fn[__getOwnPropNames(fn)[0]])(fn = 0)), res;
 };
-var __commonJS = (cb, mod) => function __require() {
-  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
-};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -83,6 +80,42 @@ var init_writeOutput = __esm({
   }
 });
 
+// src/cli/summary.ts
+var summary_exports = {};
+__export(summary_exports, {
+  printSummary: () => printSummary
+});
+function printSummary(matches) {
+  if (!matches || matches.length === 0) {
+    process.stderr.write("logshield: no redactions detected\n");
+    return;
+  }
+  const counter = {};
+  for (const m of matches) {
+    counter[m.rule] = (counter[m.rule] || 0) + 1;
+  }
+  const entries = Object.entries(counter).map(([rule, count]) => ({ rule, count })).sort((a, b) => {
+    if (b.count !== a.count) return b.count - a.count;
+    return a.rule.localeCompare(b.rule);
+  });
+  const maxLen = Math.max(...entries.map((e) => e.rule.length));
+  const total = matches.length;
+  const label = total === 1 ? "redaction" : "redactions";
+  process.stderr.write(`logshield summary: ${total} ${label}
+`);
+  for (const { rule, count } of entries) {
+    process.stderr.write(
+      `  ${rule.padEnd(maxLen)}  x${count}
+`
+    );
+  }
+}
+var init_summary = __esm({
+  "src/cli/summary.ts"() {
+    "use strict";
+  }
+});
+
 // src/engine/applyRules.ts
 function applyRules(input, rules, ctx, matches) {
   let output = input;
@@ -349,144 +382,14 @@ var init_sanitizeLog = __esm({
   }
 });
 
-// src/cli/summary.ts
-var require_summary = __commonJS({
-  "src/cli/summary.ts"() {
-    "use strict";
-    var { readInput: readInput3 } = (init_readInput(), __toCommonJS(readInput_exports));
-    var { writeOutput: writeOutput3 } = (init_writeOutput(), __toCommonJS(writeOutput_exports));
-    var { printSummary: printSummary2 } = require_summary();
-    var { sanitizeLog: sanitizeLog3 } = (init_sanitizeLog(), __toCommonJS(sanitizeLog_exports));
-    var rawArgs2 = process.argv.slice(2).map((arg) => arg === "-h" ? "--help" : arg);
-    function getVersion2() {
-      return true ? "0.3.2" : "unknown";
-    }
-    function printHelp2() {
-      process.stdout.write(`Usage: logshield scan [file]
-
-Behavior:
-  - If a file is provided, LogShield reads from that file
-  - If input is piped, LogShield reads from STDIN automatically
-  - --stdin is optional and only needed for explicitness
-
-Options:
-  --strict            Aggressive redaction
-  --dry-run           Preview redactions without modifying output
-  --stdin             Force read from STDIN
-  --fail-on-detect    Exit with code 1 if any redaction occurs
-  --json              JSON output
-  --summary           Print summary
-  --version           Print version
-  --help              Show help
-`);
-    }
-    function parseArgs2(args) {
-      const flags = /* @__PURE__ */ new Set();
-      const positionals = [];
-      for (const arg of args) {
-        if (arg.startsWith("--")) {
-          flags.add(arg);
-        } else {
-          positionals.push(arg);
-        }
-      }
-      return { flags, positionals };
-    }
-    function isStdinPiped2() {
-      return !process.stdin.isTTY;
-    }
-    function renderDryRunReport2(matches) {
-      if (matches.length === 0) {
-        process.stdout.write("[DRY RUN] No redactions detected.\n");
-        process.stdout.write("No output was modified.\n");
-        return;
-      }
-      const counts = /* @__PURE__ */ new Map();
-      for (const m of matches) {
-        counts.set(m.rule, (counts.get(m.rule) || 0) + 1);
-      }
-      process.stdout.write("[DRY RUN] Detected redactions:\n");
-      const maxLen = Math.max(
-        ...Array.from(counts.keys()).map((k) => k.length)
-      );
-      for (const [rule, count] of counts.entries()) {
-        process.stdout.write(
-          `  ${rule.padEnd(maxLen)}  x${count}
-`
-        );
-      }
-      process.stdout.write("\n");
-      process.stdout.write("No output was modified.\n");
-      process.stdout.write("Use without --dry-run to apply.\n");
-    }
-    async function main2() {
-      if (rawArgs2.length === 0 || rawArgs2.includes("--help")) {
-        printHelp2();
-        process.exit(0);
-      }
-      if (rawArgs2.includes("--version")) {
-        console.log(`logshield v${getVersion2()}`);
-        process.exit(0);
-      }
-      const { flags, positionals } = parseArgs2(rawArgs2);
-      const command = positionals[0];
-      if (command !== "scan") {
-        process.stdout.write("Unknown command\n");
-        process.exit(1);
-      }
-      const file = positionals[1];
-      const strict = flags.has("--strict");
-      const json = flags.has("--json");
-      const summary = flags.has("--summary");
-      const stdinFlag = flags.has("--stdin");
-      const failOnDetect = flags.has("--fail-on-detect");
-      const dryRun = flags.has("--dry-run");
-      const stdinAuto = isStdinPiped2();
-      const useStdin = stdinFlag || stdinAuto;
-      if (useStdin && file) {
-        process.stdout.write("Cannot read from both STDIN and file\n");
-        process.exit(1);
-      }
-      if (dryRun && json) {
-        process.stdout.write("--dry-run cannot be used with --json\n");
-        process.exit(1);
-      }
-      try {
-        const input = await readInput3(useStdin ? void 0 : file);
-        const result = sanitizeLog3(input, { strict });
-        if (dryRun) {
-          renderDryRunReport2(result.matches);
-          if (failOnDetect && result.matches.length > 0) {
-            process.exit(1);
-          }
-          process.exit(0);
-        }
-        writeOutput3(result, { json });
-        if (summary) {
-          printSummary2(result.matches);
-        }
-        if (failOnDetect && result.matches.length > 0) {
-          process.exit(1);
-        }
-        process.exit(0);
-      } catch (err) {
-        process.stdout.write(err?.message || "Unexpected error");
-        process.stdout.write("\n");
-        process.exit(2);
-      }
-    }
-    main2();
-  }
-});
-
 // src/cli/index.ts
 var { readInput: readInput2 } = (init_readInput(), __toCommonJS(readInput_exports));
 var { writeOutput: writeOutput2 } = (init_writeOutput(), __toCommonJS(writeOutput_exports));
-var { printSummary } = require_summary();
+var { printSummary: printSummary2 } = (init_summary(), __toCommonJS(summary_exports));
 var { sanitizeLog: sanitizeLog2 } = (init_sanitizeLog(), __toCommonJS(sanitizeLog_exports));
 var rawArgs = process.argv.slice(2).map((arg) => arg === "-h" ? "--help" : arg);
 function getVersion() {
-  return true ? "0.3.2" : "unknown";
+  return true ? "0.3.6" : "unknown";
 }
 function printHelp() {
   process.stdout.write(`Usage: logshield scan [file]
@@ -586,6 +489,10 @@ async function main() {
     process.stdout.write("--dry-run cannot be used with --json\n");
     process.exit(1);
   }
+  if (json && summary) {
+    process.stdout.write("--summary cannot be used with --json\n");
+    process.exit(1);
+  }
   try {
     const input = await readInput2(useStdin ? void 0 : file);
     const result = sanitizeLog2(input, { strict });
@@ -598,7 +505,7 @@ async function main() {
     }
     writeOutput2(result, { json });
     if (summary) {
-      printSummary(result.matches);
+      printSummary2(result.matches);
     }
     if (failOnDetect && result.matches.length > 0) {
       process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "logshield-cli",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "license": "ISC",
   "type": "commonjs",
   "bin": {
@@ -9,14 +9,17 @@
   "files": [
     "dist",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE"
   ],
   "scripts": {
     "build": "node scripts/build-cli.cjs",
     "build:web": "vite build --outDir dist-web",
+    "build:blog": "node scripts/build-blog.js",
     "dev:web": "vite",
     "pretest": "npm run build",
-    "test": "vitest"
+    "test": "vitest",
+    "prepublishOnly": "npm run build"
   },
   "devDependencies": {
     "@types/node": "^25.0.3",