fix(typescript-estree): [ts 4.2] add support for import type equal de…

…claration (#3189)
typescript-eslint · Mar 18, 2021 · 6a25faf · 6a25faf
1 parent 56af989
commit 6a25faf
Show file tree

Hide file tree

Showing 12 changed files with 593 additions and 62 deletions.
diff --git a/packages/shared-fixtures/fixtures/typescript/basics/import-equal-type-declaration.src.ts b/packages/shared-fixtures/fixtures/typescript/basics/import-equal-type-declaration.src.ts
@@ -0,0 +1 @@
+import type foo = require('bar');
diff --git a/...es/shared-fixtures/fixtures/typescript/basics/import-export-equal-type-declaration.src.ts b/...es/shared-fixtures/fixtures/typescript/basics/import-export-equal-type-declaration.src.ts
@@ -0,0 +1 @@
+export import type foo = require('bar');
diff --git a/packages/types/src/ts-estree.ts b/packages/types/src/ts-estree.ts
@@ -1423,6 +1423,7 @@ export interface TSImportEqualsDeclaration extends BaseNode {
   type: AST_NODE_TYPES.TSImportEqualsDeclaration;
   id: Identifier;
   moduleReference: EntityName | TSExternalModuleReference;
+  importKind: 'type' | 'value';
   isExport: boolean;
 }
 

diff --git a/packages/typescript-estree/package.json b/packages/typescript-estree/package.json
@@ -51,7 +51,7 @@
   },
   "devDependencies": {
     "@babel/code-frame": "^7.12.13",
-    "@babel/parser": "^7.13.4",
+    "@babel/parser": "^7.13.11",
     "@babel/types": "^7.13.0",
     "@types/babel__code-frame": "*",
     "@types/debug": "*",

diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -2690,6 +2690,7 @@ export class Converter {
           type: AST_NODE_TYPES.TSImportEqualsDeclaration,
           id: this.convertChild(node.name),
           moduleReference: this.convertChild(node.moduleReference),
+          importKind: node.isTypeOnly ? 'type' : 'value',
           isExport: hasModifier(SyntaxKind.ExportKeyword, node),
         });
       }

diff --git a/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts b/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts
@@ -395,6 +395,8 @@ tester.addFixturePatternConfig('typescript/basics', {
     'export-assignment',
     'import-equal-declaration',
     'import-export-equal-declaration',
+    'import-equal-type-declaration',
+    'import-export-equal-type-declaration',
     // babel treats declare and types as not a module
     'export-declare-const-named-enum',
     'export-declare-named-enum',

diff --git a/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.test.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.test.ts.snap
@@ -1929,8 +1929,12 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-equal-declaration.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-equal-type-declaration.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-export-equal-declaration.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-export-equal-type-declaration.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-type-default.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/typescript/basics/import-type-empty.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;

diff --git a/.../typescript-estree/tests/snapshots/typescript/basics/import-equal-declaration.src.ts.shot b/.../typescript-estree/tests/snapshots/typescript/basics/import-equal-declaration.src.ts.shot
@@ -22,6 +22,7 @@ Object {
         ],
         "type": "Identifier",
       },
+      "importKind": "value",
       "isExport": false,
       "loc": Object {
         "end": Object {

diff --git a/...script-estree/tests/snapshots/typescript/basics/import-equal-type-declaration.src.ts.shot b/...script-estree/tests/snapshots/typescript/basics/import-equal-type-declaration.src.ts.shot
@@ -0,0 +1,262 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`typescript basics import-equal-type-declaration.src 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "id": Object {
+        "loc": Object {
+          "end": Object {
+            "column": 15,
+            "line": 1,
+          },
+          "start": Object {
+            "column": 12,
+            "line": 1,
+          },
+        },
+        "name": "foo",
+        "range": Array [
+          12,
+          15,
+        ],
+        "type": "Identifier",
+      },
+      "importKind": "type",
+      "isExport": false,
+      "loc": Object {
+        "end": Object {
+          "column": 33,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 0,
+          "line": 1,
+        },
+      },
+      "moduleReference": Object {
+        "expression": Object {
+          "loc": Object {
+            "end": Object {
+              "column": 31,
+              "line": 1,
+            },
+            "start": Object {
+              "column": 26,
+              "line": 1,
+            },
+          },
+          "range": Array [
+            26,
+            31,
+          ],
+          "raw": "'bar'",
+          "type": "Literal",
+          "value": "bar",
+        },
+        "loc": Object {
+          "end": Object {
+            "column": 32,
+            "line": 1,
+          },
+          "start": Object {
+            "column": 18,
+            "line": 1,
+          },
+        },
+        "range": Array [
+          18,
+          32,
+        ],
+        "type": "TSExternalModuleReference",
+      },
+      "range": Array [
+        0,
+        33,
+      ],
+      "type": "TSImportEqualsDeclaration",
+    },
+  ],
+  "comments": Array [],
+  "loc": Object {
+    "end": Object {
+      "column": 0,
+      "line": 2,
+    },
+    "start": Object {
+      "column": 0,
+      "line": 1,
+    },
+  },
+  "range": Array [
+    0,
+    34,
+  ],
+  "sourceType": "module",
+  "tokens": Array [
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 6,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 0,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        0,
+        6,
+      ],
+      "type": "Keyword",
+      "value": "import",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 11,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 7,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        7,
+        11,
+      ],
+      "type": "Identifier",
+      "value": "type",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 15,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 12,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        12,
+        15,
+      ],
+      "type": "Identifier",
+      "value": "foo",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 17,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 16,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        16,
+        17,
+      ],
+      "type": "Punctuator",
+      "value": "=",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 25,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 18,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        18,
+        25,
+      ],
+      "type": "Identifier",
+      "value": "require",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 26,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 25,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        25,
+        26,
+      ],
+      "type": "Punctuator",
+      "value": "(",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 31,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 26,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        26,
+        31,
+      ],
+      "type": "String",
+      "value": "'bar'",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 32,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 31,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        31,
+        32,
+      ],
+      "type": "Punctuator",
+      "value": ")",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 33,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 32,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        32,
+        33,
+      ],
+      "type": "Punctuator",
+      "value": ";",
+    },
+  ],
+  "type": "Program",
+}
+`;
diff --git a/...ript-estree/tests/snapshots/typescript/basics/import-export-equal-declaration.src.ts.shot b/...ript-estree/tests/snapshots/typescript/basics/import-export-equal-declaration.src.ts.shot
@@ -22,6 +22,7 @@ Object {
         ],
         "type": "Identifier",
       },
+      "importKind": "value",
       "isExport": true,
       "loc": Object {
         "end": Object {