chore: use glob patterns instead of regex

jsx-eslint · Jul 12, 2024 · b827d6b · b827d6b
1 parent 58c9063
commit b827d6b
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/docs/rules/jsx-handler-names.md b/docs/rules/jsx-handler-names.md
@@ -44,7 +44,7 @@ Examples of **correct** code for this rule:
 - `eventHandlerPropPrefix`: Prefix for props that are used as event handlers. Defaults to `on`
 - `checkLocalVariables`: Determines whether event handlers stored as local variables are checked. Defaults to `false`
 - `checkInlineFunction`: Determines whether event handlers set as inline functions are checked. Defaults to `false`
-- `ignoreComponentNames`: Array of regex, when matched with component name, ignores the rule on that component. Defaults to `[]`
+- `ignoreComponentNames`: Array of glob strings, when matched with component name, ignores the rule on that component. Defaults to `[]`
 
 ## When Not To Use It
 

diff --git a/lib/rules/jsx-handler-names.js b/lib/rules/jsx-handler-names.js
@@ -5,6 +5,7 @@
 
 'use strict';
 
+const minimatch = require('minimatch');
 const docsUrl = require('../util/docsUrl');
 const getText = require('../util/eslint').getText;
 const report = require('../util/report');
@@ -142,8 +143,8 @@ module.exports = {
       JSXAttribute(node) {
         const componentName = node.parent.name.name;
 
-        const isComponentNameIgnored = ignoreComponentNames.some((ignoredComponentNameRegex) => {
-          const isIgnored = new RegExp(ignoredComponentNameRegex).test(componentName);
+        const isComponentNameIgnored = ignoreComponentNames.some((ignoredComponentNamePattern) => {
+          const isIgnored = minimatch(componentName, ignoredComponentNamePattern);
           return isIgnored;
         });
 

diff --git a/tests/lib/rules/jsx-handler-names.js b/tests/lib/rules/jsx-handler-names.js
@@ -197,7 +197,7 @@ ruleTester.run('jsx-handler-names', rule, {
           )
         }
       `,
-      options: [{ checkLocalVariables: true, ignoreComponentNames: ['^MyLib'] }],
+      options: [{ checkLocalVariables: true, ignoreComponentNames: ['MyLib**'] }],
     },
   ]),
 
@@ -399,7 +399,7 @@ ruleTester.run('jsx-handler-names', rule, {
           )
         }
       `,
-      options: [{ checkLocalVariables: true, ignoreComponentNames: ['^MyLibrary'] }],
+      options: [{ checkLocalVariables: true, ignoreComponentNames: ['MyLibrary**'] }],
       errors: [
         {
           messageId: 'badPropKey',