feat: add regexp flags support for id-naming-convention #180 (#181)

yeonjuan · Mar 10, 2024 · 11106a9 · 11106a9
1 parent 6290397
commit 11106a9
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/docs/rules/id-naming-convention.md b/docs/rules/id-naming-convention.md
@@ -22,7 +22,7 @@ This rule supports 4 naming cases. `camelCase`, `snake_case`, `PascalCase`, `keb
 - `"camelCase"`: Enforce camelCase format.
 - `"PascalCase"`: Enforce PascalCase format.
 - `"kebab-case"`: Enforce kebab-case format.
-- `"regex", { "pattern": "^my-regex$" }`: Enforce a format defined by a custom regex.
+- `"regex", { "pattern": "^my-regex$", "flags": "i" }`: Enforce a format defined by a custom regex (`flags` option is optional).
 
 #### "snake_case" (default)
 

diff --git a/packages/eslint-plugin/lib/rules/id-naming-convention.js b/packages/eslint-plugin/lib/rules/id-naming-convention.js
@@ -55,6 +55,7 @@ module.exports = {
         type: "object",
         properties: {
           pattern: { type: "string" },
+          flags: { type: "string" },
         },
         additionalProperties: false,
       },
@@ -74,7 +75,10 @@ module.exports = {
     const checkNaming =
       convention === CONVENTIONS.REGEX
         ? (/** @type string */ name) =>
-            new RegExp(context.options[1].pattern).test(name)
+            new RegExp(
+              context.options[1].pattern,
+              context.options[1].flags || ""
+            ).test(name)
         : CONVENTION_CHECKERS[convention];
 
     return {

diff --git a/packages/eslint-plugin/tests/rules/id-naming-convention.test.js b/packages/eslint-plugin/tests/rules/id-naming-convention.test.js
@@ -25,6 +25,10 @@ ruleTester.run("id-naming-convention", rule, {
       code: `<div id="CuStOmReGeX"> </div>`,
       options: ["regex", { pattern: "^([A-Z][a-z])+[A-Z]?$" }],
     },
+    {
+      code: `<div id="CuStOmReGeX"> </div>`,
+      options: ["regex", { pattern: "^[a-z]+$", flags: "i" }],
+    },
   ],
   invalid: [
     {
@@ -54,5 +58,14 @@ ruleTester.run("id-naming-convention", rule, {
         },
       ],
     },
+    {
+      code: `<div id="kebab-case"> </div>`,
+      options: ["regex", { pattern: "^([A-Z][a-z])+[A-Z]?$", flags: "i" }],
+      errors: [
+        {
+          message: "The id 'kebab-case' is not matched with the regex.",
+        },
+      ],
+    },
   ],
 });