Test both typescript-eslint-parser and @typescript-eslint/parser

augments #1304
import-js · Apr 1, 2019 · c3b5707 · c3b5707
1 parent a68ab3b
commit c3b5707
Show file tree

Hide file tree

Showing 5 changed files with 124 additions and 100 deletions.
diff --git a/README.md b/README.md
@@ -148,7 +148,7 @@ rules:
 
 You may use the following shortcut or assemble your own config using the granular settings described below.
 
-Make sure you have installed the [`@typescript-eslint/parser`] which is used in the following configuration. Unfortunately NPM does not allow to list optional peer dependencies. 
+Make sure you have installed [`@typescript-eslint/parser`] which is used in the following configuration. Unfortunately NPM does not allow to list optional peer dependencies.
 
 ```yaml
 extends:
@@ -344,14 +344,16 @@ directly using webpack, for example:
 # .eslintrc.yml
 settings:
   import/parsers:
-    typescript-eslint-parser: [ .ts, .tsx ]
+    @typescript-eslint/parser: [ .ts, .tsx ]
 ```
 
-In this case, [`typescript-eslint-parser`](https://github.com/eslint/typescript-eslint-parser) must be installed and require-able from
-the running `eslint` module's location (i.e., install it as a peer of ESLint).
+In this case, [`@typescript-eslint/parser`](https://www.npmjs.com/package/@typescript-eslint/parser)
+must be installed and require-able from the running `eslint` module's location
+(i.e., install it as a peer of ESLint).
 
-This is currently only tested with `typescript-eslint-parser` but should theoretically
-work with any moderately ESTree-compliant parser.
+This is currently only tested with `@typescript-eslint/parser` (and its predecessor,
+`typescript-eslint-parser`) but should theoretically work with any moderately
+ESTree-compliant parser.
 
 It's difficult to say how well various plugin features will be supported, too,
 depending on how far down the rabbit hole goes. Submit an issue if you find strange

diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
   },
   "homepage": "https://github.com/benmosher/eslint-plugin-import",
   "devDependencies": {
+    "@typescript-eslint/parser": "^1.5.0",
     "babel-eslint": "^8.2.6",
     "babel-plugin-istanbul": "^4.1.6",
     "babel-preset-es2015-argon": "latest",
@@ -69,7 +70,7 @@
     "rimraf": "^2.6.3",
     "sinon": "^2.4.1",
     "typescript": "^3.2.2",
-    "typescript-eslint-parser": "^21.0.2"
+    "typescript-eslint-parser": "^22.0.0"
   },
   "peerDependencies": {
     "eslint": "2.x - 5.x"

diff --git a/tests/src/core/getExports.js b/tests/src/core/getExports.js
@@ -315,6 +315,7 @@ describe('ExportMap', function () {
     const configs = [
       // ['string form', { 'typescript-eslint-parser': '.ts' }],
       ['array form', { 'typescript-eslint-parser': ['.ts', '.tsx'] }],
+      ['array form', { '@typescript-eslint/parser': ['.ts', '.tsx'] }],
     ]
 
     configs.forEach(([description, parserConfig]) => {

diff --git a/tests/src/rules/named.js b/tests/src/rules/named.js
@@ -254,99 +254,103 @@ ruleTester.run('named (export *)', rule, {
 })
 
 
-context("Typescript", function () {
+context('Typescript', function () {
   // Typescript
-  ruleTester.run("named", rule, {
-    valid: [
-      test({
-        code: 'import { MyType } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: 'import { Foo } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: 'import { Bar } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: 'import { getFoo } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: 'import { MyEnum } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: `
-          import { MyModule } from "./typescript"
-          MyModule.ModuleFunction()
-        `,
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-      test({
-        code: `
-          import { MyNamespace } from "./typescript"
-          MyNamespace.NSModule.NSModuleFunction()
-        `,
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-      }),
-    ],
-
-    invalid: [
-      test({
-        code: 'import { MissingType } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-        errors: [{
-          message: "MissingType not found in './typescript'",
-          type: 'Identifier',
-        }],
-      }),
-      test({
-        code: 'import { NotExported } from "./typescript"',
-        parser: 'typescript-eslint-parser',
-        settings: {
-          'import/parsers': { 'typescript-eslint-parser': ['.ts'] },
-          'import/resolver': { 'eslint-import-resolver-typescript': true },
-        },
-        errors: [{
-          message: "NotExported not found in './typescript'",
-          type: 'Identifier',
-        }],
-      }),
-    ]
+  const parsers = ['@typescript-eslint/parser', 'typescript-eslint-parser']
+
+  parsers.forEach((parser) => {
+    ruleTester.run('named', rule, {
+      valid: [
+        test({
+          code: 'import { MyType } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: 'import { Foo } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: 'import { Bar } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: 'import { getFoo } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: 'import { MyEnum } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: `
+            import { MyModule } from "./typescript"
+            MyModule.ModuleFunction()
+          `,
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+        test({
+          code: `
+            import { MyNamespace } from "./typescript"
+            MyNamespace.NSModule.NSModuleFunction()
+          `,
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+        }),
+      ],
+
+      invalid: [
+        test({
+          code: 'import { MissingType } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+          errors: [{
+            message: "MissingType not found in './typescript'",
+            type: 'Identifier',
+          }],
+        }),
+        test({
+          code: 'import { NotExported } from "./typescript"',
+          parser: parser,
+          settings: {
+            'import/parsers': { [parser]: ['.ts'] },
+            'import/resolver': { 'eslint-import-resolver-typescript': true },
+          },
+          errors: [{
+            message: "NotExported not found in './typescript'",
+            type: 'Identifier',
+          }],
+        }),
+      ],
+    })
   })
 })
diff --git a/tests/src/rules/order.js b/tests/src/rules/order.js
@@ -1276,5 +1276,21 @@ ruleTester.run('order', rule, {
         message: '`fs` import should occur before import of `async`',
       }],
     }),
+    // fix incorrect order with @typescript-eslint/parser
+    test({
+      code: `
+        var async = require('async');
+        var fs = require('fs');
+      `,
+      output: `
+        var fs = require('fs');
+        var async = require('async');
+      `,
+      parser: '@typescript-eslint/parser',
+      errors: [{
+        ruleId: 'order',
+        message: '`fs` import should occur before import of `async`',
+      }],
+    }),
   ],
 })