Summary

This PR adds support for specifying multiple patterns as an array in @secretlint/secretlint-rule-pattern. The new patterns field allows grouping related regex patterns into a single rule configuration, improving maintainability and readability.

What's Changed

• Introduced a new patterns array field that accepts multiple regex patterns
• Deprecated the existing singular pattern field (soft deprecation with backward compatibility)
• Added validation to prevent simultaneous use of both patterns and pattern fields
• Refactored pattern collection logic into a dedicated collectPatterns() function

Key Changes

• src/index.ts:

  • Added patterns?: string[] field to PatternType interface
  • Created collectPatterns() function for cleaner pattern resolution logic
  • Added validation to throw error when both fields are specified together
  • Maintained backward compatibility with deprecated pattern field

• README.md:

  • Updated usage examples to demonstrate the new patterns array
  • Added "Deprecated options" section explaining migration path
  • Updated all examples to use the preferred patterns format

Usage Example

Before (Multiple separate rules)

{
  "patterns": [
    {
      "name": "password",
      "pattern": "/password\\s*=\\s*[\\w\\d]+/"
    },
    {
      "name": "apikey", 
      "pattern": "/apikey\\s*=\\s*[\\w\\d]+/"
    }
  ]
}

After (Single rule with multiple patterns)

{
  "patterns": [
    {
      "name": "credentials",
      "patterns": [
        "/password\\s*=\\s*[\\w\\d]+/",
        "/apikey\\s*=\\s*[\\w\\d]+/",
        "/token\\s*=\\s*[\\w\\d]+/"
      ]
    }
  ]
}

Test Plan

• Verify new patterns array correctly detects multiple patterns
• Confirm existing pattern field continues to work (backward compatibility)
• Test that specifying both patterns and pattern throws appropriate error
• Verify filePathGlobs works correctly with new patterns array
• Test error handling when neither patterns nor filePathGlobs are specified
• Validate README examples work as documented

Breaking Changes

• Minor breaking change: Specifying both patterns and pattern fields together now throws an error. Users must choose one or the other.

Additional Notes

• The pattern field remains functional but is now deprecated
• Migration period allows both formats to coexist (just not in the same rule)
• Related to feat: Add filePathGlobs option to @secretlint/secretlint-rule-pattern #1184 which added filePathGlobs option

🤖 Generated with Claude Code