privacy-brush 0.0.4 → 1.0.1

package/src/index.mjs

@@ -1,162 +1,256 @@
-/** @import { IConfig, IPattern, IPatternName } from "./type.js" */
-
-import { defaultConfig } from "./lib/config.mjs"
-
-export class PrivacyBrush {
-  /**
-   * @param {IConfig} [config]
-   */
-  constructor(config) {
-    this.config = {
-      ...defaultConfig,
-      ...config,
-    }
-  }
-
-  get defaultSensitivePatterns() {
-    /** @type {IPattern[]} */
-    const allPatterns = [
-      // 操作系统版本 (Windows 10.0.19045.6456)
-      {
-        /** @type {IPatternName} */
-        name: "windows_version",
-        // match both Chinese "版本" and English "Version"
-        regex: /(\[(?:版本|Version)\s+)(\d+\.\d+\.\d+\.\d+)(\])/i,
-        /**
-         * Handle windows version masking.
-         * @param {string} match
-         * @param {string} prefix
-         * @param {string} version
-         * @param {string} suffix
-         * @returns {string}
-         */
-        replacer: (match, prefix, version, suffix) => {
-          return prefix + this.maskVersion(version) + suffix
-        },
-      },
-
-      // 浏览器版本 (Chrome 144.0.7559.60)
-      {
-        /** @type {IPatternName} */
-        name: "browser_version",
-        regex: /(Chrome|Edge)\s+(\d+\.\d+\.\d+\.\d+)/gi,
-        /**
-         * Handle browser version masking.
-         * @param {string} match
-         * @param {string} browser
-         * @param {string} version
-         * @returns {string}
-         */
-        replacer: (match, browser, version) => {
-          return `${browser} ${this.maskVersion(version)}`
-        },
-      },
-
-      // IP地址
-      {
-        /** @type {IPatternName} */
-        name: "ip_address",
-        regex: /\b(\d{1,3}\.){3}\d{1,3}\b/g,
-        /**
-         * Handle IP address masking.
-         * @param {string} match
-         * @returns {string}
-         */
-        replacer: match => {
-          return this.maskVersion(match)
-        },
-      },
-    ]
-
-    return allPatterns
-  }
-
-  get maskChar() {
-    return this.config.maskChar ?? defaultConfig.maskChar
-  }
-
-  /**
-   *
-   * @returns {IPattern[]}
-   */
-  get sensitivePatterns() {
-    return this.defaultSensitivePatterns.filter(({ name }) =>
-      this.config.maskPatternNames?.includes(name),
-    )
-  }
-
-  /**
-   * Mask a version string.
-   * @param {string} version
-   * @returns {string}
-   */
-  maskVersion(version) {
-    const parts = version.split(".")
-
-    if (!this.config.preserveFirstPart) {
-      return parts.map(part => this.maskChar.repeat(part.length)).join(".")
-    }
-
-    return parts
-      .map((part, index) => {
-        return index === 0 ? part : this.maskChar.repeat(part.length)
-      })
-      .join(".")
-  }
-
-  /**
-   *
-   * @param {string} text
-   * @returns
-   */
-  maskText(text) {
-    let result = text
-
-    this.sensitivePatterns.forEach(pattern => {
-      result = result.replace(pattern.regex, pattern.replacer)
-    })
-
-    return result
-  }
-
-  /**
-   * 批量处理文件
-   * @param {string} inputPath
-   * @param {string} outputPath
-   * @returns
-   */
-  maskFile(inputPath, outputPath) {
-    try {
-      const fs = require("node:fs")
-
-      const content = fs.readFileSync(inputPath, "utf8")
-      const maskedContent = this.maskText(content)
-
-      if (outputPath) {
-        fs.writeFileSync(outputPath, maskedContent, "utf8")
-        console.log(`Masked file saved to: ${outputPath}`)
-      }
-
-      return maskedContent
-    } catch (error) {
-      console.error(
-        "Error processing file:",
-        error instanceof Error ? error.message : String(error),
-      )
-      throw error
-    }
-  }
-
-  // 实时流处理
-  async createMaskStream() {
-    const { Transform } = await import("node:stream")
-
-    return new Transform({
-      transform: (chunk, encoding, callback) => {
-        const text = String(chunk)
-        const masked = this.maskText(text)
-        callback(null, masked)
-      },
-    })
-  }
-}
+/** @import { IConfig, IPattern, IPatternName } from "./type.js" */
+
+import { createRequire } from "node:module"
+import { defaultConfig } from "./lib/config.mjs"
+import { verbose } from "./lib/parse-args.mjs"
+
+export class PrivacyBrush {
+  /**
+   * @param {IConfig} [config]
+   */
+  constructor(config) {
+    this.config = {
+      ...defaultConfig,
+      ...config,
+    }
+  }
+
+  get defaultSensitivePatterns() {
+    /** @type {IPattern[]} */
+    const allPatterns = [
+      // 操作系统版本 (Windows 10.0.19045.6456)
+      {
+        /** @type {IPatternName} */
+        name: "windows_version",
+        // match both Chinese "版本" and English "Version"
+        regex: /(\[(?:版本|Version)\s+)(\d+\.\d+\.\d+\.\d+)(\])/i,
+        /**
+         * Handle windows version masking.
+         * @param {string} match
+         * @param {string} prefix
+         * @param {string} version
+         * @param {string} suffix
+         * @returns {string}
+         */
+        replacer: (match, prefix, version, suffix) => {
+          return prefix + this.maskVersion(version) + suffix
+        },
+      },
+
+      // 浏览器版本 (Chrome 144.0.7559.60)
+      {
+        /** @type {IPatternName} */
+        name: "browser_version",
+        regex: /(Chrome|Edge)\s+(\d+\.\d+\.\d+\.\d+)/gi,
+        /**
+         * Handle browser version masking.
+         * @param {string} match
+         * @param {string} browser
+         * @param {string} version
+         * @returns {string}
+         */
+        replacer: (match, browser, version) => {
+          return `${browser} ${this.maskVersion(version)}`
+        },
+      },
+
+      // IP地址
+      {
+        /** @type {IPatternName} */
+        name: "ip_address",
+        regex: /\b(\d{1,3}\.){3}\d{1,3}\b/g,
+        /**
+         * Handle IP address masking.
+         * @param {string} match
+         * @returns {string}
+         */
+        replacer: match => {
+          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
+  }
+
+  /**
+   * Parse custom pattern inputs into maskable patterns.
+   * Accepts strings like '/sk-[a-z0-9]{20,}/i' or raw pattern bodies.
+   * @returns {IPattern[]}
+   */
+  get customSensitivePatterns() {
+    const customPatterns = this.config.customPatterns || []
+
+    /**
+     * Parse string pattern to RegExp.
+     * @param {string | RegExp} pattern
+     * @returns {RegExp} returns Parsed RegExp with global flag
+     * @example
+     * '/\\d{1,}/' => /\d{1,}/g
+     */
+    const parse = pattern => {
+      if (pattern instanceof RegExp) {
+        // always replace globally
+        const flags = pattern.flags.includes("g")
+          ? pattern.flags
+          : `${pattern.flags}g`
+
+        return new RegExp(pattern.source, flags)
+      }
+
+      const patternStr = pattern.trim()
+      // `/\d{1,}/g`.match(/^\/(.*)\/(\w*)$/) => [/\d{1,}/g, '\d{1,}', 'g']
+      const matches = patternStr.match(/^\/(.*)\/(\w*)$/)
+
+      if (matches) {
+        const body = matches[1]
+        let flags = matches[2] ?? ""
+
+        if (!flags.includes("g")) flags += "g"
+
+        return new RegExp(body, flags)
+      }
+
+      // treat as literal body
+      return new RegExp(patternStr, "g")
+    }
+
+    return customPatterns.map((pattern, i) => {
+      const regex = parse(pattern)
+      return {
+        name: `custom_${i + 1}`,
+        regex,
+        replacer: (match, group) => {
+          // const groups = rest.slice(0, -2) // last two are offset and input string
+          verbose && console.log("custom pattern match:", { match, group })
+
+          if (typeof group === "string") {
+            return match.replace(group, this.maskChar.repeat(group.length))
+          }
+
+          return this.maskChar.repeat(match.length)
+        },
+      }
+    })
+  }
+
+  get maskChar() {
+    return this.config.maskChar ?? defaultConfig.maskChar
+  }
+
+  /**
+   *
+   * @returns {IPattern[]}
+   */
+  get sensitivePatterns() {
+    const base = this.defaultSensitivePatterns.filter(({ name }) =>
+      this.config.maskPatternNames?.includes(name),
+    )
+
+    const customSensitivePatterns = this.customSensitivePatterns
+    verbose &&
+      console.log(
+        "🚀 ~ PrivacyBrush ~ sensitivePatterns ~ customSensitivePatterns:",
+        customSensitivePatterns,
+      )
+
+    return base.concat(customSensitivePatterns)
+  }
+
+  /**
+   * Mask a version string.
+   * @param {string} version
+   * @returns {string}
+   */
+  maskVersion(version) {
+    const parts = version.split(".")
+
+    if (!this.config.preserveFirstPart) {
+      return parts.map(part => this.maskChar.repeat(part.length)).join(".")
+    }
+
+    return parts
+      .map((part, index) => {
+        return index === 0 ? part : this.maskChar.repeat(part.length)
+      })
+      .join(".")
+  }
+
+  /**
+   *
+   * @param {string} text
+   * @returns
+   */
+  maskText(text) {
+    verbose && console.log(`[PrivacyBrush] Masking text: |${text}|`)
+
+    let result = text
+
+    this.sensitivePatterns.forEach(pattern => {
+      verbose && console.log("pattern:", pattern)
+      result = result.replace(pattern.regex, pattern.replacer)
+    })
+
+    return result
+  }
+
+  /**
+   * 批量处理文件
+   * @param {string} inputPath
+   * @param {string} [outputPath]
+   * @returns
+   */
+  maskFile(inputPath, outputPath) {
+    try {
+      // Delay-load fs to avoid startup cost when this method is not used
+      const require = createRequire(import.meta.url)
+      const fs = require("node:fs")
+
+      const content = fs.readFileSync(inputPath, "utf8")
+      const maskedContent = this.maskText(content)
+
+      if (outputPath) {
+        fs.writeFileSync(outputPath, maskedContent, "utf8")
+        verbose && console.log(`Masked file saved to: ${outputPath}`)
+      }
+
+      return maskedContent
+    } catch (error) {
+      console.error(
+        "Error processing file:",
+        error instanceof Error ? error.message : String(error),
+      )
+      throw error
+    }
+  }
+
+  // 实时流处理
+  async createMaskStream() {
+    const { Transform } = await import("node:stream")
+
+    return new Transform({
+      transform: (chunk, encoding, callback) => {
+        const text = String(chunk)
+
+        const masked = this.maskText(text)
+        callback(null, masked)
+      },
+    })
+  }
+}

package/src/lib/config.mjs

@@ -1,8 +1,14 @@
-/**
- * @type {Required<import('../type.js').IConfig>}
- */
-export const defaultConfig = {
-  maskChar: "█",
-  preserveFirstPart: true, // 是否保留版本号的第一部分
-  maskPatternNames: ["windows_version", "browser_version", "ip_address"],
-}
+/**
+ * @satisfies {import('../type.js').IConfig}
+ */
+export const defaultConfig = {
+  maskChar: "█",
+  preserveFirstPart: true, // 是否保留版本号的第一部分
+  maskPatternNames: [
+    "windows_version",
+    "browser_version",
+    "ip_address",
+    "user_name_in_path",
+  ],
+  customPatterns: [],
+}

package/src/lib/parse-args.mjs

@@ -0,0 +1,79 @@
+import { parseArgs } from "node:util"
+
+// 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' ]
+
+export const verbose = args.includes("--verbose")
+
+export const parsedResult = safeCall(() =>
+  parseArgs({
+    allowPositionals: true,
+    allowNegative: true,
+
+    args,
+
+    options: {
+      // input file to mask
+      "input-file": {
+        type: "string",
+        short: "i",
+      },
+      // custom regex pattern(s) to mask
+      pattern: {
+        type: "string",
+        short: "r",
+        multiple: true,
+      },
+      // output file to write masked content
+      "output-file": {
+        type: "string",
+        short: "o",
+      },
+      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",
+      },
+      // list built-in patterns
+      "list-patterns": {
+        type: "boolean",
+      },
+    },
+  }),
+)
+
+/**
+ * @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]
+  }
+}

package/src/type.ts

@@ -1,17 +1,19 @@
-export type IConfig = {
-  maskChar?: string
-  preserveFirstPart?: boolean
-  maskPatternNames?: IPatternName[]
-}
-
-export type IPatternName =
-  | "windows_version"
-  | "browser_version"
-  | "android_version"
-  | "ip_address"
-
-export type IPattern = {
-  name: IPatternName
-  regex: RegExp
-  replacer: (substring: string, ...args: any[]) => string
-}
+export type IConfig = {
+  maskChar?: string
+  preserveFirstPart?: boolean
+  maskPatternNames?: IPatternName[]
+  customPatterns?: (string | RegExp)[]
+}
+
+export type IPatternName =
+  | "windows_version"
+  | "browser_version"
+  | "android_version"
+  | "ip_address"
+  | (string & {})
+
+export type IPattern = {
+  name: IPatternName
+  regex: RegExp
+  replacer: (substring: string, ...args: any[]) => string
+}

package/test/fixtures/{terminal_log.txt → terminal_log.md}

@@ -1,13 +1,24 @@
-❯ 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.0.12345.6456]
-  Chrome (web)                 • chrome        • web-javascript • Google Chrome 144.0.1234.60
-  Edge (web)                   • edge          • web-javascript • Microsoft Edge 144.0.1234.82
-
-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.
+# 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.0.12345.6456]
+  Chrome (web)                 • chrome        • web-javascript • Google Chrome 144.0.1234.60
+  Edge (web)                   • edge          • web-javascript • Microsoft Edge 144.0.1234.82
+
+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.168.1.100
+DEBUG: Session ID: abc123def456
+DEBUG: Browser: Chrome/144.0.1234.60
+DEBUG: OS: Windows 10.0.12345