refactor: use regexp-groups to simplify ignores (POC)

Author: ST-DDT

lib/rules/syntaxes/slot-attribute.js

@@ -16,8 +16,7 @@ module.exports = {
     /** @type {{ ignore: string[] }} */
     const options = context.options[0] || {}
     const { ignore = [] } = options
-    /** @type {RegExp[]} */
-    const ignorePatterns = ignore.map(regexp.toRegExp)
+    const ignoreGroupMatcher = regexp.toRegExpGroupMatcher(ignore)
 
     const sourceCode = context.getSourceCode()
     const tokenStore =
@@ -125,15 +124,12 @@ module.exports = {
      */
     function reportSlot(slotAttr) {
       const componentName = slotAttr.parent.parent.rawName
-      const componentNamePascalCase = casing.pascalCase(componentName)
-      const componentNameKebabCase = casing.kebabCase(componentName)
 
       if (
-        ignorePatterns.some(
-          (pattern) =>
-            pattern.test(componentName) ||
-            pattern.test(componentNamePascalCase) ||
-            pattern.test(componentNameKebabCase)
+        ignoreGroupMatcher(
+          componentName,
+          casing.pascalCase(componentName),
+          casing.kebabCase(componentName)
         )
       ) {
         return

lib/utils/regexp.js

@@ -41,8 +41,32 @@ function isRegExp(string) {
   return RE_REGEXP_STR.test(string)
 }
 
+/**
+ * Converts an array of strings to a singular function to match any of them.
+ * This function converts each string to a `RegExp` and returns a function that checks all of them.
+ *
+ * @param {string[]} [patterns] The strings or regular expression strings to match.
+ * @returns {(...toCheck: string[]) => boolean} Returns a function that checks if any string matches any of the given patterns.
+ */
+function toRegExpGroupMatcher(patterns = []) {
+  if (patterns.length === 0) {
+    return () => false
+  }
+
+  // In the future, we could optimize this by joining expressions with identical flags.
+  const regexps = patterns.map(toRegExp)
+
+  if (regexps.length === 1) {
+    return (...toCheck) => toCheck.some((str) => regexps[0].test(str))
+  }
+
+  return (...toCheck) =>
+    regexps.some((regexp) => toCheck.some((str) => regexp.test(str)))
+}
+
 module.exports = {
   escape,
   toRegExp,
-  isRegExp
+  isRegExp,
+  toRegExpGroupMatcher
 }

tests/lib/utils/regexp.js

@@ -1,6 +1,10 @@
 'use strict'
 
-const { escape, toRegExp } = require('../../../lib/utils/regexp')
+const {
+  escape,
+  toRegExp,
+  toRegExpGroupMatcher
+} = require('../../../lib/utils/regexp')
 const assert = require('assert')
 
 const ESCAPED = '\\^\\$\\.\\*\\+\\?\\(\\)\\[\\]\\{\\}\\|\\\\'
@@ -36,3 +40,57 @@ describe('toRegExp()', () => {
     assert.deepEqual(toRegExp(`${/[\sA-Z]+/u}`), /[\sA-Z]+/u)
   })
 })
+
+describe('toRegExpCheckGroup()', () => {
+  it('should return a function missing inout', () => {
+    const groupMatcher = toRegExpGroupMatcher()
+    assert.strictEqual(groupMatcher(''), false)
+    assert.strictEqual(groupMatcher('foo'), false)
+    assert.strictEqual(groupMatcher('bar'), false)
+  })
+
+  it('should return a function for empty array', () => {
+    const groupMatcher = toRegExpGroupMatcher([])
+    assert.strictEqual(groupMatcher(''), false)
+    assert.strictEqual(groupMatcher('foo'), false)
+    assert.strictEqual(groupMatcher('bar'), false)
+  })
+
+  it('should return a function for single simple pattern', () => {
+    const groupMatcher = toRegExpGroupMatcher(['foo'])
+    assert.strictEqual(groupMatcher(''), false)
+    assert.strictEqual(groupMatcher('foo'), true)
+    assert.strictEqual(groupMatcher('foo', 'early'), true)
+    assert.strictEqual(groupMatcher('late', 'matches', 'foo'), true)
+    assert.strictEqual(groupMatcher('foobar'), false)
+    assert.strictEqual(groupMatcher('afoo', 'fooa', 'afooa', 'bar'), false)
+  })
+
+  it('should return a function for multiple simple patterns', () => {
+    const groupMatcher = toRegExpGroupMatcher(['foo', 'bar'])
+    assert.strictEqual(groupMatcher('foo'), true)
+    assert.strictEqual(groupMatcher('bar', 'early'), true)
+    assert.strictEqual(groupMatcher('late', 'matches', 'foo'), true)
+    assert.strictEqual(groupMatcher('foobar'), false)
+    assert.strictEqual(groupMatcher('afoo', 'fooa', 'afooa'), false)
+  })
+
+  it('should return a function for single regexp pattern', () => {
+    const groupMatcher = toRegExpGroupMatcher(['/^foo/'])
+    assert.strictEqual(groupMatcher(''), false)
+    assert.strictEqual(groupMatcher('foo'), true)
+    assert.strictEqual(groupMatcher('fooa', 'early'), true)
+    assert.strictEqual(groupMatcher('late', 'matches', 'fooa'), true)
+    assert.strictEqual(groupMatcher('barfoo'), false)
+    assert.strictEqual(groupMatcher('afoo', 'afooa', 'bar'), false)
+  })
+
+  it('should return a function for multiple regexp patterns', () => {
+    const groupMatcher = toRegExpGroupMatcher(['/^foo/', '/bar$/'])
+    assert.strictEqual(groupMatcher('foo'), true)
+    assert.strictEqual(groupMatcher('bar', 'early'), true)
+    assert.strictEqual(groupMatcher('late', 'matches', 'foo'), true)
+    assert.strictEqual(groupMatcher('barfoo'), false)
+    assert.strictEqual(groupMatcher('afoo', 'afooa', 'bara'), false)
+  })
+})