chore: use glob patterns instead of regex

Author: akulsr0

docs/rules/forbid-component-props.md

@@ -44,7 +44,7 @@ Examples of **correct** code for this rule:
 ### `forbid`
 
 An array specifying the names of props that are forbidden. The default value of this option is `['className', 'style']`.
-Each array element can either be a string with the property name or object specifying the property name or regex, an optional
+Each array element can either be a string with the property name or object specifying the property name or glob string, an optional
 custom message, and a component allowlist:
 
 ```js
@@ -55,11 +55,11 @@ custom message, and a component allowlist:
 }
 ```
 
-For regex:
+For glob string patterns:
 
 ```js
 {
-  "propNameRegex": '.-.',
+  "propNamePattern": '**-**',
   "allowedFor": ['div'],
   "message": "Avoid using kebab-case except div"
 }
@@ -75,11 +75,11 @@ Use `disallowedFor` as an exclusion list to warn on props for specific component
 }
 ```
 
-For regex:
+For glob string patterns:
 
 ```js
 {
-  "propNameRegex": ".-.",
+  "propNamePattern": "**-**",
   "disallowedFor": ["MyComponent"],
   "message": "Avoid using kebab-case for MyComponent"
 }

lib/rules/forbid-component-props.js

@@ -5,6 +5,7 @@
 
 'use strict';
 
+const minimatch = require('minimatch');
 const docsUrl = require('../util/docsUrl');
 const report = require('../util/report');
 
@@ -74,7 +75,7 @@ module.exports = {
               {
                 type: 'object',
                 properties: {
-                  propNameRegex: { type: 'string' },
+                  propNamePattern: { type: 'string' },
                   allowedFor: {
                     type: 'array',
                     uniqueItems: true,
@@ -87,7 +88,7 @@ module.exports = {
               {
                 type: 'object',
                 properties: {
-                  propNameRegex: { type: 'string' },
+                  propNamePattern: { type: 'string' },
                   disallowedFor: {
                     type: 'array',
                     uniqueItems: true,
@@ -110,26 +111,26 @@ module.exports = {
     const configuration = context.options[0] || {};
     const forbid = new Map((configuration.forbid || DEFAULTS).map((value) => {
       const propName = typeof value === 'string' ? value : value.propName;
-      const propRegex = value.propNameRegex;
-      const prop = propName || propRegex;
+      const propPattern = value.propNamePattern;
+      const prop = propName || propPattern;
       const options = {
         allowList: typeof value === 'string' ? [] : (value.allowedFor || []),
         disallowList: typeof value === 'string' ? [] : (value.disallowedFor || []),
         message: typeof value === 'string' ? null : value.message,
-        isRegex: !!value.propNameRegex,
+        isPattern: !!value.propNamePattern,
       };
       return [prop, options];
     }));
 
     function getPropOptions(prop) {
-      // Get config options having regex
-      const propNameRegexArray = [...forbid.entries()].filter((propRegexEntry) => propRegexEntry[1].isRegex);
-      // Match current prop with regex options, return if matched
-      const propNameRegex = propNameRegexArray.find(([propRegex]) => new RegExp(propRegex).test(prop));
-      // Get options for matched propNameRegex
-      const propNameRegexOptions = propNameRegex && propNameRegex[1];
-
-      const options = forbid.get(prop) || propNameRegexOptions;
+      // Get config options having pattern
+      const propNamePatternArray = Array.from(forbid.entries()).filter((propEntry) => propEntry[1].isPattern);
+      // Match current prop with pattern options, return if matched
+      const propNamePattern = propNamePatternArray.find(([propPattern]) => minimatch(prop, propPattern));
+      // Get options for matched propNamePattern
+      const propNamePatternOptions = propNamePattern && propNamePattern[1];
+
+      const options = forbid.get(prop) || propNamePatternOptions;
       return options;
     }
 

tests/lib/rules/forbid-component-props.js

@@ -258,7 +258,7 @@ ruleTester.run('forbid-component-props', rule, {
         {
           forbid: [
             {
-              propNameRegex: '.-.',
+              propNamePattern: '**-**',
               allowedFor: ['div'],
             },
           ],
@@ -595,7 +595,7 @@ ruleTester.run('forbid-component-props', rule, {
         {
           forbid: [
             {
-              propNameRegex: '.-.',
+              propNamePattern: '**-**',
             },
           ],
         },
@@ -620,7 +620,7 @@ ruleTester.run('forbid-component-props', rule, {
         {
           forbid: [
             {
-              propNameRegex: '.-.',
+              propNamePattern: '**-**',
               message: 'Avoid using kebab-case',
             },
           ],
@@ -648,7 +648,7 @@ ruleTester.run('forbid-component-props', rule, {
         {
           forbid: [
             {
-              propNameRegex: '.-.',
+              propNamePattern: '**-**',
               allowedFor: ['div'],
             },
           ],
@@ -678,7 +678,7 @@ ruleTester.run('forbid-component-props', rule, {
         {
           forbid: [
             {
-              propNameRegex: '.-.',
+              propNamePattern: '**-**',
               disallowedFor: ['Foo'],
             },
           ],