feat(typescript-estree): added allowInvalidAST option to not throw on invalid tokens

docs/architecture/TypeScript-ESTree.mdx

@@ -48,6 +48,12 @@ interface ParseOptions {
    */
   debugLevel?: boolean | ('typescript-eslint' | 'eslint' | 'typescript')[];
 
+  /**
+   * Causes the parser to an error if it receives an invalid AST from TypeScript.
+   * This case only usually occurs when attempting to lint invalid code.
+   */
+  errorOnInvalidAST?: boolean;
+
   /**
    * Cause the parser to error if it encounters an unknown AST node type (useful for testing).
    * This case only usually occurs when TypeScript releases new features.
@@ -99,7 +105,6 @@ interface ParseOptions {
 
 const PARSE_DEFAULT_OPTIONS: ParseOptions = {
   comment: false,
-  errorOnUnknownASTType: false,
   filePath: 'estree.ts', // or 'estree.tsx', if you pass jsx: true
   jsx: false,
   loc: false,

packages/ast-spec/src/declaration/ClassDeclaration/fixtures/_error_/export-missing-name/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/ClassDeclaration/fixtures/_error_/export-missing-name/fixture.ts

@@ -0,0 +1 @@
+export class { }

packages/ast-spec/src/declaration/ClassDeclaration/fixtures/_error_/export-missing-name/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration ClassDeclaration _error_ export-missing-name TSESTree - Error 1`] = `[TSError: A class declaration without the 'default' modifier must have a name.]`;

packages/ast-spec/src/declaration/ClassDeclaration/fixtures/_error_/export-missing-name/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration ClassDeclaration _error_ export-missing-name Babel - Error 1`] = `[SyntaxError: A class name is required. (1:13)]`;

packages/ast-spec/src/declaration/ClassDeclaration/fixtures/_error_/export-missing-name/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration ClassDeclaration _error_ export-missing-name Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/declaration/ExportAllDeclaration/fixtures/_error_/non-string-source/snapshots/1-TSESTree-Error.shot

@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`AST Fixtures declaration ExportAllDeclaration _error_ non-string-source TSESTree - Error 1`] = `[TSError: Module specifier must be a string literal.]`;
+exports[`AST Fixtures declaration ExportAllDeclaration _error_ non-string-source TSESTree - Error 1`] = `"NO ERROR"`;

packages/ast-spec/src/declaration/ExportAllDeclaration/fixtures/_error_/non-string-source/snapshots/3-Alignment-Error.shot

@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`AST Fixtures declaration ExportAllDeclaration _error_ non-string-source Error Alignment 1`] = `"Both errored"`;
+exports[`AST Fixtures declaration ExportAllDeclaration _error_ non-string-source Error Alignment 1`] = `"Babel errored but TSESTree didn't"`;

packages/ast-spec/src/declaration/ImportDeclaration/fixtures/_error_/non-string-source/snapshots/1-TSESTree-Error.shot

@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`AST Fixtures declaration ImportDeclaration _error_ non-string-source TSESTree - Error 1`] = `[TSError: Module specifier must be a string literal.]`;
+exports[`AST Fixtures declaration ImportDeclaration _error_ non-string-source TSESTree - Error 1`] = `"NO ERROR"`;

packages/ast-spec/src/declaration/ImportDeclaration/fixtures/_error_/non-string-source/snapshots/3-Alignment-Error.shot

@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`AST Fixtures declaration ImportDeclaration _error_ non-string-source Error Alignment 1`] = `"Both errored"`;
+exports[`AST Fixtures declaration ImportDeclaration _error_ non-string-source Error Alignment 1`] = `"Babel errored but TSESTree didn't"`;

packages/ast-spec/src/declaration/TSEnumDeclaration/fixtures/_error_/decorator/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/TSEnumDeclaration/fixtures/_error_/decorator/fixture.ts

@@ -0,0 +1 @@
+@decl enum Test {}

packages/ast-spec/src/declaration/TSEnumDeclaration/fixtures/_error_/decorator/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSEnumDeclaration _error_ decorator TSESTree - Error 1`] = `[TSError: Decorators are not valid here.]`;

packages/ast-spec/src/declaration/TSEnumDeclaration/fixtures/_error_/decorator/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSEnumDeclaration _error_ decorator Babel - Error 1`] = `[SyntaxError: Leading decorators must be attached to a class declaration. (1:6)]`;

packages/ast-spec/src/declaration/TSEnumDeclaration/fixtures/_error_/decorator/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSEnumDeclaration _error_ decorator Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/declaration/TSInterfaceDeclaration/fixtures/_error_/decorator/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/TSInterfaceDeclaration/fixtures/_error_/decorator/fixture.ts

@@ -0,0 +1 @@
+@decl interface Test {};

packages/ast-spec/src/declaration/TSInterfaceDeclaration/fixtures/_error_/decorator/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSInterfaceDeclaration _error_ decorator TSESTree - Error 1`] = `[TSError: Decorators are not valid here.]`;

packages/ast-spec/src/declaration/TSInterfaceDeclaration/fixtures/_error_/decorator/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSInterfaceDeclaration _error_ decorator Babel - Error 1`] = `[SyntaxError: Leading decorators must be attached to a class declaration. (1:6)]`;

packages/ast-spec/src/declaration/TSInterfaceDeclaration/fixtures/_error_/decorator/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSInterfaceDeclaration _error_ decorator Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/declaration/TSTypeAliasDeclaration/fixtures/_error_/decorator/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/TSTypeAliasDeclaration/fixtures/_error_/decorator/fixture.ts

@@ -0,0 +1 @@
+@decl type Test = {};

packages/ast-spec/src/declaration/TSTypeAliasDeclaration/fixtures/_error_/decorator/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSTypeAliasDeclaration _error_ decorator TSESTree - Error 1`] = `[TSError: Decorators are not valid here.]`;

packages/ast-spec/src/declaration/TSTypeAliasDeclaration/fixtures/_error_/decorator/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSTypeAliasDeclaration _error_ decorator Babel - Error 1`] = `[SyntaxError: Leading decorators must be attached to a class declaration. (1:6)]`;

packages/ast-spec/src/declaration/TSTypeAliasDeclaration/fixtures/_error_/decorator/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration TSTypeAliasDeclaration _error_ decorator Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/decorator/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/decorator/fixture.ts

@@ -0,0 +1 @@
+@decl type Test = {};

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/decorator/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ decorator TSESTree - Error 1`] = `[TSError: Decorators are not valid here.]`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/decorator/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ decorator Babel - Error 1`] = `[SyntaxError: Leading decorators must be attached to a class declaration. (1:6)]`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/decorator/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ decorator Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/no-variables/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/no-variables/fixture.ts

@@ -0,0 +1 @@
+const;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/no-variables/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ no-variables TSESTree - Error 1`] = `[TSError: A variable declaration list must have at least one variable declarator.]`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/no-variables/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ no-variables Babel - Error 1`] = `[SyntaxError: Unexpected token (1:5)]`;

packages/ast-spec/src/declaration/VariableDeclaration/fixtures/_error_/no-variables/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures declaration VariableDeclaration _error_ no-variables Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/src/statement/ThrowStatement/fixtures/_error_/missing-argument/config.ts

@@ -0,0 +1,3 @@
+export default {
+  errorOnInvalidAST: true,
+};

packages/ast-spec/src/statement/ThrowStatement/fixtures/_error_/missing-argument/fixture.ts

@@ -0,0 +1,3 @@
+{
+    throw
+}

packages/ast-spec/src/statement/ThrowStatement/fixtures/_error_/missing-argument/snapshots/1-TSESTree-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures statement ThrowStatement _error_ missing-argument TSESTree - Error 1`] = `[TSError: A throw statement must throw an expression.]`;

packages/ast-spec/src/statement/ThrowStatement/fixtures/_error_/missing-argument/snapshots/2-Babel-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures statement ThrowStatement _error_ missing-argument Babel - Error 1`] = `[SyntaxError: Illegal newline after throw. (2:9)]`;

packages/ast-spec/src/statement/ThrowStatement/fixtures/_error_/missing-argument/snapshots/3-Alignment-Error.shot

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`AST Fixtures statement ThrowStatement _error_ missing-argument Error Alignment 1`] = `"Both errored"`;

packages/ast-spec/tests/fixtures-with-differences-errors.shot

@@ -7,10 +7,12 @@ Object {
     "declaration/ClassDeclaration/fixtures/_error_/missing-extends-type-param/fixture.ts",
     "declaration/ClassDeclaration/fixtures/_error_/missing-type-param/fixture.ts",
     "declaration/ExportAllDeclaration/fixtures/_error_/kind-type/fixture.ts",
+    "declaration/ExportAllDeclaration/fixtures/_error_/non-string-source/fixture.ts",
     "declaration/ExportAllDeclaration/fixtures/_error_/type-kind/fixture.ts",
     "declaration/ExportNamedDeclaration/fixtures/_error_/anonymous-class/fixture.ts",
     "declaration/ExportNamedDeclaration/fixtures/_error_/assertion/fixture.ts",
     "declaration/FunctionDeclaration/fixtures/_error_/missing-type-param/fixture.ts",
+    "declaration/ImportDeclaration/fixtures/_error_/non-string-source/fixture.ts",
     "declaration/TSDeclareFunction/fixtures/_error_/async/fixture.ts",
     "declaration/TSDeclareFunction/fixtures/_error_/declare-with-body/fixture.ts",
     "declaration/TSDeclareFunction/fixtures/_error_/missing-type-param/fixture.ts",

packages/ast-spec/tests/util/parsers/typescript-estree.ts

@@ -13,6 +13,7 @@ export function parseTSESTree(
       loc: true,
       range: true,
       tokens: true,
+      errorOnInvalidAST: fixture.config.errorOnInvalidAST,
     });
     const { tokens: _, comments: __, ...program } = result;
 

packages/ast-spec/typings/global.d.ts

@@ -11,4 +11,6 @@ interface ASTFixtureConfig {
    * The value should be a description of why there isn't support - for example a github issue URL.
    */
   readonly expectBabelToNotSupport?: string;
+
+  readonly errorOnInvalidAST?: boolean;
 }

packages/parser/tests/lib/parser.ts

@@ -35,7 +35,6 @@ describe('parser', () => {
       // ts-estree specific
       filePath: 'isolated-file.src.ts',
       project: 'tsconfig.json',
-      errorOnUnknownASTType: false,
       errorOnTypeScriptSyntacticAndSemanticIssues: false,
       tsconfigRootDir: 'tests/fixtures/services',
       extraFileExtensions: ['.foo'],
@@ -89,7 +88,6 @@ describe('parser', () => {
       // ts-estree specific
       filePath: 'isolated-file.src.ts',
       project: 'tsconfig.json',
-      errorOnUnknownASTType: false,
       errorOnTypeScriptSyntacticAndSemanticIssues: false,
       tsconfigRootDir: 'tests/fixtures/services',
       extraFileExtensions: ['.foo'],

packages/typescript-estree/src/ast-converter.ts

@@ -26,6 +26,7 @@ export function astConverter(
    * Recursively convert the TypeScript AST into an ESTree-compatible AST
    */
   const instance = new Converter(ast, {
+    errorOnInvalidAST: parseSettings.errorOnInvalidAST || false,
     errorOnUnknownASTType: parseSettings.errorOnUnknownASTType || false,
     shouldPreserveNodeMaps,
   });