feat(typescript-estree): align nodes with estree 2020 (#1389)

typescript-eslint · May 14, 2020 · b0b8fa0 · b0b8fa0
1 parent ac7f94f
commit b0b8fa0
Show file tree

Hide file tree

Showing 13 changed files with 95 additions and 94 deletions.
diff --git a/packages/eslint-plugin/src/rules/class-literal-property-style.ts b/packages/eslint-plugin/src/rules/class-literal-property-style.ts
@@ -23,10 +23,7 @@ const printNodeModifiers = (
 const isSupportedLiteral = (
   node: TSESTree.Node,
 ): node is TSESTree.LiteralExpression => {
-  if (
-    node.type === AST_NODE_TYPES.Literal ||
-    node.type === AST_NODE_TYPES.BigIntLiteral
-  ) {
+  if (node.type === AST_NODE_TYPES.Literal) {
     return true;
   }
 

diff --git a/packages/eslint-plugin/src/rules/no-inferrable-types.ts b/packages/eslint-plugin/src/rules/no-inferrable-types.ts
@@ -118,7 +118,8 @@ export default util.createRule<Options, MessageIds>({
 
           return (
             isFunctionCall(unwrappedInit, 'BigInt') ||
-            unwrappedInit.type === AST_NODE_TYPES.BigIntLiteral
+            (unwrappedInit.type === AST_NODE_TYPES.Literal &&
+              'bigint' in unwrappedInit)
           );
         }
 

diff --git a/packages/eslint-plugin/src/rules/prefer-optional-chain.ts b/packages/eslint-plugin/src/rules/prefer-optional-chain.ts
@@ -305,7 +305,6 @@ export default util.createRule<Options, MessageIds>({
             break;
 
           case AST_NODE_TYPES.Literal:
-          case AST_NODE_TYPES.BigIntLiteral:
           case AST_NODE_TYPES.TemplateLiteral:
             propertyText = sourceCode.getText(node.property);
             break;
@@ -352,7 +351,6 @@ const ALLOWED_MEMBER_OBJECT_TYPES: ReadonlySet<AST_NODE_TYPES> = new Set([
   AST_NODE_TYPES.ThisExpression,
 ]);
 const ALLOWED_COMPUTED_PROP_TYPES: ReadonlySet<AST_NODE_TYPES> = new Set([
-  AST_NODE_TYPES.BigIntLiteral,
   AST_NODE_TYPES.Identifier,
   AST_NODE_TYPES.Literal,
   AST_NODE_TYPES.MemberExpression,

diff --git a/packages/parser/tests/lib/__snapshots__/javascript.ts.snap b/packages/parser/tests/lib/__snapshots__/javascript.ts.snap
@@ -35993,6 +35993,8 @@ Object {
 }
 `;
 
+exports[`javascript fixtures/experimentalDynamicImport/error-dynamic-import-params.src 1`] = `"Dynamic import must have one specifier as an argument."`;
+
 exports[`javascript fixtures/experimentalObjectRestSpread/arg-spread.src 1`] = `
 Object {
   "$id": 6,

diff --git a/...fixtures/fixtures/javascript/experimentalDynamicImport/error-dynamic-import-params.src.js b/...fixtures/fixtures/javascript/experimentalDynamicImport/error-dynamic-import-params.src.js
@@ -0,0 +1 @@
+import('foo', '')
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -1811,6 +1811,20 @@ export class Converter {
       }
 
       case SyntaxKind.CallExpression: {
+        if (node.expression.kind === SyntaxKind.ImportKeyword) {
+          if (node.arguments.length !== 1) {
+            throw createError(
+              this.ast,
+              node.arguments.pos,
+              'Dynamic import must have one specifier as an argument.',
+            );
+          }
+          return this.createNode<TSESTree.ImportExpression>(node, {
+            type: AST_NODE_TYPES.ImportExpression,
+            source: this.convertChild(node.arguments[0]),
+          });
+        }
+
         const callee = this.convertChild(node.expression);
         const args = node.arguments.map(el => this.convertChild(el));
         let result;
@@ -1922,14 +1936,17 @@ export class Converter {
       }
 
       case SyntaxKind.BigIntLiteral: {
-        const result = this.createNode<TSESTree.BigIntLiteral>(node, {
-          type: AST_NODE_TYPES.BigIntLiteral,
-          raw: '',
-          value: '',
+        const range = getRange(node, this.ast);
+        const rawValue = this.ast.text.slice(range[0], range[1]);
+        const bigint = rawValue.slice(0, -1); // remove suffix `n`
+        const value = typeof BigInt !== 'undefined' ? BigInt(bigint) : null;
+        return this.createNode<TSESTree.BigIntLiteral>(node, {
+          type: AST_NODE_TYPES.Literal,
+          raw: rawValue,
+          value: value,
+          bigint: value === null ? bigint : String(value),
+          range,
         });
-        result.raw = this.ast.text.slice(result.range[0], result.range[1]);
-        result.value = result.raw.slice(0, -1); // remove suffix `n`
-        return result;
       }
 
       case SyntaxKind.RegularExpressionLiteral: {

diff --git a/packages/typescript-estree/src/ts-estree/ast-node-types.ts b/packages/typescript-estree/src/ts-estree/ast-node-types.ts
@@ -5,7 +5,6 @@ export enum AST_NODE_TYPES {
   AssignmentExpression = 'AssignmentExpression',
   AssignmentPattern = 'AssignmentPattern',
   AwaitExpression = 'AwaitExpression',
-  BigIntLiteral = 'BigIntLiteral',
   BinaryExpression = 'BinaryExpression',
   BlockStatement = 'BlockStatement',
   BreakStatement = 'BreakStatement',
@@ -36,6 +35,7 @@ export enum AST_NODE_TYPES {
   Import = 'Import',
   ImportDeclaration = 'ImportDeclaration',
   ImportDefaultSpecifier = 'ImportDefaultSpecifier',
+  ImportExpression = 'ImportExpression',
   ImportNamespaceSpecifier = 'ImportNamespaceSpecifier',
   ImportSpecifier = 'ImportSpecifier',
   JSXAttribute = 'JSXAttribute',

diff --git a/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts b/packages/typescript-estree/src/ts-estree/estree-to-ts-node-types.ts
@@ -16,7 +16,6 @@ export interface EstreeToTsNodeTypes {
     | ts.BinaryExpression
     | ts.ParameterDeclaration;
   [AST_NODE_TYPES.AwaitExpression]: ts.AwaitExpression;
-  [AST_NODE_TYPES.BigIntLiteral]: ts.BigIntLiteral;
   [AST_NODE_TYPES.BinaryExpression]: ts.BinaryExpression;
   [AST_NODE_TYPES.BlockStatement]: ts.Block;
   [AST_NODE_TYPES.BreakStatement]: ts.BreakStatement;
@@ -73,6 +72,7 @@ export interface EstreeToTsNodeTypes {
   [AST_NODE_TYPES.Import]: ts.ImportExpression;
   [AST_NODE_TYPES.ImportDeclaration]: ts.ImportDeclaration;
   [AST_NODE_TYPES.ImportDefaultSpecifier]: ts.ImportClause;
+  [AST_NODE_TYPES.ImportExpression]: ts.CallExpression;
   [AST_NODE_TYPES.ImportNamespaceSpecifier]: ts.NamespaceImport;
   [AST_NODE_TYPES.ImportSpecifier]: ts.ImportSpecifier;
   [AST_NODE_TYPES.JSXAttribute]: ts.JsxAttribute;
@@ -98,7 +98,8 @@ export interface EstreeToTsNodeTypes {
     | ts.RegularExpressionLiteral
     | ts.JsxText
     | ts.NullLiteral
-    | ts.BooleanLiteral;
+    | ts.BooleanLiteral
+    | ts.BigIntLiteral;
   [AST_NODE_TYPES.LogicalExpression]: ts.BinaryExpression;
   [AST_NODE_TYPES.MemberExpression]:
     | ts.PropertyAccessExpression

diff --git a/packages/typescript-estree/src/ts-estree/ts-estree.ts b/packages/typescript-estree/src/ts-estree/ts-estree.ts
@@ -175,6 +175,7 @@ export type Node =
   | Import
   | ImportDeclaration
   | ImportDefaultSpecifier
+  | ImportExpression
   | ImportNamespaceSpecifier
   | ImportSpecifier
   | JSXAttribute
@@ -395,12 +396,13 @@ export type LeftHandSideExpression =
   | TSAsExpression
   | ArrowFunctionExpression;
 export type Literal =
+  | BigIntLiteral
   | BooleanLiteral
   | NumberLiteral
   | NullLiteral
   | RegExpLiteral
   | StringLiteral;
-export type LiteralExpression = BigIntLiteral | Literal | TemplateLiteral;
+export type LiteralExpression = Literal | TemplateLiteral;
 export type MemberExpression =
   | MemberExpressionComputedName
   | MemberExpressionNonComputedName;
@@ -624,7 +626,7 @@ interface FunctionSignatureBase extends BaseNode {
 
 interface LiteralBase extends BaseNode {
   raw: string;
-  value: boolean | number | RegExp | string | null;
+  value: string | boolean | null | number | RegExp | bigint;
   regex?: {
     pattern: string;
     flags: string;
@@ -784,7 +786,9 @@ export interface AwaitExpression extends BaseNode {
 }
 
 export interface BigIntLiteral extends LiteralBase {
-  type: AST_NODE_TYPES.BigIntLiteral;
+  type: AST_NODE_TYPES.Literal;
+  value: bigint | null;
+  bigint: string;
 }
 
 export interface BinaryExpression extends BinaryExpressionBase {
@@ -968,6 +972,11 @@ export interface ImportDefaultSpecifier extends BaseNode {
   local: Identifier;
 }
 
+export interface ImportExpression extends BaseNode {
+  type: AST_NODE_TYPES.ImportExpression;
+  source: Expression;
+}
+
 export interface ImportNamespaceSpecifier extends BaseNode {
   type: AST_NODE_TYPES.ImportNamespaceSpecifier;
   local: Identifier;

diff --git a/packages/typescript-estree/src/visitor-keys.ts b/packages/typescript-estree/src/visitor-keys.ts
@@ -3,6 +3,8 @@ import * as eslintVisitorKeys from 'eslint-visitor-keys';
 export const visitorKeys = eslintVisitorKeys.unionWith({
   // Additional estree nodes.
   Import: [],
+  // ES2020
+  ImportExpression: ['source'],
   // Additional Properties.
   ArrayPattern: ['decorators', 'elements', 'typeAnnotation'],
   ArrowFunctionExpression: ['typeParameters', 'params', 'returnType', 'body'],
@@ -40,7 +42,6 @@ export const visitorKeys = eslintVisitorKeys.unionWith({
   JSXSpreadChild: ['expression'],
 
   // Additional Nodes.
-  BigIntLiteral: [],
   ClassProperty: ['decorators', 'key', 'typeAnnotation', 'value'],
   Decorator: ['expression'],
   OptionalCallExpression: ['callee', 'typeParameters', 'arguments'],

diff --git a/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts b/packages/typescript-estree/tests/ast-alignment/fixtures-to-test.ts
@@ -37,8 +37,8 @@ class FixturesTester {
    * Utility to generate a FixturePatternConfig object containing the glob pattern for specific subsections of the fixtures/ directory,
    * including the capability to ignore specific nested patterns.
    *
-   * @param {string} fixturesSubPath the sub-path within the fixtures/ directory
-   * @param {CreateFixturePatternConfig?} config an optional configuration object with optional sub-paths to ignore and/or parse with sourceType: module
+   * @param fixturesSubPath the sub-path within the fixtures/ directory
+   * @param config an optional configuration object with optional sub-paths to ignore and/or parse with sourceType: module
    */
   public addFixturePatternConfig(
     fixturesSubPath: string,
@@ -186,19 +186,7 @@ tester.addFixturePatternConfig('javascript/function', {
   ],
 });
 
-tester.addFixturePatternConfig('javascript/bigIntLiterals', {
-  ignore: [
-    /**
-     * new BigIntLiteral type
-     * @see https://github.com/estree/estree/blob/master/es2020.md#bigintliteral
-     * @see https://github.com/typescript-eslint/typescript-eslint/pull/1389
-     */
-    'binary',
-    'decimal',
-    'hex',
-    'octal',
-  ],
-});
+tester.addFixturePatternConfig('javascript/bigIntLiterals');
 tester.addFixturePatternConfig('javascript/binaryLiterals');
 tester.addFixturePatternConfig('javascript/blockBindings');
 
@@ -229,16 +217,7 @@ tester.addFixturePatternConfig('javascript/destructuring-and-forOf');
 tester.addFixturePatternConfig('javascript/destructuring-and-spread');
 
 tester.addFixturePatternConfig('javascript/experimentalAsyncIteration');
-tester.addFixturePatternConfig('javascript/experimentalDynamicImport', {
-  ignore: [
-    /**
-     * new ImportExpression type
-     * @see https://github.com/estree/estree/blob/master/es2020.md#importexpression
-     * @see https://github.com/typescript-eslint/typescript-eslint/pull/1389
-     */
-    'dynamic-import',
-  ],
-});
+tester.addFixturePatternConfig('javascript/experimentalDynamicImport');
 tester.addFixturePatternConfig('javascript/exponentiationOperators');
 tester.addFixturePatternConfig('javascript/experimentalOptionalCatchBinding');