feat(:sparkles:): add regexSnippets option

Author: mrseanryan

README.md

@@ -68,6 +68,30 @@ You need to set your `tsconfig.json` file in your eslint configuration via `pars
 }
 ```
 
+### Regex example
+
+```json
+{
+  "plugins": ["ts-ban-snippets"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "ts-ban-snippets/ts-ban-snippets": [
+      "error",
+      {
+        "banned": [
+          {
+            "regexSnippets": ["return void [reject|resolve]"],
+            "message": "Please do not return void - instead place the return statement on the following line."
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
 ### Example with multiple banned snippets
 
 ```json

docs/ts-ban-snippets.md

@@ -27,6 +27,30 @@
 }
 ```
 
+### Regex example
+
+```json
+{
+  "plugins": ["ts-ban-snippets"],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "ts-ban-snippets/ts-ban-snippets": [
+      "error",
+      {
+        "banned": [
+          {
+            "regexSnippets": ["return void [reject|resolve]"],
+            "message": "Please do not return void - instead place the return statement on the following line."
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
 ### Example with multiple banned snippets
 
 ```json

src/rules/ts-ban-snippets.ts

@@ -6,7 +6,8 @@ import {
 } from "@typescript-eslint/experimental-utils/dist/ts-eslint";
 
 type Banned = {
-  snippets: string[];
+  snippets?: string[];
+  regexSnippets?: string[];
   message: string;
   // TODO includePaths?: string
   excludePaths?: string[];
@@ -33,6 +34,24 @@ function isFileInPaths(filePath: string, paths: string[]): boolean {
   return paths.some((path) => filePath.indexOf(path) >= 0);
 }
 
+const isRegexMatch = (regexRaw: string, text: string): boolean => {
+  const regex = new RegExp(regexRaw);
+  return regex.test(text);
+};
+
+const filterSnippets = (
+  bannedSnippetsRaw: string[],
+  isRegex: boolean,
+  text: string
+): string[] => {
+  const filterFun = (s: string): boolean => {
+    if (isRegex) return isRegexMatch(s, text);
+    return text.startsWith(s);
+  };
+
+  return bannedSnippetsRaw.filter(filterFun);
+};
+
 const analyzeNodeFor = (
   node: Node,
   banned: Banned,
@@ -51,7 +70,16 @@ const analyzeNodeFor = (
   node.getEnd();
   node.getSourceFile().getLineAndCharacterOfPosition(node.pos);
 
-  const bannedSnippets = banned.snippets.filter((s) => text.startsWith(s));
+  if (!!banned.snippets && !!banned.regexSnippets) {
+    throw new Error(
+      "Invalid config: 'snippets' and 'regexSnippets' are mutually exclusive."
+    );
+  }
+
+  const bannedSnippetsRaw = banned.snippets || banned.regexSnippets || [];
+  const isRegex = !!banned.regexSnippets;
+
+  const bannedSnippets = filterSnippets(bannedSnippetsRaw, isRegex, text);
 
   if (bannedSnippets.length > 0) {
     const pos = node.getSourceFile().getLineAndCharacterOfPosition(node.pos);
@@ -95,6 +123,12 @@ export default createRule<Options, MessageIds>({
                     type: "string",
                   },
                 },
+                regexSnippets: {
+                  type: "array",
+                  items: {
+                    type: "string",
+                  },
+                },
                 message: {
                   type: "string",
                 },

tests/regexSnippets/fixtures/file.tsx

@@ -0,0 +1,9 @@
+class MyClassForRegex {
+  doSomethingResolved() {
+    return new Promise((resolve) => {
+      return void resolve("error!");
+    });
+  }
+}
+
+new MyClassForRegex();

tests/regexSnippets/fixtures/invalid/test1.ts

@@ -0,0 +1,3 @@
+{
+  "extends": "../../tsconfig.base.eslint.json",
+}

tests/regexSnippets/fixtures/tsconfig.eslint.json

@@ -0,0 +1 @@
+export { default } from "./test1";

tests/regexSnippets/fixtures/valid/comp/index.ts

@@ -0,0 +1,3 @@
+const foo = 1;
+
+export default foo;

tests/regexSnippets/fixtures/valid/comp/test1.ts

@@ -0,0 +1,3 @@
+import foo from "./comp";
+
+console.log({ foo });

tests/regexSnippets/fixtures/valid/test.ts

@@ -0,0 +1,50 @@
+import rule from "../../src/rules/ts-ban-snippets";
+import { creteRuleTester, getCode } from "../testUtils";
+
+creteRuleTester(__dirname).run("ts-ban-snippets - regex", rule, {
+  valid: [
+    {
+      code: getCode("fixtures/valid/test.ts", __dirname),
+      filename: "valid/test.ts",
+      options: [
+        {
+          banned: [
+            {
+              regexSnippets: ["return void [reject|resolve]"],
+              message:
+                "Please do not return void - instead place the return statement on the following line.",
+            },
+          ],
+        },
+      ],
+    },
+  ],
+  invalid: [
+    {
+      code: getCode("fixtures/invalid/test1.ts", __dirname),
+      filename: "invalid/test1.ts",
+      options: [
+        {
+          banned: [
+            {
+              regexSnippets: ["^return void [reject|resolve]"],
+              message:
+                "Please do not return void - instead place the return statement on the following line.",
+            },
+          ],
+        },
+      ],
+      errors: [
+        {
+          messageId: "BannedSnippetMessage",
+          data: {
+            name: "^return void [reject|resolve]",
+            message:
+              "Please do not return void - instead place the return statement on the following line.",
+            ruleName: "ts-ban-snippets",
+          },
+        },
+      ],
+    },
+  ],
+});