feat: add error message for duplicate flags in no-invalid-regexp (#…

…18837) * feat: add error message to duplicate flags * update error message
eslint · Sep 3, 2024 · 183b459 · 183b459
1 parent f6fdef9
commit 183b459
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 14 deletions.
diff --git a/lib/rules/no-invalid-regexp.js b/lib/rules/no-invalid-regexp.js
@@ -126,15 +126,16 @@ module.exports = {
          * Check syntax error in a given flags.
          * @param {string|null} flags The RegExp flags to validate.
          * @param {string|null} flagsToCheck The RegExp invalid flags.
+         * @param {string} allFlags all valid and allowed flags.
          * @returns {string|null} The syntax error.
          */
-        function validateRegExpFlags(flags, flagsToCheck) {
-            const flagsToReport = [];
+        function validateRegExpFlags(flags, flagsToCheck, allFlags) {
+            const duplicateFlags = [];
 
-            if (typeof flags === "string") {
-                for (const flag of flags) {
-                    if (flagsToCheck.includes(flag)) {
-                        flagsToReport.push(flag);
+            if (typeof flagsToCheck === "string") {
+                for (const flag of flagsToCheck) {
+                    if (allFlags.includes(flag)) {
+                        duplicateFlags.push(flag);
                     }
                 }
             }
@@ -148,11 +149,15 @@ module.exports = {
                 return "Regex 'u' and 'v' flags cannot be used together";
             }
 
+            if (duplicateFlags.length > 0) {
+                return `Duplicate flags ('${duplicateFlags.join("")}') supplied to RegExp constructor`;
+            }
+
             if (!flagsToCheck) {
                 return null;
             }
 
-            return `Invalid flags supplied to RegExp constructor '${flagsToReport.join("")}'`;
+            return `Invalid flags supplied to RegExp constructor '${flagsToCheck}'`;
         }
 
         return {
@@ -171,7 +176,7 @@ module.exports = {
                     });
                 }
 
-                let message = validateRegExpFlags(flags, flagsToCheck);
+                let message = validateRegExpFlags(flags, flagsToCheck, allFlags);
 
                 if (message) {
                     report(node, message);

diff --git a/tests/lib/rules/no-invalid-regexp.js b/tests/lib/rules/no-invalid-regexp.js
@@ -218,7 +218,7 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["a"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'aa'" },
+                data: { message: "Duplicate flags ('a') supplied to RegExp constructor" },
                 type: "NewExpression"
             }]
         },
@@ -227,7 +227,7 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["a", "a"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'aa'" },
+                data: { message: "Duplicate flags ('a') supplied to RegExp constructor" },
                 type: "NewExpression"
             }]
         },
@@ -245,7 +245,7 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["a", "z"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'aa'" },
+                data: { message: "Duplicate flags ('a') supplied to RegExp constructor" },
                 type: "NewExpression"
             }]
         },
@@ -254,7 +254,7 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["a", "z"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'zz'" },
+                data: { message: "Duplicate flags ('z') supplied to RegExp constructor" },
                 type: "NewExpression"
             }]
         },
@@ -263,7 +263,7 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["a"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'aa'" },
+                data: { message: "Duplicate flags ('a') supplied to RegExp constructor" },
                 type: "NewExpression"
             }]
         },
@@ -272,7 +272,16 @@ ruleTester.run("no-invalid-regexp", rule, {
             options: [{ allowConstructorFlags: ["u"] }],
             errors: [{
                 messageId: "regexMessage",
-                data: { message: "Invalid flags supplied to RegExp constructor 'uu'" },
+                data: { message: "Duplicate flags ('u') supplied to RegExp constructor" },
+                type: "NewExpression"
+            }]
+        },
+        {
+            code: "new RegExp('.', 'ouo');",
+            options: [{ allowConstructorFlags: ["u"] }],
+            errors: [{
+                messageId: "regexMessage",
+                data: { message: "Invalid flags supplied to RegExp constructor 'oo'" },
                 type: "NewExpression"
             }]
         },