Upgrade ESLint to 7.5.0 and typescript-eslint to 3.7.1 (#2038)

SonarSource · Jul 31, 2020 · dc7eb58 · dc7eb58
1 parent 17074e6
commit dc7eb58
Show file tree

Hide file tree

Showing 37 changed files with 1,005 additions and 1,253 deletions.
diff --git a/eslint-bridge/package.json b/eslint-bridge/package.json
@@ -24,13 +24,14 @@
     "node": ">=6"
   },
   "devDependencies": {
-    "@types/eslint": "4.16.3",
+    "@types/eslint": "7.2.0",
     "@types/eslint-scope": "3.7.0",
     "@types/esprima": "4.0.2",
-    "@types/estree": "0.0.39",
+    "@types/estree": "0.0.45",
     "@types/express": "4.16.0",
     "@types/jest": "23.3.2",
     "@types/node": "13.1.4",
+    "@types/semver": "7.3.1",
     "fs-extra": "7.0.0",
     "jest": "24.9.0",
     "jest-sonar-reporter": "1.3.0",
@@ -40,18 +41,19 @@
     "typescript": "3.9.5"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "2.23.0",
-    "@typescript-eslint/experimental-utils": "2.23.0",
-    "@typescript-eslint/parser": "2.23.0",
+    "@typescript-eslint/eslint-plugin": "3.7.1",
+    "@typescript-eslint/experimental-utils": "3.7.1",
+    "@typescript-eslint/parser": "3.7.1",
     "babel-eslint": "10.1.0",
     "body-parser": "1.18.3",
     "builtin-modules": "3.1.0",
-    "eslint": "5.16.0",
+    "eslint": "7.5.0",
     "eslint-plugin-chai-friendly": "0.5.0",
     "eslint-plugin-sonarjs": "0.5.0",
-    "espree": "5.0.1",
+    "espree": "7.2.0",
     "express": "4.16.3",
     "run-node": "1.0.0",
+    "semver": "7.3.2",
     "vue-eslint-parser": "6.0.4"
   },
   "bundledDependencies": [
@@ -64,9 +66,11 @@
     "eslint",
     "eslint-plugin-chai-friendly",
     "eslint-plugin-sonarjs",
+    "espree",
     "express",
-    "vue-eslint-parser",
-    "run-node"
+    "run-node",
+    "semver",
+    "vue-eslint-parser"
   ],
   "prettier": {
     "printWidth": 100,

diff --git a/eslint-bridge/src/parser.ts b/eslint-bridge/src/parser.ts
@@ -22,12 +22,14 @@ import * as babel from 'babel-eslint';
 import { Linter, SourceCode } from 'eslint';
 import { ParsingError } from './analyzer';
 import * as VueJS from 'vue-eslint-parser';
+import * as semver from 'semver';
 
 // this value is taken from typescript-estree
 // still we might consider extending this range
 // if everything which we need is working on older/newer versions
-const TYPESCRIPT_MINIMUM_VERSION = '3.2.1';
-const TYPESCRIPT_MAXIMUM_VERSION = '3.8.0';
+const TYPESCRIPT_MINIMUM_VERSION = '3.3.1';
+// next released version is 4.0.0, we need version which is above current 3.9.x and below 4.0.0
+const TYPESCRIPT_MAXIMUM_VERSION = '3.10.0';
 
 export const PARSER_CONFIG_MODULE: Linter.ParserOptions = {
   tokens: true,
@@ -122,13 +124,13 @@ export function resetReportedNewerTypeScriptVersion() {
 
 // exported for testing
 export function checkTypeScriptVersionCompatibility(currentVersion: string) {
-  if (currentVersion >= TYPESCRIPT_MAXIMUM_VERSION && !reportedNewerTypeScriptVersion) {
+  if (semver.gt(currentVersion, TYPESCRIPT_MAXIMUM_VERSION) && !reportedNewerTypeScriptVersion) {
     reportedNewerTypeScriptVersion = true;
     console.log(
       `WARN You are using version of TypeScript ${currentVersion} which is not officially supported; ` +
         `supported versions >=${TYPESCRIPT_MINIMUM_VERSION} <${TYPESCRIPT_MAXIMUM_VERSION}`,
     );
-  } else if (currentVersion < TYPESCRIPT_MINIMUM_VERSION) {
+  } else if (semver.lt(currentVersion, TYPESCRIPT_MINIMUM_VERSION)) {
     throw {
       message: `You are using version of TypeScript ${currentVersion} which is not supported; supported versions >=${TYPESCRIPT_MINIMUM_VERSION}`,
     };

diff --git a/eslint-bridge/src/rules/cyclomatic-complexity.ts b/eslint-bridge/src/rules/cyclomatic-complexity.ts
@@ -85,7 +85,7 @@ function raiseOnUnauthorizedComplexity(
   if (complexity > threshold) {
     context.report({
       message: toEncodedMessage(complexity, threshold, tokens),
-      loc: toPrimaryLocation(node, context),
+      loc: getMainFunctionTokenLocation(node, parent, context),
     });
   }
 }
@@ -103,16 +103,6 @@ function toEncodedMessage(
   return JSON.stringify(encodedMessage);
 }
 
-function toPrimaryLocation(node: estree.Node, context: Rule.RuleContext): IssueLocation {
-  const func = node as FunctionNodeType;
-  return {
-    line: func.loc!.start.line,
-    column: func.loc!.start.column,
-    endLine: context.getSourceCode().getTokenBefore(func.body)!.loc.end.line,
-    endColumn: context.getSourceCode().getTokenBefore(func.body)!.loc.end.column,
-  };
-}
-
 function toSecondaryLocation(token: ComplexityToken): IssueLocation {
   return {
     line: token.loc.start.line,

diff --git a/eslint-bridge/src/rules/no-duplicate-in-composite.ts b/eslint-bridge/src/rules/no-duplicate-in-composite.ts
@@ -36,15 +36,15 @@ export const rule: Rule.RuleModule = {
 
   create(context: Rule.RuleContext) {
     return {
-      'TSUnionType, TSIntersectionType': function (node: estree.Node) {
+      'TSUnionType, TSIntersectionType'(node: estree.Node) {
         const sourceCode = context.getSourceCode();
         const compositeType = (node as unknown) as
           | TSESTree.TSUnionType
           | TSESTree.TSIntersectionType;
         const groupedTypes: Map<string, Array<TSESTree.Node>> = new Map();
 
         compositeType.types.forEach(typescriptType => {
-          const nodeValue = sourceCode.getText(typescriptType as estree.Node);
+          const nodeValue = sourceCode.getText((typescriptType as unknown) as estree.Node);
           const nodesWithGivenType = groupedTypes.get(nodeValue);
           const nodeType = typescriptType as TSESTree.Node;
           if (!nodesWithGivenType) {

diff --git a/eslint-bridge/src/rules/no-globals-shadowing.ts b/eslint-bridge/src/rules/no-globals-shadowing.ts
@@ -90,7 +90,11 @@ function reportBadUsage(
         break;
       case 'ObjectPattern':
         node.properties.forEach(prop => {
-          reportBadUsage(prop.value, buildMessage, context);
+          if (prop.type === 'Property') {
+            reportBadUsage(prop.value, buildMessage, context);
+          } else {
+            reportBadUsage(prop.argument, buildMessage, context);
+          }
         });
         break;
       case 'ArrayPattern':

diff --git a/eslint-bridge/src/rules/no-unenclosed-multiline-block.ts b/eslint-bridge/src/rules/no-unenclosed-multiline-block.ts
@@ -46,6 +46,8 @@ export const rule: Rule.RuleModule = {
       Program: (node: estree.Node) => checkStatements((node as estree.Program).body, context),
       BlockStatement: (node: estree.Node) =>
         checkStatements((node as estree.BlockStatement).body, context),
+      TSModuleBlock: (node: estree.Node) =>
+        checkStatements(((node as unknown) as TSESTree.TSModuleBlock).body as Statement[], context),
     };
   },
 };

diff --git a/eslint-bridge/src/rules/no-useless-intersection.ts b/eslint-bridge/src/rules/no-useless-intersection.ts
@@ -50,7 +50,7 @@ export const rule: Rule.RuleModule = {
               if (isTypeWithoutMembers(tp, ts)) {
                 context.report({
                   message: 'Remove this type without members or change this type intersection.',
-                  node: typeNode as estree.Node,
+                  node: (typeNode as unknown) as estree.Node,
                 });
               }
             });

diff --git a/eslint-bridge/src/rules/os-command.ts b/eslint-bridge/src/rules/os-command.ts
@@ -91,7 +91,7 @@ function containsShellOption(otherArguments: Argument[]) {
   return otherArguments.some(
     arg =>
       arg.type === 'ObjectExpression' &&
-      arg.properties.some(
+      (arg.properties.filter(v => v.type === 'Property') as estree.Property[]).some(
         ({ key, value }) =>
           isIdentifier(key, 'shell') && value.type === 'Literal' && value.value === true,
       ),

diff --git a/eslint-bridge/src/rules/prefer-type-guard.ts b/eslint-bridge/src/rules/prefer-type-guard.ts
@@ -118,7 +118,7 @@ function getCastTupleFromMemberExpression(
   if (node.type === 'MemberExpression') {
     const object = node.object as TSESTree.Node;
     if (object.type === 'TSAsExpression' || object.type === 'TSTypeAssertion') {
-      return [object.expression as estree.Node, object.typeAnnotation as estree.Node];
+      return [object.expression as estree.Node, (object.typeAnnotation as unknown) as estree.Node];
     }
   }
   return undefined;

diff --git a/eslint-bridge/src/rules/shorthand-property-grouping.ts b/eslint-bridge/src/rules/shorthand-property-grouping.ts
@@ -45,7 +45,7 @@ export const rule: Rule.RuleModule = {
       const secondaryMessages = [];
 
       for (let i = begin; i < end; i++) {
-        const prop = properties[i];
+        const prop = properties[i] as estree.Property;
         if (prop.shorthand) {
           secondaryNodes.push(prop);
           secondaryMessages.push(`Move to ${positionMessage}`);
@@ -70,7 +70,9 @@ export const rule: Rule.RuleModule = {
         if (objectExpressionProperties.some(p => p.type !== 'Property')) {
           return;
         }
-        const isShorthandPropertyList = objectExpressionProperties.map(p => p.shorthand);
+        const isShorthandPropertyList = objectExpressionProperties.map(
+          p => (p as estree.Property).shorthand,
+        );
         const shorthandPropertiesNumber = isShorthandPropertyList.filter(b => b).length;
 
         const numberOfShorthandAtBeginning = getNumberOfTrueAtBeginning(isShorthandPropertyList);

diff --git a/eslint-bridge/src/rules/use-type-alias.ts b/eslint-bridge/src/rules/use-type-alias.ts
@@ -58,7 +58,9 @@ export const rule: Rule.RuleModule = {
           const composite = (node as unknown) as TSESTree.TSUnionType | TSESTree.TSIntersectionType;
           if (composite.types.length > TYPE_THRESHOLD) {
             const text = composite.types
-              .map(typeNode => context.getSourceCode().getText(typeNode as estree.Node))
+              .map(typeNode =>
+                context.getSourceCode().getText((typeNode as unknown) as estree.Node),
+              )
               .sort((a, b) => a.localeCompare(b))
               .join('|');
             let occurrences = usage.get(text);

diff --git a/eslint-bridge/src/utils/decorators.ts b/eslint-bridge/src/utils/decorators.ts
@@ -37,7 +37,8 @@ export function interceptReport(
   onReport: (context: Rule.RuleContext, reportDescriptor: Rule.ReportDescriptor) => void,
 ): Rule.RuleModule {
   return {
-    meta: rule.meta,
+    // meta should be defined only when it's defined on original rule, otherwise RuleTester will fail
+    ...(!!rule.meta && { meta: rule.meta }),
     create(originalContext: Rule.RuleContext) {
       const interceptingContext: Rule.RuleContext = {
         id: originalContext.id,

diff --git a/eslint-bridge/tests/RuleTesterTs.ts b/eslint-bridge/tests/RuleTesterTs.ts
@@ -35,18 +35,6 @@ const placeHolderFilePath = path.resolve(`${__dirname}/fixtures/rule-tester-proj
  * It will also assert that no issues is raised when there are no type information.
  */
 class RuleTesterTs extends RuleTester {
-  ruleTesterNoTsConfig = new RuleTester({
-    parser,
-    parserOptions: {
-      ecmaVersion: 2018,
-      sourceType: 'module',
-      ecmaFeatures: {
-        jsx: true,
-        globalReturn: true,
-      },
-    },
-  });
-
   constructor(public expectNoIssuesWithoutTypes = true) {
     super({
       parser,
@@ -62,23 +50,14 @@ class RuleTesterTs extends RuleTester {
       invalid?: RuleTester.InvalidTestCase[];
     },
   ): void {
-    if (this.expectNoIssuesWithoutTypes) {
-      this.ruleTesterNoTsConfig.run(`${name}[noTsConfig]`, rule, {
-        valid: tests.invalid,
-        invalid: [],
-      });
-    }
-
-    tests.valid.forEach(test => {
+    const setFilename = test => {
       if (!test.filename) {
         test.filename = placeHolderFilePath;
       }
-    });
-    tests.invalid.forEach(test => {
-      if (!test.filename) {
-        test.filename = placeHolderFilePath;
-      }
-    });
+    };
+
+    tests.valid.forEach(setFilename);
+    tests.invalid.forEach(setFilename);
 
     super.run(name, rule, tests);
   }

diff --git a/eslint-bridge/tests/parser.test.ts b/eslint-bridge/tests/parser.test.ts
@@ -187,19 +187,19 @@ describe('parseTypeScriptSourceFile', () => {
     expect(parsingException).toBeDefined;
     expect(parsingException).toEqual({
       message:
-        'You are using version of TypeScript 1.2.3 which is not supported; supported versions >=3.2.1',
+        'You are using version of TypeScript 1.2.3 which is not supported; supported versions >=3.3.1',
     });
   });
 
   it('should log a warning with TypeScript version above maximum expected', () => {
     console.log = jest.fn();
     resetReportedNewerTypeScriptVersion();
-    checkTypeScriptVersionCompatibility('3.8.5');
+    checkTypeScriptVersionCompatibility('5.0.0');
     expect(console.log).toHaveBeenCalledWith(
-      'WARN You are using version of TypeScript 3.8.5 which is not officially supported; supported versions >=3.2.1 <3.8.0',
+      'WARN You are using version of TypeScript 5.0.0 which is not officially supported; supported versions >=3.3.1 <3.10.0',
     );
     console.log = jest.fn();
-    checkTypeScriptVersionCompatibility('3.8.5');
+    checkTypeScriptVersionCompatibility('5.0.0');
     // should log only once
     expect(console.log).not.toHaveBeenCalled();
 

diff --git a/eslint-bridge/tests/rules/bool-param-default.test.ts b/eslint-bridge/tests/rules/bool-param-default.test.ts
@@ -83,7 +83,7 @@ ruleTester.run('Optional boolean parameters should have default value', rule, {
       errors: 1,
     },
     {
-      code: `let f = (b?: boolean) b;`,
+      code: `let f = (b?: boolean) => b;`,
       errors: 1,
     },
     {