feat: fix all rules and imports

darraghoriordan · darraghoriordan · commit 8bf98000fac3 · 2021-10-26T10:43:31.000+11:00
Fixes the imports to match eslint 8
Fixes some rules in latest plugins
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -29,7 +29,6 @@ module.exports = {
                 },
             },
         ],
-        "unicorn/filename-case": ["off", {cases: ["camelCase"]}],
         "no-eval": "error",
         "@typescript-eslint/restrict-template-expressions": "off",
         "unicorn/no-fn-reference-in-iterator": "off",
diff --git a/.gitignore b/.gitignore
@@ -71,4 +71,5 @@ _ts3.4
 
 # Files copied as part of the build
 packages/types/src/ast-spec.ts
-.jest_cache
+.jest_cache
+false
diff --git a/README.md b/README.md
@@ -1,7 +1,15 @@
-# Some eslint rules for working with NestJs projects
-
 ## Why use this package?
 
+If you use NestJs (https://nestjs.com/) then these rules will help keep you usage of decorators consistent.
+
+## A note on versions
+
+Version 2.x supports Eslint version <=7.x and typescript eslint parser 4
+
+Version 3.x supports Eslint version >=8.x and typescript eslint parser 5+
+
+There were many breaking changes between these versions.
+
 ### 1. Detect Nest Dependency Injection issues
 
 There are some things you don't want to forget when working with Nest dependency injection.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -50,7 +50,7 @@
         "@commitlint/config-conventional": "12.1.1",
         "@semantic-release/changelog": "5.0.1",
         "@semantic-release/exec": "5.0.0",
-        "@types/eslint": "^7.2.12",
+        "@types/eslint": "7.28.2",
         "@types/jest": "26.0.23",
         "@types/node": "^15.6.1",
         "@typescript-eslint/eslint-plugin": "5.1.0",
diff --git a/src/eslintExtraTypes.d.ts b/src/eslintExtraTypes.d.ts
@@ -1,4 +1,4 @@
-declare module "eslint/lib/cli-engine/file-enumerator" {
+declare module "eslint/use-at-your-own-risk" {
     export class FileEnumerator {
         constructor(options: {
             cwd?: string;
diff --git a/src/rules/apiEnumPropertyBestPractices/apiEnumPropertyBestPractices.test.ts b/src/rules/apiEnumPropertyBestPractices/apiEnumPropertyBestPractices.test.ts
@@ -1,10 +1,10 @@
 import {hasEnumSpecifiedCorrectly} from "./apiEnumPropertyBestPractices";
-import {testCases} from "./apiEnumPropertyBestPractices.test-data";
+import {testCases} from "./apiEnumPropertyBestPractices.testData";
 import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {TSESTree} from "@typescript-eslint/types";
 
 // should probably be split up into multiple tests
@@ -23,6 +23,7 @@ describe("apiEnumPropertyBestPractices", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/rules/apiEnumPropertyBestPractices/apiEnumPropertyBestPractices.testData.ts b/src/rules/apiEnumPropertyBestPractices/apiEnumPropertyBestPractices.testData.ts
@@ -1,3 +1,4 @@
+/* eslint-disable unicorn/filename-case */
 export const testCases = [
     {
         moduleCode: `enum MyEnum{
diff --git a/src/rules/apiMethodsShouldSpecifyApiResponse/apiMethodsShouldSpecifyApiResponse.test.ts b/src/rules/apiMethodsShouldSpecifyApiResponse/apiMethodsShouldSpecifyApiResponse.test.ts
@@ -2,9 +2,9 @@ import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {TSESTree} from "@typescript-eslint/types";
-import {testCases} from "./apiMethodsShouldSpecifyApiResponse.test-data";
+import {testCases} from "./apiMethodsShouldSpecifyApiResponse.testData";
 import {shouldUseApiResponseDecorator} from "./apiMethodsShouldSpecifyApiResponse";
 
 // should probably be split up into multiple tests
@@ -19,6 +19,7 @@ describe("apiMethodsShouldSpecifyApiResponse", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/rules/apiMethodsShouldSpecifyApiResponse/apiMethodsShouldSpecifyApiResponse.testData.ts b/src/rules/apiMethodsShouldSpecifyApiResponse/apiMethodsShouldSpecifyApiResponse.testData.ts
diff --git a/src/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.test.ts b/src/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.test.ts
@@ -2,12 +2,12 @@ import {
     shouldUseOptionalDecorator,
     shouldUseRequiredDecorator,
 } from "./apiPropertyMatchesPropertyOptionality";
-import {testCases} from "./apiPropertyMatchesPropertyOptionality.test-data";
+import {testCases} from "./apiPropertyMatchesPropertyOptionality.testData";
 import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {TSESTree} from "@typescript-eslint/types";
 
 // should probably be split up into multiple tests
@@ -23,6 +23,7 @@ describe("apiPropertyMatchesPropertyOptionality", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.testData.ts b/src/rules/apiPropertyMatchesPropertyOptionality/apiPropertyMatchesPropertyOptionality.testData.ts
diff --git a/src/rules/apiPropertyReturningArrayShouldSetArray/apiPropertyReturningArrayShouldSetArray.test.ts b/src/rules/apiPropertyReturningArrayShouldSetArray/apiPropertyReturningArrayShouldSetArray.test.ts
@@ -1,10 +1,10 @@
 import {shouldSetArrayProperty} from "./apiPropertyReturningArrayShouldSetArray";
-import {testCases} from "./apiPropertyReturningArrayShouldSetArray.test-data";
+import {testCases} from "./apiPropertyReturningArrayShouldSetArray.testData";
 import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {TSESTree} from "@typescript-eslint/types";
 
 // should probably be split up into multiple tests
@@ -20,6 +20,7 @@ describe("apiPropertyReturningArrayShouldSetArray", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/rules/apiPropertyReturningArrayShouldSetArray/apiPropertyReturningArrayShouldSetArray.testData.ts b/src/rules/apiPropertyReturningArrayShouldSetArray/apiPropertyReturningArrayShouldSetArray.testData.ts
diff --git a/src/rules/controllerDecoratedHasApiTags/controllerDecoratedHasApiTags.test.ts b/src/rules/controllerDecoratedHasApiTags/controllerDecoratedHasApiTags.test.ts
@@ -2,9 +2,9 @@ import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {TSESTree} from "@typescript-eslint/types";
-import {testCases} from "./controllerDecoratedHasApiTags.test-data";
+import {testCases} from "./controllerDecoratedHasApiTags.testData";
 import {shouldUseApiTagDecorator} from "./controllerDecoratedHasApiTags";
 
 // should probably be split up into multiple tests
@@ -19,6 +19,7 @@ describe("controllerDecoratedHasApiTags", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/rules/controllerDecoratedHasApiTags/controllerDecoratedHasApiTags.testData.ts b/src/rules/controllerDecoratedHasApiTags/controllerDecoratedHasApiTags.testData.ts
diff --git a/src/rules/providerInjectedShouldMatchFactory/ProviderInjectedShouldMatchFactory.test.ts b/src/rules/providerInjectedShouldMatchFactory/ProviderInjectedShouldMatchFactory.test.ts
@@ -1,12 +1,13 @@
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 //import {TSESTree} from "@typescript-eslint/experimental-utils";
 import {
     fakeContext,
     fakeFilePath,
-} from "../../utils/nestModules/nestProvidedInjectableMapper.test-date";
+} from "../../utils/nestModules/nestProvidedInjectableMapper.testData";
 import {typedTokenHelpers} from "../../utils/typedTokenHelpers";
 import {hasMismatchedInjected} from "./ProviderInjectedShouldMatchFactory";
-import {testCases} from "./ProviderInjectedShouldMatchFactory.test-data";
+import {testCases} from "./ProviderInjectedShouldMatchFactory.testData";
 
 describe("ProviderInjectedShouldMatchFactory", () => {
     test.each(testCases)(
@@ -19,6 +20,7 @@ describe("ProviderInjectedShouldMatchFactory", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testCase.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
             const hasMismatch = hasMismatchedInjected(
diff --git a/src/rules/providerInjectedShouldMatchFactory/ProviderInjectedShouldMatchFactory.testData.ts b/src/rules/providerInjectedShouldMatchFactory/ProviderInjectedShouldMatchFactory.testData.ts
diff --git a/src/utils/files/fileEnumerationWrapper.ts b/src/utils/files/fileEnumerationWrapper.ts
@@ -2,7 +2,9 @@ import {
     EslintFile,
     FileEnumerator,
     FilePath,
-} from "eslint/lib/cli-engine/file-enumerator";
+    // eslint-disable-next-line import/no-unresolved
+} from "eslint/use-at-your-own-risk";
+import IsFilteredPath from "./isFilteredPath";
 
 // eslint-disable-next-line unicorn/no-static-only-class
 class FileEnumeratorWrapper {
@@ -23,19 +25,6 @@ class FileEnumeratorWrapper {
         );
     };
 
-    static isFilteredPath = (
-        path: string | undefined,
-        filteredStrings: string[] | undefined
-    ): boolean => {
-        if (!path) {
-            return false;
-        }
-        const hasFoundFilter = filteredStrings?.some((setting: string) => {
-            return new RegExp(`(${setting})`).test(path);
-        });
-        return hasFoundFilter || false;
-    };
-
     static mapEnumeratedFiles = (
         paths: Array<EslintFile>,
         filterFromPaths: string[]
@@ -54,10 +43,7 @@ class FileEnumeratorWrapper {
                 })
             )
             .filter((file) => {
-                return !FileEnumeratorWrapper.isFilteredPath(
-                    file.filename,
-                    filterFromPaths
-                );
+                return !IsFilteredPath.test(file.filename, filterFromPaths);
             });
     };
 }
diff --git a/src/utils/files/fileEnumeratorWrapper.test.ts b/src/utils/files/fileEnumeratorWrapper.test.ts
@@ -1,4 +1,4 @@
-import FileEnumeratorWrapper from "./fileEnumerationWrapper";
+import IsFilteredPath from "./isFilteredPath";
 
 describe("FileEnumerationWrapper", () => {
     test.each([
@@ -10,7 +10,7 @@ describe("FileEnumerationWrapper", () => {
     ])(
         "%s is filtered path",
         (testPath: string | undefined, expected: boolean) => {
-            const isFiltered = FileEnumeratorWrapper.isFilteredPath(testPath, [
+            const isFiltered = IsFilteredPath.test(testPath, [
                 "node_modules",
                 // prettier-ignore
                 // eslint-disable-next-line no-useless-escape
@@ -21,10 +21,7 @@ describe("FileEnumerationWrapper", () => {
     );
 
     it("handles undefined filters", () => {
-        const isFiltered = FileEnumeratorWrapper.isFilteredPath(
-            "path/path/blah.ts",
-            undefined
-        );
+        const isFiltered = IsFilteredPath.test("path/path/blah.ts", undefined);
         expect(isFiltered).toEqual(false);
     });
 });
diff --git a/src/utils/files/isFilteredPath.ts b/src/utils/files/isFilteredPath.ts
@@ -0,0 +1,17 @@
+// eslint-disable-next-line unicorn/no-static-only-class
+class IsFilteredPath {
+    static test = (
+        path: string | undefined,
+        filteredStrings: string[] | undefined
+    ): boolean => {
+        if (!path) {
+            return false;
+        }
+        const hasFoundFilter = filteredStrings?.some((setting: string) => {
+            return new RegExp(`(${setting})`).test(path);
+        });
+        return hasFoundFilter || false;
+    };
+}
+
+export default IsFilteredPath;
diff --git a/src/utils/nestModules/nestProvidedInjectableMapper.test.ts b/src/utils/nestModules/nestProvidedInjectableMapper.test.ts
@@ -7,13 +7,14 @@ import {
     fakeContext,
     fakeFilePath,
     moduleMappingTestData,
-} from "./nestProvidedInjectableMapper.test-date";
+} from "./nestProvidedInjectableMapper.testData";
 
 describe("nest module ast mapper", () => {
     it("Can parse typescript typings using the typescript parser", () => {
         const result = typedTokenHelpers.parseStringToAst(
             `let x:Date = new Date()`,
             fakeFilePath,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             {
                 parserOptions: {
                     ecmaVersion: 2019 as EcmaVersion,
@@ -46,6 +47,7 @@ describe("nest module ast mapper", () => {
             const ast = typedTokenHelpers.parseStringToAst(
                 testItem.moduleCode,
                 fakeFilePath,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
                 fakeContext
             );
 
diff --git a/src/utils/nestModules/nestProvidedInjectableMapper.testData.ts b/src/utils/nestModules/nestProvidedInjectableMapper.testData.ts
diff --git a/src/utils/nestModules/nestProvidedInjectableMapper.ts b/src/utils/nestModules/nestProvidedInjectableMapper.ts
@@ -2,7 +2,8 @@ import {TSESTree} from "@typescript-eslint/experimental-utils";
 import {RuleContext} from "@typescript-eslint/experimental-utils/dist/ts-eslint";
 
 import * as unambiguous from "eslint-module-utils/unambiguous";
-import {FilePath} from "eslint/lib/cli-engine/file-enumerator";
+// eslint-disable-next-line import/no-unresolved
+import {FilePath} from "eslint/use-at-your-own-risk";
 import fs from "fs";
 import {typedTokenHelpers} from "../typedTokenHelpers";
 // eslint-disable-next-line unicorn/import-style

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-declare module "eslint/lib/cli-engine/file-enumerator" {`
	`1`	`+declare module "eslint/use-at-your-own-risk" {`
`2`	`2`	`export class FileEnumerator {`
`3`	`3`	`constructor(options: {`
`4`	`4`	`cwd?: string;`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+/* eslint-disable unicorn/filename-case */`
`1`	`2`	`export const testCases = [`
`2`	`3`	`{`
`3`	`4`	moduleCode: `enum MyEnum{