Add regexp/prefer-regexp-exec and regexp/prefer-regexp-test rules (#32)

* Add `regexp/prefer-regexp-exec` rule

* downgrade ts-node on node8 test

* update

* update

* update

* Use cache

* Supports JSDoc

* Update and add testcases

* Add testcases

* Supports Map and Set

* Update

* Update

* update

* fix and update

* Update

* update

* Update

* Support iterator

* update

* Add testcases

* update

* update

* Add prefer-regexp-test rule

* Update demo

Author: ota-meshi

.eslintrc.js

@@ -22,6 +22,7 @@ module.exports = {
         "no-warning-comments": "warn",
         "no-lonely-if": "off",
         "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-duplicate-imports": "error",
     },
     overrides: [
         {

.github/workflows/NodeCI.yml

@@ -44,7 +44,7 @@ jobs:
                   node-version: 8.10.x
             - name: Install Target Packages
               run: |+
-                  npm i -D [email protected] mocha@7
+                  npm i -D [email protected] mocha@7 @typescript-eslint/parser@3
                   npx rimraf node_modules
                   npm install
             - name: Test

.nycrc.json

@@ -0,0 +1,9 @@
+{
+    "all": true,
+    "include": [
+      "lib/**/*.ts"
+    ],
+    "exclude": [
+      "tests/**/*.ts"
+    ]
+  }

README.md

@@ -96,6 +96,8 @@ The rules with the following star :star: are included in the `plugin:regexp/reco
 | [regexp/prefer-plus-quantifier](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-plus-quantifier.html) | enforce using `+` quantifier | :star::wrench: |
 | [regexp/prefer-quantifier](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-quantifier.html) | enforce using quantifier | :wrench: |
 | [regexp/prefer-question-quantifier](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-question-quantifier.html) | enforce using `?` quantifier | :star::wrench: |
+| [regexp/prefer-regexp-exec](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-regexp-exec.html) | enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided |  |
+| [regexp/prefer-regexp-test](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-regexp-test.html) | enforce that `RegExp#test` is used instead of `String#match` and `RegExp#exec` | :wrench: |
 | [regexp/prefer-star-quantifier](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-star-quantifier.html) | enforce using `*` quantifier | :star::wrench: |
 | [regexp/prefer-t](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-t.html) | enforce using `\t` | :star::wrench: |
 | [regexp/prefer-w](https://ota-meshi.github.io/eslint-plugin-regexp/rules/prefer-w.html) | enforce using `\w` | :star::wrench: |

docs/.vuepress/components/demo/demo-code.js

@@ -1 +1,3 @@
 /eslint[-plugin-regexp]/u
+
+const re = /[a-zA-Z_0-9][A-Z_\da-z]*\e{1,}/

docs/.vuepress/components/rules/index.js

@@ -45,7 +45,7 @@ for (const k of Object.keys(plugin.rules)) {
         category: rule.meta.docs.category,
         ruleId: rule.meta.docs.ruleId,
         url: rule.meta.docs.url,
-        initChecked: CATEGORY_INDEX[rule.meta.docs.category] <= 3,
+        initChecked: true, // CATEGORY_INDEX[rule.meta.docs.category] <= 3,
     })
 }
 for (const k of Object.keys(coreRules)) {

docs/rules/README.md

@@ -28,6 +28,8 @@ The rules with the following star :star: are included in the `plugin:regexp/reco
 | [regexp/prefer-plus-quantifier](./prefer-plus-quantifier.md) | enforce using `+` quantifier | :star::wrench: |
 | [regexp/prefer-quantifier](./prefer-quantifier.md) | enforce using quantifier | :wrench: |
 | [regexp/prefer-question-quantifier](./prefer-question-quantifier.md) | enforce using `?` quantifier | :star::wrench: |
+| [regexp/prefer-regexp-exec](./prefer-regexp-exec.md) | enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided |  |
+| [regexp/prefer-regexp-test](./prefer-regexp-test.md) | enforce that `RegExp#test` is used instead of `String#match` and `RegExp#exec` | :wrench: |
 | [regexp/prefer-star-quantifier](./prefer-star-quantifier.md) | enforce using `*` quantifier | :star::wrench: |
 | [regexp/prefer-t](./prefer-t.md) | enforce using `\t` | :star::wrench: |
 | [regexp/prefer-w](./prefer-w.md) | enforce using `\w` | :star::wrench: |

docs/rules/prefer-regexp-exec.md

@@ -0,0 +1,66 @@
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "regexp/prefer-regexp-exec"
+description: "enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided"
+---
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "regexp/prefer-regexp-exec"
+description: "enforce that `RegExp# regexp/prefer-regexp-exec
+
+> enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided
+
+- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+
+# regexp/prefer-regexp-exec
+
+> enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided
+
+- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+
+`RegExp#exec` is faster than `String#match` and both work the same when not using the `/g` flag.
+
+## :book: Rule Details
+
+This rule is aimed at enforcing the more performant way of applying regular expressions on strings.
+
+This rule inspired by [@typescript-eslint/prefer-regexp-exec rule](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-regexp-exec.md).
+
+<eslint-code-block>
+
+```js
+/* eslint regexp/prefer-regexp-exec: "error" */
+
+/* ✓ GOOD */
+/thing/.exec('something');
+
+'some things are just things'.match(/thing/g);
+
+const text = 'something';
+const search = /thing/;
+search.exec(text);
+
+/* ✗ BAD */
+'something'.match(/thing/);
+
+'some things are just things'.match(/thing/);
+
+text.match(search);
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+Nothing.
+
+## :books: Further reading
+
+- [@typescript-eslint/prefer-regexp-exec](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-regexp-exec.md)
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/rules/prefer-regexp-exec.ts)
+- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/prefer-regexp-exec.ts)

docs/rules/prefer-regexp-test.md

@@ -0,0 +1,49 @@
+---
+pageClass: "rule-details"
+sidebarDepth: 0
+title: "regexp/prefer-regexp-test"
+description: "enforce that `RegExp#test` is used instead of `String#match` and `RegExp#exec`"
+---
+# regexp/prefer-regexp-test
+
+> enforce that `RegExp#test` is used instead of `String#match` and `RegExp#exec`
+
+- :exclamation: <badge text="This rule has not been released yet." vertical="middle" type="error"> ***This rule has not been released yet.*** </badge>
+- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+
+## :book: Rule Details
+
+This rule is aimed to use `RegExp#test` to check if a pattern matches a string.
+
+This rule inspired by [unicorn/prefer-regexp-test rule](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-regexp-test.md).
+
+<eslint-code-block fix>
+
+```js
+/* eslint regexp/prefer-regexp-test: "error" */
+
+const text = 'something';
+const pattern = /thing/;
+
+/* ✓ GOOD */
+if (pattern.test(text)) {}
+
+/* ✗ BAD */
+if (pattern.exec(text)) {}
+if (text.match(pattern)) {}
+```
+
+</eslint-code-block>
+
+## :wrench: Options
+
+Nothing.
+
+## :books: Further reading
+
+- [unicorn/prefer-regexp-test](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prefer-regexp-test.md)
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/rules/prefer-regexp-test.ts)
+- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/prefer-regexp-test.ts)

lib/rules/prefer-regexp-exec.ts

@@ -0,0 +1,56 @@
+import type { CallExpression } from "estree"
+import { createRule } from "../utils"
+import { createTypeTracker } from "../utils/type-tracker"
+import { getStaticValue } from "eslint-utils"
+
+// Inspired by https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-regexp-exec.md
+export default createRule("prefer-regexp-exec", {
+    meta: {
+        docs: {
+            description:
+                "enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided",
+            recommended: false,
+        },
+        schema: [],
+        messages: {
+            disallow: "Use the `RegExp#exec()` method instead.",
+        },
+        type: "suggestion", // "problem",
+    },
+    create(context) {
+        const typeTracer = createTypeTracker(context)
+
+        return {
+            CallExpression(node: CallExpression) {
+                if (node.arguments.length !== 1) {
+                    return
+                }
+                if (
+                    node.callee.type !== "MemberExpression" ||
+                    node.callee.computed ||
+                    node.callee.property.type !== "Identifier" ||
+                    node.callee.property.name !== "match" ||
+                    node.callee.object.type === "Super"
+                ) {
+                    return
+                }
+                const arg = node.arguments[0]
+                const evaluated = getStaticValue(arg, context.getScope())
+                if (
+                    evaluated &&
+                    evaluated.value instanceof RegExp &&
+                    evaluated.value.flags.includes("g")
+                ) {
+                    return
+                }
+                if (!typeTracer.isString(node.callee.object)) {
+                    return
+                }
+                context.report({
+                    node,
+                    messageId: "disallow",
+                })
+            },
+        }
+    },
+})