feat!: add support for eslint 8 and drop support for older versions

fix #278
eslint-functional · Oct 17, 2021 · 6a02f5f · 6a02f5f
1 parent 92500fc
commit 6a02f5f
Show file tree

Hide file tree

Showing 22 changed files with 312 additions and 378 deletions.
diff --git a/package.json b/package.json
@@ -62,15 +62,15 @@
     "verify": "yarn build && yarn lint && yarn build-tests && yarn test-compiled && rimraf build"
   },
   "dependencies": {
-    "@typescript-eslint/experimental-utils": "^4.31.1",
+    "@typescript-eslint/experimental-utils": "^5.0.0",
     "deepmerge-ts": "^1.0.1",
     "escape-string-regexp": "^4.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^13.1.0",
     "@commitlint/config-conventional": "^13.1.0",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
-    "@rebeccastevens/eslint-config": "^1.1.3",
+    "@rebeccastevens/eslint-config": "^1.1.4",
     "@rollup/plugin-commonjs": "^20.0.0",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.4",
@@ -82,37 +82,37 @@
     "@semantic-release/npm": "^8.0.0",
     "@semantic-release/release-notes-generator": "^10.0.2",
     "@types/dedent": "^0.7.0",
-    "@types/eslint": "^7.2.6",
+    "@types/eslint": "^7.28.1",
     "@types/estree": "^0.0.50",
     "@types/node": "16.10.2",
     "@types/rollup-plugin-auto-external": "^2.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.28.4",
-    "@typescript-eslint/parser": "^4.28.4",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "ava": "^3.15.0",
-    "babel-eslint": "^10.0.2",
+    "babel-eslint": "^10.1.0",
     "chalk": "^4.1.2",
     "codecov": "^3.8.1",
     "commitizen": "^4.2.4",
     "conventional-commit-types": "^3.0.0",
     "cross-env": "^7.0.3",
     "cspell": "^5.7.0",
     "dedent": "^0.7.0",
-    "eslint": "^7.31.0",
+    "eslint": "^8.0.1",
     "eslint-ava-rule-tester": "^4.0.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-import-resolver-typescript": "^2.4.0",
     "eslint-plugin-ava": "^13.0.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-eslint-plugin": "^3.4.0",
-    "eslint-plugin-import": "^2.23.4",
-    "eslint-plugin-jsdoc": "^36.1.0",
+    "eslint-plugin-eslint-plugin": "^3.6.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-jsdoc": "^36.1.1",
     "eslint-plugin-markdown": "^2.2.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-optimize-regex": "^1.2.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-sonarjs": "^0.10.0",
-    "eslint-plugin-unicorn": "^36.0.0",
+    "eslint-plugin-unicorn": "^37.0.1",
     "espree": "^9.0.0",
     "husky": "^7.0.2",
     "json-schema": "^0.3.0",
@@ -134,7 +134,7 @@
     "word-wrap": "^1.2.3"
   },
   "peerDependencies": {
-    "eslint": "^5.0.0 || ^6.0.0 || ^7.0.0",
+    "eslint": "^8.0.0",
     "tsutils": "^3.0.0",
     "typescript": "^3.4.1 || ^4.0.0"
   },
@@ -147,6 +147,6 @@
     }
   },
   "engines": {
-    "node": ">=12.4.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   }
 }
diff --git a/src/common/ignore-options.ts b/src/common/ignore-options.ts
@@ -8,7 +8,7 @@ import {
   hasID,
   hasKey,
   isAssignmentExpression,
-  isClassProperty,
+  isPropertyDefinition,
   isExpressionStatement,
   isIdentifier,
   isMemberExpression,
@@ -271,7 +271,7 @@ export function shouldIgnoreClass(
   return (
     (options.ignoreClass === true && inClass(node)) ||
     (options.ignoreClass === "fieldsOnly" &&
-      (isClassProperty(node) ||
+      (isPropertyDefinition(node) ||
         (isAssignmentExpression(node) &&
           inClass(node) &&
           isMemberExpression(node.left) &&

diff --git a/src/rules/functional-parameters.ts b/src/rules/functional-parameters.ts
@@ -96,7 +96,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Enforce functional parameters.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/immutable-data.ts b/src/rules/immutable-data.ts
@@ -104,7 +104,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Enforce treating data as immutable.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-class.ts b/src/rules/no-class.ts
@@ -26,7 +26,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow classes.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-conditional-statement.ts b/src/rules/no-conditional-statement.ts
@@ -68,7 +68,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow conditional statements.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-expression-statement.ts b/src/rules/no-expression-statement.ts
@@ -48,7 +48,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow expression statements.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-let.ts b/src/rules/no-let.ts
@@ -41,7 +41,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow mutable variables.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-loop-statement.ts b/src/rules/no-loop-statement.ts
@@ -26,7 +26,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow imperative loops.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-method-signature.ts b/src/rules/no-method-signature.ts
@@ -44,7 +44,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   docs: {
     description:
       "Prefer property signatures with readonly modifiers over method signatures.",
-    category: "Best Practices",
     recommended: "warn",
   },
   messages: errorMessages,

diff --git a/src/rules/no-mixed-type.ts b/src/rules/no-mixed-type.ts
@@ -48,7 +48,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   docs: {
     description:
       "Restrict types so that only members of the same kind of are allowed in them.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-promise-reject.ts b/src/rules/no-promise-reject.ts
@@ -27,7 +27,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow try-catch[-finally] and try-finally patterns.",
-    category: "Best Practices",
     recommended: false,
   },
   messages: errorMessages,

diff --git a/src/rules/no-return-void.ts b/src/rules/no-return-void.ts
@@ -59,7 +59,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow functions that don't return anything.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-this-expression.ts b/src/rules/no-this-expression.ts
@@ -26,7 +26,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow this access.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-throw-statement.ts b/src/rules/no-throw-statement.ts
@@ -26,7 +26,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow throwing exceptions.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/no-try-statement.ts b/src/rules/no-try-statement.ts
@@ -46,7 +46,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Disallow try-catch[-finally] and try-finally patterns.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,

diff --git a/src/rules/prefer-readonly-type.ts b/src/rules/prefer-readonly-type.ts
@@ -96,7 +96,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Prefer readonly array over mutable arrays.",
-    category: "Best Practices",
     recommended: "error",
   },
   messages: errorMessages,
@@ -259,7 +258,7 @@ function checkTypeReference(
  */
 function checkProperty(
   node:
-    | TSESTree.ClassProperty
+    | TSESTree.PropertyDefinition
     | TSESTree.TSIndexSignature
     | TSESTree.TSParameterProperty
     | TSESTree.TSPropertySignature,
@@ -380,7 +379,7 @@ export const rule = createRule<keyof typeof errorMessages, Options>(
   defaultOptions,
   {
     ArrowFunctionExpression: checkImplicitType,
-    ClassProperty: checkProperty,
+    PropertyDefinition: checkProperty,
     FunctionDeclaration: checkImplicitType,
     FunctionExpression: checkImplicitType,
     TSArrayType: checkArrayOrTupleType,

diff --git a/src/rules/prefer-tacit.ts b/src/rules/prefer-tacit.ts
@@ -74,7 +74,6 @@ const meta: RuleMetaData<keyof typeof errorMessages> = {
   type: "suggestion",
   docs: {
     description: "Replaces `x => f(x)` with just `f`.",
-    category: "Best Practices",
     recommended: false,
   },
   messages: errorMessages,

diff --git a/src/util/typeguard.ts b/src/util/typeguard.ts
@@ -86,10 +86,10 @@ export function isCallExpression(
   return node.type === AST_NODE_TYPES.CallExpression;
 }
 
-export function isClassProperty(
+export function isPropertyDefinition(
   node: TSESTree.Node
-): node is TSESTree.ClassProperty {
-  return node.type === AST_NODE_TYPES.ClassProperty;
+): node is TSESTree.PropertyDefinition {
+  return node.type === AST_NODE_TYPES.PropertyDefinition;
 }
 
 /**

diff --git a/tests/helpers/util.ts b/tests/helpers/util.ts
@@ -65,7 +65,6 @@ export function createDummyRule(
     type: "suggestion",
     docs: {
       description: "Disallow mutable variables.",
-      category: "Best Practices",
       recommended: "error",
       url: "",
     },