feat: Add allows option to prefer-quantifier rule (#835)

* feat: Add `allows` property to `prefer-quantifier` rule

* docs: Document `allows` option of `prefer-quantifier` rule

* chore: Add changeset

Author: MorevM

.changeset/chilled-doors-wave.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-regexp": minor
+---
+
+Add `allows` option to `prefer-quantifier` rule

docs/rules/prefer-quantifier.md

@@ -33,7 +33,33 @@ var foo = /\d\d\d\d-\d\d-\d\d/;
 
 ## :wrench: Options
 
-Nothing.
+```json
+{
+  "regexp/prefer-quantifier": ["error", {
+    "allows": ["www", "\\d\\d"]
+  }]
+}
+```
+
+- `"allows"` ... Array of allowed patterns.
+
+### `{ "allows": ["www", "\\d\\d"] }`
+
+<eslint-code-block fix>
+
+```js
+/* eslint regexp/prefer-quantifier: ["error", { "allows": ["www", "\\d\\d"] }] */
+
+/* ✓ GOOD */
+var foo = /(?:www\.)?(.*)/;
+var foo = /\d\d:\d\d/;
+
+/* ✗ BAD */
+var foo = /wwww/;
+var foo = /\d\d\d\d/;
+```
+
+</eslint-code-block>
 
 ## :rocket: Version
 

lib/rules/prefer-quantifier.ts

@@ -1,5 +1,6 @@
 import type { Character, CharacterSet } from "@eslint-community/regexpp/ast"
 import type { RegExpVisitor } from "@eslint-community/regexpp/visitor"
+import type { ObjectOption } from "../types"
 import type { RegExpContext } from "../utils"
 import {
     createRule,
@@ -22,9 +23,12 @@ class CharBuffer {
 
     public equalChar: (element: CharTarget) => boolean
 
-    public constructor(target: CharTarget) {
+    private readonly allows: string[]
+
+    public constructor(target: CharTarget, allows: string[]) {
         this.target = target
         this.elements = [target]
+        this.allows = allows
 
         this.times = 1
 
@@ -57,10 +61,18 @@ class CharBuffer {
         this.times += 1
     }
 
+    private get bufferRawContents() {
+        return this.elements.reduce((acc, element) => acc + element.raw, "")
+    }
+
     public isValid(): boolean {
         if (this.elements.length < 2) {
             return true
         }
+        if (this.allows.includes(this.bufferRawContents)) {
+            return true
+        }
+
         let charKind: "digit" | "letter" | "symbol" | null = null
         for (const element of this.elements) {
             if (element.type === "Character") {
@@ -105,14 +117,30 @@ export default createRule("prefer-quantifier", {
             recommended: false,
         },
         fixable: "code",
-        schema: [],
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    allows: {
+                        type: "array",
+                        items: {
+                            type: "string",
+                        },
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
         messages: {
             unexpected:
                 "Unexpected consecutive same {{type}}. Use '{{quantifier}}' instead.",
         },
         type: "suggestion", // "problem",
     },
     create(context) {
+        const allows: string[] =
+            (context.options[0] as ObjectOption)?.allows ?? []
+
         function createVisitor({
             node,
             patternSource,
@@ -129,7 +157,7 @@ export default createRule("prefer-quantifier", {
                                 charBuffer.addElement(element)
                             } else {
                                 validateBuffer(charBuffer)
-                                charBuffer = new CharBuffer(element)
+                                charBuffer = new CharBuffer(element, allows)
                             }
                         } else {
                             validateBuffer(charBuffer)

tests/lib/rules/__snapshots__/prefer-quantifier.ts.eslintsnap

@@ -162,3 +162,35 @@ Output: unchanged
 
 [1] Unexpected consecutive same character class escapes. Use '{2}' instead.
 ---
+
+
+Test: prefer-quantifier >> invalid
+Options:
+  - allows:
+      - www
+
+Code:
+  1 | /wwww/
+    |  ^~~~ [1]
+
+Output:
+  1 | /w{4}/
+
+[1] Unexpected consecutive same characters. Use '{4}' instead.
+---
+
+
+Test: prefer-quantifier >> invalid
+Options:
+  - allows:
+      - \d\d
+
+Code:
+  1 | /\d\d-\d\d\d\d/
+    |       ^~~~~~~~ [1]
+
+Output:
+  1 | /\d\d-\d{4}/
+
+[1] Unexpected consecutive same character class escapes. Use '{4}' instead.
+---

tests/lib/rules/prefer-quantifier.ts

@@ -19,6 +19,14 @@ tester.run("prefer-quantifier", rule as any, {
         `/---/`,
         `/a.{1,3}?.{2,4}c/`,
         `/a.{1,3}.{2,4}?c/`,
+        {
+            code: `/www/`,
+            options: [{ allows: ["www"] }],
+        },
+        {
+            code: `/\\d\\d/`,
+            options: [{ allows: [`\\d\\d`] }],
+        },
     ],
     invalid: [
         `/\\d\\d/`,
@@ -39,5 +47,13 @@ tester.run("prefer-quantifier", rule as any, {
             const s = "\\\\d"+"\\\\d"
             new RegExp(s)
             `,
+        {
+            code: `/wwww/`,
+            options: [{ allows: ["www"] }],
+        },
+        {
+            code: String.raw`/\d\d-\d\d\d\d/`,
+            options: [{ allows: [`\\d\\d`] }],
+        },
     ],
 })