privacy-brush 0.0.4 → 1.0.1

package/src/cli.mjs

@@ -1,154 +1,174 @@
-import { parseArgs } from "node:util"
-import { PrivacyBrush } from "./index.mjs"
-
-// 流式处理：将 stdin 通过 masker 的 Transform 流处理后输出到 stdout
-// Usage: some_command | node src/cli.mjs
-// Example 1: echo "password" | node src/cli.mjs
-// Example 2: flutter devices | node src/cli.mjs
-// Example 3: ❯ echo 'Microsoft Windows [版本 10.0.12345.6785]' | node src/cli.mjs
-// => Microsoft Windows [版本 10.█.█████.████]
-// Example 4: ❯ node src/cli.mjs
-// Input: Microsoft Windows [版本 10.0.12345.6785]
-// Output: Microsoft Windows [版本 10.█.█████.████]
-
-// get config from command line arguments use native `parseArgs`
-// node src/cli.mjs --mask X --preserve-first false
-const args = process.argv.slice(2)
-// console.log("args:", args) // args: [ '--mask', 'X', '--preserve-first', 'false' ]
-
-const verbose = args.includes("--verbose")
-
-const [err, result] = safeCall(() =>
-  parseArgs({
-    allowPositionals: true,
-    allowNegative: true,
-
-    args,
-
-    options: {
-      mask: {
-        type: "string",
-        short: "m",
-        default: "█",
-      },
-      "preserve-first": {
-        type: "boolean",
-        short: "p",
-        default: true,
-      },
-      // help
-      help: {
-        type: "boolean",
-        short: "h",
-      },
-      // verbose
-      verbose: {
-        type: "boolean",
-      },
-      // version
-      version: {
-        type: "boolean",
-        short: "v",
-      },
-    },
-  }),
-)
-
-await main()
-
-async function main() {
-  if (err) {
-    console.error(verbose ? err : String(err))
-    console.error()
-    await printHelp()
-
-    process.exit(1)
-    return
-  }
-
-  const { values } = result
-
-  if (values.help) {
-    await printHelp()
-    return
-  }
-
-  if (values.version) {
-    await printVersion()
-    return
-  }
-
-  // console.log("values:", values)
-  // console.log("positionals:", positionals)
-
-  const config = values
-
-  const masker = new PrivacyBrush({
-    maskChar: config.mask,
-    preserveFirstPart: config["preserve-first"],
-  })
-  const maskStream = await masker.createMaskStream()
-
-  // 检查 stdin 是否连接到管道（有数据输入）
-  const isPipedInput = !process.stdin.isTTY
-
-  // 如果不是管道输入（交互模式），才显示提示
-  if (!isPipedInput) {
-    process.stdout.write("Input (Press Ctrl+C to exit...):\n")
-  }
-
-  // 处理所有数据
-  process.stdin.pipe(maskStream).pipe(process.stdout)
-}
-/**
- * @template T
- * @param {(...args: any[]) => T} fn
- * @returns {[null, T] | [Error, null]}
- */
-function safeCall(fn) {
-  try {
-    const result = fn()
-    return [null, result]
-  } catch (error) {
-    // @ts-expect-error
-    return [error, null]
-  }
-}
-
-async function printHelp() {
-  console.log(`
-                                    ${await getNameVersion()}
-
-Usage: pnpx privacy-brush [options]
-
-Options:
-  --mask, -m                Character to use for masking (default: "█")
-  --preserve-first, -p   Whether to preserve the first part of version numbers (default: true, \`--no-preserve-first\` to false)
-  --help, -h                Show this help message (default: false)
-  --verbose                 Enable verbose output (default: false)
-  --version, -v             Show version information (default: false)
-
-Examples:
-  echo "Microsoft Windows [Version 10.0.12345.6785]" | pnpx privacy-brush
-  echo "Microsoft Windows [Version 10.0.12345.6785]" | pnpx privacy-brush --mask "X" --no-preserve-first
-`)
-}
-
-async function parsePackageJSON() {
-  const fs = await import("node:fs")
-  const pkgPath = new URL("../package.json", import.meta.url)
-
-  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"))
-
-  return pkg
-}
-
-async function getNameVersion() {
-  const pkg = await parsePackageJSON()
-
-  return `${pkg.name}@${pkg.version}`
-}
-
-async function printVersion() {
-  console.log(await getNameVersion())
-}
+#!/usr/bin/env node
+
+import { PrivacyBrush } from "./index.mjs"
+import { parsedResult, verbose } from "./lib/parse-args.mjs"
+
+// 流式处理：将 stdin 通过 masker 的 Transform 流处理后输出到 stdout
+// Usage: some_command | node src/cli.mjs
+// Example 1: echo "password" | node src/cli.mjs
+// Example 2: flutter devices | node src/cli.mjs
+// Example 3: ❯ echo 'Microsoft Windows [版本 10.0.12345.6785]' | node src/cli.mjs
+// => Microsoft Windows [版本 10.█.█████.████]
+// Example 4: ❯ node src/cli.mjs
+// Input: Microsoft Windows [版本 10.0.12345.6785]
+// Output: Microsoft Windows [版本 10.█.█████.████]
+
+await main()
+
+async function main() {
+  const [err, result] = parsedResult
+
+  if (err) {
+    console.error(verbose ? err : String(err))
+    console.error()
+    await printHelp()
+
+    process.exit(1)
+    return
+  }
+
+  const { values } = result
+  verbose && console.log("values:", values)
+
+  if (values.help) {
+    await printHelp()
+    return
+  }
+
+  if (values.version) {
+    await printVersion()
+    return
+  }
+
+  const config = values
+
+  const masker = new PrivacyBrush({
+    maskChar: config.mask,
+    preserveFirstPart: config["preserve-first"],
+    customPatterns: config.pattern,
+  })
+
+  if (values["list-patterns"]) {
+    // instantiate PrivacyBrush to access default patterns
+    const patterns = masker.defaultSensitivePatterns
+
+    console.log("\nBuilt-in patterns:")
+    console.table(patterns.map(({ replacer: _, ...args }) => args))
+
+    if (masker.customSensitivePatterns.length) {
+      console.log("Custom patterns:")
+      console.table(
+        masker.customSensitivePatterns.map(({ replacer: _, ...args }) => args),
+      )
+    }
+
+    return
+  }
+
+  // If an input file is provided, process it. If --output-file is provided write there, otherwise print to stdout.
+  if (config["input-file"]) {
+    try {
+      if (config["output-file"]) {
+        // maskFile will write to the output path
+        masker.maskFile(config["input-file"], config["output-file"])
+        return
+      }
+
+      const masked = masker.maskFile(config["input-file"])
+
+      process.stdout.write(masked)
+      return
+    } catch {
+      process.exitCode = 1
+      return
+    }
+  }
+
+  // If an output file was requested for piped or interactive stdin, collect all input, mask and write to file.
+  if (config["output-file"]) {
+    try {
+      const chunks = []
+      for await (const chunk of process.stdin) {
+        chunks.push(String(chunk))
+      }
+
+      const inputText = chunks.join("")
+      console.log(`inputText: |${inputText}|`)
+      const masked = masker.maskText(inputText)
+
+      const fs = await import("node:fs/promises")
+      await fs.writeFile(config["output-file"], masked, "utf8")
+      return
+    } catch (error) {
+      console.error(error)
+      process.exitCode = 1
+      return
+    }
+  }
+
+  // 检查 stdin 是否连接到管道（有数据输入）
+  const isPipedInput = !process.stdin.isTTY
+
+  // 如果不是管道输入（交互模式），才显示提示
+  if (!isPipedInput) {
+    process.stdout.write("Input (Press Ctrl+C to exit...):\n")
+  }
+
+  const maskStream = await masker.createMaskStream()
+
+  // Default: stream masking to stdout
+  process.stdin.pipe(maskStream).pipe(process.stdout)
+}
+
+async function printHelp() {
+  console.log(`
+                                    # ${await getNameVersion()}
+
+## Usage:
+
+pnpx privacy-brush [options]
+
+
+## Options:
+  --input-file, -i          Path to input file to mask and print to stdout
+  --output-file, -o         Path to write masked output (if given, write to this file)
+  --mask, -m                Character to use for masking (default: "█")
+  --preserve-first, -p      Whether to preserve the first part of version numbers (default: true, \`--no-preserve-first\` to false)
+  --pattern, -r             Custom regex pattern(s) to mask (can be used multiple times. E.g. --pattern '\\d{2,}' --pattern 'sk-([0-9a-z]{20,})')
+  --list-patterns           List all built-in patterns
+
+  --help, -h                Show this help message (default: false)
+  --verbose                 Enable verbose output (default: false)
+  --version, -v             Show version information (default: false)
+
+
+## Examples:
+
+flutter devices | pnpx privacy-brush
+
+echo "Microsoft Windows [Version 10.0.12345.6785]" | pnpx privacy-brush
+echo "Microsoft Windows [Version 10.0.12345.6785]" | pnpx privacy-brush --mask "X" --no-preserve-first
+
+pnpx privacy-brush --input-file test/fixtures/terminal_log.md # mask and print to stdout
+pnpx privacy-brush --input-file test/fixtures/terminal_log.md --output-file masked_log.md
+`)
+}
+
+async function parsePackageJSON() {
+  const fs = await import("node:fs")
+  const pkgPath = new URL("../package.json", import.meta.url)
+
+  const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"))
+
+  return pkg
+}
+
+async function getNameVersion() {
+  const pkg = await parsePackageJSON()
+
+  return `${pkg.name}@${pkg.version}`
+}
+
+async function printVersion() {
+  console.log(await getNameVersion())
+}

package/src/cli.test.mjs

@@ -1,28 +1,169 @@
-// 流式处理
-
-import { strict as assert } from "node:assert"
-import { execSync } from "node:child_process"
-import { test } from "node:test"
-
-test("❯ echo 'Microsoft Windows [Version 10.0.12345.6785]' | node src/cli.mjs", async () => {
-  const actual = execSync(
-    "echo Microsoft Windows [Version 10.0.12345.6785] | node src/cli.mjs",
-  ).toString("utf8")
-
-  // console.log(`actual:|${actual}|`)
-
-  const expected = "Microsoft Windows [Version 10.█.█████.████] \r\n"
-  assert.strictEqual(actual, expected)
-})
-
-test("--mask", async () => {
-  const actual = execSync(
-    'echo Microsoft Windows [Version 10.0.12345.6785] | node src/cli.mjs --mask "🔒" --no-preserve-first',
-  ).toString("utf8")
-
-  // console.log(`actual:|${actual}|`)
-
-  const expected =
-    "Microsoft Windows [Version 🔒🔒.🔒.🔒🔒🔒🔒🔒.🔒🔒🔒🔒] \r\n"
-  assert.strictEqual(actual, expected)
-})
+// 流式处理
+
+import { strict as assert } from "node:assert"
+import { execSync, spawnSync } from "node:child_process"
+import { test } from "node:test"
+
+test("❯ echo | node src/cli.mjs", async () => {
+  const text = "Microsoft Windows [Version 10.0.12345.6785]"
+
+  // `echo "${text}"` will print text + newline to stdout
+  // `echo -n "${text}"` will print -n and text + newline to stdout
+  // So we use spawn with args [`-n`, text] to avoid the extra newline
+  function pipeCommands() {
+    const node = spawnSync("node", ["src/cli.mjs"], {
+      input: text,
+    })
+
+    return node.stdout.toString("utf8")
+  }
+
+  const actual = pipeCommands()
+
+  const expected = "Microsoft Windows [Version 10.█.█████.████]"
+  assert.strictEqual(actual, expected)
+})
+
+test("--mask", async () => {
+  const actual = execSync(
+    'echo Microsoft Windows [Version 10.0.12345.6785] | node src/cli.mjs --mask "🔒" --no-preserve-first',
+  )
+    .toString("utf8")
+    .trim()
+
+  // console.log(`actual:|${actual}|`)
+
+  const expected = "Microsoft Windows [Version 🔒🔒.🔒.🔒🔒🔒🔒🔒.🔒🔒🔒🔒]"
+  assert.strictEqual(actual, expected)
+})
+
+test("--input-file outputs masked file content", async () => {
+  const { execSync } = await import("node:child_process")
+
+  const inputPath = "test/fixtures/terminal_log.md"
+
+  const actual = execSync(
+    `node src/cli.mjs --input-file ${inputPath}`,
+  ).toString("utf8")
+
+  // compute expected via masker.maskFile and normalize EOLs
+  const expected = `# h1
+
+## flutter devices
+
+❯ flutter devices
+Flutter assets will be downloaded from <https://storage.flutter-io.cn>. Make sure you trust this source!
+Found 4 connected devices:
+  sdk gphone64 x86 64 (mobile) • emulator-5554 • android-x64    • Android 16 (API 36) (emulator)
+  Windows (desktop)            • windows       • windows-x64    • Microsoft Windows [版本 10.█.█████.████]
+  Chrome (web)                 • chrome        • web-javascript • Google Chrome 144.█.████.██
+  Edge (web)                   • edge          • web-javascript • Microsoft Edge 144.█.████.██
+
+Run "flutter emulators" to list and start any available device emulators.
+
+If you expected another device to be detected, please run "flutter doctor" to diagnose potential issues. You may also try
+increasing the time to wait for connected devices with the "--device-timeout" flag. Visit <https://flutter.dev/setup/> for
+troubleshooting tips.
+
+## log
+
+DEBUG: User login from IP 192.███.█.███
+DEBUG: Session ID: abc123def456
+DEBUG: Browser: Chrome/144.0.1234.60
+DEBUG: OS: Windows 10.0.12345
+`
+
+  assert.strictEqual(actual, expected)
+})
+
+test(`custom patterns`, () => {
+  const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
+
+  const actual = spawnSync(
+    "node",
+    ["src/cli.mjs", "--pattern", "/sk-([a-z0-9]{20,})/"],
+    { input },
+  ).stdout.toString("utf8")
+
+  const expected = "DEEPSEEK_API_KEY=sk-████████████████████████████████"
+  assert.strictEqual(actual, expected)
+})
+
+test(`custom patterns without ()`, () => {
+  const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
+
+  const actual = spawnSync(
+    "node",
+    ["src/cli.mjs", "--pattern", "/sk-[a-z0-9]{20,}/"],
+    { input },
+  )
+    .stdout.toString("utf8")
+    .trim()
+
+  const expected = "DEEPSEEK_API_KEY=███████████████████████████████████"
+  assert.strictEqual(actual, expected)
+})
+
+test(`custom patterns`, () => {
+  const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
+
+  const actual = spawnSync(
+    "node",
+    ["src/cli.mjs", "--pattern", "/([0-9]{2,})/"],
+    { input },
+  ).stdout.toString("utf8")
+
+  const expected = "DEEPSEEK_API_KEY=sk-af███████████eb██eb███bf████c8e8"
+  assert.strictEqual(actual, expected)
+})
+
+/**
+ * 将两个或多个命令通过管道连接起来执行，并返回最后一个命令的输出结果
+ * @param {string} cmdStrWithPipes
+ * @returns {string}
+ */
+function pipeCommands(cmdStrWithPipes) {
+  // const echo = spawnSync("echo", ["-n", text])
+  // const node = spawnSync("node", ["src/cli.mjs"], {
+  //   input: echo.stdout,
+  // })
+  // 以下代码是以上代码的泛化版本
+  const commands = cmdStrWithPipes
+    .split("|")
+    .map(cmd => cmd.trim())
+    .filter(Boolean)
+
+  if (commands.length < 2) {
+    throw new Error("At least two commands are required for piping.")
+  }
+
+  const [first, ...restCommand] = commands
+  const [cmdName, args] = splitCmdAndArgs(first)
+
+  const lastCommand = restCommand.reduce(
+    (prevProcess, cmdStr) => {
+      const [cmd, args] = splitCmdAndArgs(cmdStr)
+
+      const currentProcess = spawnSync(cmd, args, {
+        input: prevProcess.stdout,
+      })
+
+      return currentProcess
+    },
+    spawnSync(cmdName, args),
+  )
+
+  return lastCommand.stdout.toString("utf8")
+}
+
+/**
+ *
+ * @param {string} cmd
+ * @returns {[cmdName: string, args: string[]]}
+ */
+function splitCmdAndArgs(cmd) {
+  const [cmdName, ...args] = cmd.split(" ").filter(Boolean)
+  // console.log(`cmdName:|${cmdName}|`)
+  // console.log("args:", args)
+  return [cmdName, args]
+}