@types/eslint allow non-ESTree AST nodes

DefinitelyTyped · Jan 17, 2024 · a4e5203 · a4e5203
1 parent eb3890d
commit a4e5203
Show file tree

Hide file tree

Showing 3 changed files with 103 additions and 97 deletions.
diff --git a/types/eslint-scope/index.d.ts b/types/eslint-scope/index.d.ts
@@ -27,7 +27,7 @@ export class Scope implements eslint.Scope.Scope {
     upper: Scope | null;
     childScopes: Scope[];
     variableScope: Scope;
-    block: estree.Node;
+    block: estree.BaseNode;
     variables: Variable[];
     set: Map<string, Variable>;
     references: Reference[];
@@ -47,7 +47,7 @@ export class Reference implements eslint.Scope.Reference {
     identifier: estree.Identifier;
     from: Scope;
     resolved: Variable | null;
-    writeExpr: estree.Node | null;
+    writeExpr: estree.BaseNode | null;
     init: boolean;
 
     isWrite(): boolean;

diff --git a/types/eslint/eslint-tests.ts b/types/eslint/eslint-tests.ts
@@ -4,7 +4,7 @@ import { Comment, PrivateIdentifier, PropertyDefinition, StaticBlock, WhileState
 
 const SOURCE = `var foo = bar;`;
 
-const AST: AST.Program = {
+const AST: AST.ValidatedProgram = {
     type: "Program",
     sourceType: "module",
     body: [],
@@ -271,7 +271,7 @@ sourceCode.markVariableAsUsed("foo", AST);
 
 sourceCode.getDeclaredVariables(AST); // $ExpectType Variable[]
 
-sourceCode.getAncestors(AST); // $ExpectType Node[]
+sourceCode.getAncestors(AST); // $ExpectType BaseNode[]
 
 // #endregion
 
@@ -683,25 +683,30 @@ linter.defineRules({
 
 linter.getRules();
 
-linter.defineParser("custom-parser", {
+const parser: Linter.ParserModule = {
     name: "foo",
     version: "1.2.3",
     meta: {
         name: "foo",
         version: "1.2.3",
     },
-    parse: (src, opts) => AST,
-});
-linter.defineParser("custom-parser", {
-    name: "foo",
-    version: "1.2.3",
-    meta: {
-        name: "foo",
-        version: "1.2.3",
+    parse: (src, opts) => {
+        return {
+            ...AST,
+            comments: opts.comment ? AST.comments : undefined,
+            tokens: opts.tokens ? AST.tokens : undefined,
+            loc: opts.loc ? AST.loc : undefined,
+            range: opts.range ? AST.range : undefined,
+        };
     },
+};
+linter.defineParser("custom-parser", parser);
+linter.defineParser("custom-parser", {
+    ...parser,
+    parse: undefined,
     parseForESLint(src, opts) {
         return {
-            ast: AST,
+            ast: parser.parse(src, opts),
             visitorKeys: {},
             parserServices: {},
             scopeManager,