privacy-brush 1.0.0 → 1.0.2

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "privacy-brush",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Automatically  mask sensitive information in terminal outputs and logs. Keep your data safe when sharing.",
   "main": "src/index.mjs",
   "module": "src/index.mjs",
   "bin": "src/cli.mjs",
   "scripts": {
-    "test": "node --test",
+    "test": "node --test || nvm use 22 && sleep 0.5 && node --test",
     "typecheck": "tsgo --noEmit",
     "check": "npm run typecheck && npm run test",
     "========== Publishing ==========": "",
@@ -17,10 +17,31 @@
     "postversion": "npm publish && git push origin HEAD && git push --tags",
     "publishd": "npm publish --dry-run"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "keywords": [
+    "privacy",
+    "mask",
+    "masking",
+    "sensitive",
+    "guard",
+    "shield",
+    "safe",
+    "sharing",
+    "sanitize",
+    "obfuscate",
+    "blur",
+    "logs",
+    "terminal",
+    "security"
+  ],
+  "author": "legend80s",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/legend80s/privacy-brush.git"
+  },
+  "homepage": "https://github.com/legend80s/privacy-brush",
   "devDependencies": {
+    "@typescript/native-preview": "7.0.0-dev.20260122.2",
     "@types/node": "^25.0.10"
   }
 }

package/src/cli.mjs

@@ -1,3 +1,5 @@
+#!/usr/bin/env node
+
 import { PrivacyBrush } from "./index.mjs"
 import { parsedResult, verbose } from "./lib/parse-args.mjs"
 
@@ -26,6 +28,7 @@ async function main() {
   }
 
   const { values } = result
+  verbose && console.log("values:", values)
 
   if (values.help) {
     await printHelp()
@@ -37,9 +40,6 @@ async function main() {
     return
   }
 
-  verbose && console.log("values:", values)
-  // console.log("positionals:", positionals)
-
   const config = values
 
   const masker = new PrivacyBrush({
@@ -48,6 +48,23 @@ async function main() {
     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 {
@@ -113,10 +130,13 @@ 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)
+  --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)

package/src/cli.test.mjs

@@ -27,12 +27,13 @@ test("❯ echo | node src/cli.mjs", async () => {
 test("--mask", async () => {
   const actual = execSync(
     'echo Microsoft Windows [Version 10.0.12345.6785] | node src/cli.mjs --mask "🔒" --no-preserve-first',
-  ).toString("utf8")
+  )
+    .toString("utf8")
+    .trim()
 
   // console.log(`actual:|${actual}|`)
 
-  const expected =
-    "Microsoft Windows [Version 🔒🔒.🔒.🔒🔒🔒🔒🔒.🔒🔒🔒🔒] \r\n"
+  const expected = "Microsoft Windows [Version 🔒🔒.🔒.🔒🔒🔒🔒🔒.🔒🔒🔒🔒]"
   assert.strictEqual(actual, expected)
 })
 
@@ -78,33 +79,41 @@ DEBUG: OS: Windows 10.0.12345
 test(`custom patterns`, () => {
   const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
 
-  const actual = execSync(
-    `echo ${input} | node src/cli.mjs --pattern /sk-([a-z0-9]{20,})/`,
-  ).toString("utf8")
+  const actual = spawnSync(
+    "node",
+    ["src/cli.mjs", "--pattern", "/sk-([a-z0-9]{20,})/"],
+    { input },
+  ).stdout.toString("utf8")
 
-  const expected = "DEEPSEEK_API_KEY=sk-████████████████████████████████ \r\n"
+  const expected = "DEEPSEEK_API_KEY=sk-████████████████████████████████"
   assert.strictEqual(actual, expected)
 })
 
-test(`custom patterns`, () => {
+test(`custom patterns without ()`, () => {
   const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
 
-  const actual = execSync(
-    `echo ${input} | node src/cli.mjs --pattern /sk-[a-z0-9]{20,}/`,
-  ).toString("utf8")
+  const actual = spawnSync(
+    "node",
+    ["src/cli.mjs", "--pattern", "/sk-[a-z0-9]{20,}/"],
+    { input },
+  )
+    .stdout.toString("utf8")
+    .trim()
 
-  const expected = "DEEPSEEK_API_KEY=███████████████████████████████████ \r\n"
+  const expected = "DEEPSEEK_API_KEY=███████████████████████████████████"
   assert.strictEqual(actual, expected)
 })
 
 test(`custom patterns`, () => {
   const input = `DEEPSEEK_API_KEY=sk-af75149812524eb08eb302bf9604c8e8`
 
-  const actual = execSync(
-    `echo ${input} | node src/cli.mjs --pattern /([0-9]{2,})/`,
-  ).toString("utf8")
+  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 \r\n"
+  const expected = "DEEPSEEK_API_KEY=sk-af███████████eb██eb███bf████c8e8"
   assert.strictEqual(actual, expected)
 })
 

package/src/index.mjs

@@ -68,6 +68,22 @@ export class PrivacyBrush {
           return this.maskVersion(match)
         },
       },
+
+      // user name `/Users/test/code/` => `/Users/████/code/`
+      {
+        /** @type {IPatternName} */
+        name: "user_name_in_path",
+        regex: /\/Users\/([^\/]+)\//g,
+        /**
+         * Handle user name in file path masking.
+         * @param {string} match
+         * @param {string} userName
+         * @returns {string}
+         */
+        replacer: (match, userName) => {
+          return match.replace(userName, this.maskChar.repeat(userName.length))
+        },
+      },
     ]
 
     return allPatterns
@@ -187,6 +203,7 @@ export class PrivacyBrush {
     let result = text
 
     this.sensitivePatterns.forEach(pattern => {
+      verbose && console.log("pattern:", pattern)
       result = result.replace(pattern.regex, pattern.replacer)
     })
 

package/src/lib/config.mjs

@@ -4,6 +4,11 @@
 export const defaultConfig = {
   maskChar: "█",
   preserveFirstPart: true, // 是否保留版本号的第一部分
-  maskPatternNames: ["windows_version", "browser_version", "ip_address"],
+  maskPatternNames: [
+    "windows_version",
+    "browser_version",
+    "ip_address",
+    "user_name_in_path",
+  ],
   customPatterns: [],
 }

package/src/lib/parse-args.mjs

@@ -55,6 +55,10 @@ export const parsedResult = safeCall(() =>
         type: "boolean",
         short: "v",
       },
+      // list built-in patterns
+      "list-patterns": {
+        type: "boolean",
+      },
     },
   }),
 )