fix(typescript-estree): handle BigInt with _ numeric separator (#…

…2067)
typescript-eslint · May 22, 2020 · 66f1627 · 66f1627
1 parent 765ec4b
commit 66f1627
Show file tree

Hide file tree

Showing 6 changed files with 158 additions and 1 deletion.
diff --git a/packages/parser/tests/lib/__snapshots__/javascript.ts.snap b/packages/parser/tests/lib/__snapshots__/javascript.ts.snap
@@ -6815,6 +6815,56 @@ Object {
 }
 `;
 
+exports[`javascript fixtures/bigIntLiterals/numeric-separator.src 1`] = `
+Object {
+  "$id": 1,
+  "block": Object {
+    "range": Array [
+      0,
+      8,
+    ],
+    "type": "Program",
+  },
+  "childScopes": Array [
+    Object {
+      "$id": 0,
+      "block": Object {
+        "range": Array [
+          0,
+          8,
+        ],
+        "type": "Program",
+      },
+      "childScopes": Array [],
+      "functionExpressionScope": false,
+      "isStrict": true,
+      "references": Array [],
+      "throughReferences": Array [],
+      "type": "module",
+      "upperScope": Object {
+        "$ref": 1,
+      },
+      "variableMap": Object {},
+      "variableScope": Object {
+        "$ref": 0,
+      },
+      "variables": Array [],
+    },
+  ],
+  "functionExpressionScope": false,
+  "isStrict": false,
+  "references": Array [],
+  "throughReferences": Array [],
+  "type": "global",
+  "upperScope": null,
+  "variableMap": Object {},
+  "variableScope": Object {
+    "$ref": 1,
+  },
+  "variables": Array [],
+}
+`;
+
 exports[`javascript fixtures/bigIntLiterals/octal.src 1`] = `
 Object {
   "$id": 1,

diff --git a/packages/shared-fixtures/fixtures/javascript/bigIntLiterals/numeric-separator.src.js b/packages/shared-fixtures/fixtures/javascript/bigIntLiterals/numeric-separator.src.js
@@ -0,0 +1 @@
+1_2_3n;
diff --git a/packages/typescript-estree/src/convert.ts b/packages/typescript-estree/src/convert.ts
@@ -1931,7 +1931,12 @@ export class Converter {
       case SyntaxKind.BigIntLiteral: {
         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 bigint = rawValue
+          // remove suffix `n`
+          .slice(0, -1)
+          // `BigInt` doesn't accept numeric separator
+          // and `bigint` property should not include numeric separator
+          .replace(/_/g, '');
         const value = typeof BigInt !== 'undefined' ? BigInt(bigint) : null;
         return this.createNode<TSESTree.BigIntLiteral>(node, {
           type: AST_NODE_TYPES.Literal,

diff --git a/packages/typescript-estree/tests/ast-alignment/parse.ts b/packages/typescript-estree/tests/ast-alignment/parse.ts
@@ -29,6 +29,7 @@ function parseWithBabelParser(text: string, jsx = true): any {
     'dynamicImport',
     'estree',
     'bigInt',
+    'numericSeparator',
     'importMeta',
     'optionalChaining',
     'nullishCoalescingOperator',

diff --git a/packages/typescript-estree/tests/lib/__snapshots__/javascript.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/javascript.ts.snap
@@ -16780,6 +16780,104 @@ Object {
 }
 `;
 
+exports[`javascript fixtures/bigIntLiterals/numeric-separator.src 1`] = `
+Object {
+  "body": Array [
+    Object {
+      "expression": Object {
+        "bigint": "123",
+        "loc": Object {
+          "end": Object {
+            "column": 6,
+            "line": 1,
+          },
+          "start": Object {
+            "column": 0,
+            "line": 1,
+          },
+        },
+        "range": Array [
+          0,
+          6,
+        ],
+        "raw": "1_2_3n",
+        "type": "Literal",
+        "value": 123n,
+      },
+      "loc": Object {
+        "end": Object {
+          "column": 7,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 0,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        0,
+        7,
+      ],
+      "type": "ExpressionStatement",
+    },
+  ],
+  "loc": Object {
+    "end": Object {
+      "column": 0,
+      "line": 2,
+    },
+    "start": Object {
+      "column": 0,
+      "line": 1,
+    },
+  },
+  "range": Array [
+    0,
+    8,
+  ],
+  "sourceType": "script",
+  "tokens": Array [
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 6,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 0,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        0,
+        6,
+      ],
+      "type": "Identifier",
+      "value": "1_2_3n",
+    },
+    Object {
+      "loc": Object {
+        "end": Object {
+          "column": 7,
+          "line": 1,
+        },
+        "start": Object {
+          "column": 6,
+          "line": 1,
+        },
+      },
+      "range": Array [
+        6,
+        7,
+      ],
+      "type": "Punctuator",
+      "value": ";",
+    },
+  ],
+  "type": "Program",
+}
+`;
+
 exports[`javascript fixtures/bigIntLiterals/octal.src 1`] = `
 Object {
   "body": Array [

diff --git a/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.ts.snap b/packages/typescript-estree/tests/lib/__snapshots__/semantic-diagnostics-enabled.ts.snap
@@ -224,6 +224,8 @@ exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" e
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/javascript/bigIntLiterals/hex.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
+exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/javascript/bigIntLiterals/numeric-separator.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
+
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/javascript/bigIntLiterals/octal.src 1`] = `"TEST OUTPUT: No semantic or syntactic issues found"`;
 
 exports[`Parse all fixtures with "errorOnTypeScriptSyntacticAndSemanticIssues" enabled fixtures/javascript/binaryLiterals/invalid.src 1`] = `