@typescript-eslint/typescript-estree
Version:
A parser that converts TypeScript source code into an ESTree compatible form
1,030 lines • 130 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
};
var _Converter_instances, _Converter_checkModifiers, _Converter_throwUnlessAllowInvalidAST, _Converter_withDeprecatedAliasGetter, _Converter_throwError;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Converter = exports.convertError = void 0;
// There's lots of funny stuff due to the typing of ts.Node
/* eslint-disable @typescript-eslint/no-explicit-any, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-member-access */
const ts = __importStar(require("typescript"));
const getModifiers_1 = require("./getModifiers");
const node_utils_1 = require("./node-utils");
const ts_estree_1 = require("./ts-estree");
const SyntaxKind = ts.SyntaxKind;
/**
* Extends and formats a given error object
* @param error the error object
* @returns converted error object
*/
function convertError(error) {
return (0, node_utils_1.createError)(('message' in error && error.message) || error.messageText, error.file, error.start);
}
exports.convertError = convertError;
class Converter {
/**
* Converts a TypeScript node into an ESTree node
* @param ast the full TypeScript AST
* @param options additional options for the conversion
* @returns the converted ESTreeNode
*/
constructor(ast, options) {
_Converter_instances.add(this);
this.esTreeNodeToTSNodeMap = new WeakMap();
this.tsNodeToESTreeNodeMap = new WeakMap();
this.allowPattern = false;
this.ast = ast;
this.options = { ...options };
}
getASTMaps() {
return {
esTreeNodeToTSNodeMap: this.esTreeNodeToTSNodeMap,
tsNodeToESTreeNodeMap: this.tsNodeToESTreeNodeMap,
};
}
convertProgram() {
return this.converter(this.ast);
}
/**
* Converts a TypeScript node into an ESTree node.
* @param node the child ts.Node
* @param parent parentNode
* @param allowPattern flag to determine if patterns are allowed
* @returns the converted ESTree node
*/
converter(node, parent, allowPattern) {
/**
* Exit early for null and undefined
*/
if (!node) {
return null;
}
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_checkModifiers).call(this, node);
const pattern = this.allowPattern;
if (allowPattern !== undefined) {
this.allowPattern = allowPattern;
}
const result = this.convertNode(node, (parent ?? node.parent));
this.registerTSNodeInNodeMap(node, result);
this.allowPattern = pattern;
return result;
}
/**
* Fixes the exports of the given ts.Node
* @param node the ts.Node
* @param result result
* @returns the ESTreeNode with fixed exports
*/
fixExports(node, result) {
const isNamespaceNode = ts.isModuleDeclaration(node) &&
Boolean(node.flags & ts.NodeFlags.Namespace);
const modifiers = isNamespaceNode
? (0, node_utils_1.getNamespaceModifiers)(node)
: (0, getModifiers_1.getModifiers)(node);
if (modifiers?.[0].kind === SyntaxKind.ExportKeyword) {
/**
* Make sure that original node is registered instead of export
*/
this.registerTSNodeInNodeMap(node, result);
const exportKeyword = modifiers[0];
const nextModifier = modifiers[1];
const declarationIsDefault = nextModifier?.kind === SyntaxKind.DefaultKeyword;
const varToken = declarationIsDefault
? (0, node_utils_1.findNextToken)(nextModifier, this.ast, this.ast)
: (0, node_utils_1.findNextToken)(exportKeyword, this.ast, this.ast);
result.range[0] = varToken.getStart(this.ast);
result.loc = (0, node_utils_1.getLocFor)(result.range, this.ast);
if (declarationIsDefault) {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ExportDefaultDeclaration,
declaration: result,
range: [exportKeyword.getStart(this.ast), result.range[1]],
exportKind: 'value',
});
}
const isType = result.type === ts_estree_1.AST_NODE_TYPES.TSInterfaceDeclaration ||
result.type === ts_estree_1.AST_NODE_TYPES.TSTypeAliasDeclaration;
const isDeclare = 'declare' in result && result.declare === true;
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ExportNamedDeclaration,
// @ts-expect-error - TODO, narrow the types here
declaration: result,
specifiers: [],
source: null,
exportKind: isType || isDeclare ? 'type' : 'value',
range: [exportKeyword.getStart(this.ast), result.range[1]],
assertions: [],
});
}
return result;
}
/**
* Register specific TypeScript node into map with first ESTree node provided
*/
registerTSNodeInNodeMap(node, result) {
if (result && this.options.shouldPreserveNodeMaps) {
if (!this.tsNodeToESTreeNodeMap.has(node)) {
this.tsNodeToESTreeNodeMap.set(node, result);
}
}
}
/**
* Converts a TypeScript node into an ESTree node.
* @param child the child ts.Node
* @param parent parentNode
* @returns the converted ESTree node
*/
convertPattern(child, parent) {
return this.converter(child, parent, true);
}
/**
* Converts a TypeScript node into an ESTree node.
* @param child the child ts.Node
* @param parent parentNode
* @returns the converted ESTree node
*/
convertChild(child, parent) {
return this.converter(child, parent, false);
}
createNode(
// The 'parent' property will be added later if specified
node, data) {
const result = data;
result.range ??= (0, node_utils_1.getRange)(node, this.ast);
result.loc ??= (0, node_utils_1.getLocFor)(result.range, this.ast);
if (result && this.options.shouldPreserveNodeMaps) {
this.esTreeNodeToTSNodeMap.set(result, node);
}
return result;
}
convertBindingNameWithTypeAnnotation(name, tsType, parent) {
const id = this.convertPattern(name);
if (tsType) {
id.typeAnnotation = this.convertTypeAnnotation(tsType, parent);
this.fixParentLocation(id, id.typeAnnotation.range);
}
return id;
}
/**
* Converts a child into a type annotation. This creates an intermediary
* TypeAnnotation node to match what Flow does.
* @param child The TypeScript AST node to convert.
* @param parent parentNode
* @returns The type annotation node.
*/
convertTypeAnnotation(child, parent) {
// in FunctionType and ConstructorType typeAnnotation has 2 characters `=>` and in other places is just colon
const offset = parent?.kind === SyntaxKind.FunctionType ||
parent?.kind === SyntaxKind.ConstructorType
? 2
: 1;
const annotationStartCol = child.getFullStart() - offset;
const range = [annotationStartCol, child.end];
const loc = (0, node_utils_1.getLocFor)(range, this.ast);
return {
type: ts_estree_1.AST_NODE_TYPES.TSTypeAnnotation,
loc,
range,
typeAnnotation: this.convertChild(child),
};
}
/**
* Coverts body Nodes and add a directive field to StringLiterals
* @param nodes of ts.Node
* @param parent parentNode
* @returns Array of body statements
*/
convertBodyExpressions(nodes, parent) {
let allowDirectives = (0, node_utils_1.canContainDirective)(parent);
return (nodes
.map(statement => {
const child = this.convertChild(statement);
if (allowDirectives) {
if (child?.expression &&
ts.isExpressionStatement(statement) &&
ts.isStringLiteral(statement.expression)) {
const raw = child.expression.raw;
child.directive = raw.slice(1, -1);
return child; // child can be null, but it's filtered below
}
allowDirectives = false;
}
return child; // child can be null, but it's filtered below
})
// filter out unknown nodes for now
.filter(statement => statement));
}
/**
* Converts a ts.Node's typeArguments to TSTypeParameterInstantiation node
* @param typeArguments ts.NodeArray typeArguments
* @param node parent used to create this node
* @returns TypeParameterInstantiation node
*/
convertTypeArgumentsToTypeParameterInstantiation(typeArguments, node) {
const greaterThanToken = (0, node_utils_1.findNextToken)(typeArguments, this.ast, this.ast);
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.TSTypeParameterInstantiation,
range: [typeArguments.pos - 1, greaterThanToken.end],
params: typeArguments.map(typeArgument => this.convertChild(typeArgument)),
});
}
/**
* Converts a ts.Node's typeParameters to TSTypeParameterDeclaration node
* @param typeParameters ts.Node typeParameters
* @returns TypeParameterDeclaration node
*/
convertTSTypeParametersToTypeParametersDeclaration(typeParameters) {
const greaterThanToken = (0, node_utils_1.findNextToken)(typeParameters, this.ast, this.ast);
const range = [
typeParameters.pos - 1,
greaterThanToken.end,
];
return {
type: ts_estree_1.AST_NODE_TYPES.TSTypeParameterDeclaration,
range,
loc: (0, node_utils_1.getLocFor)(range, this.ast),
params: typeParameters.map(typeParameter => this.convertChild(typeParameter)),
};
}
/**
* Converts an array of ts.Node parameters into an array of ESTreeNode params
* @param parameters An array of ts.Node params to be converted
* @returns an array of converted ESTreeNode params
*/
convertParameters(parameters) {
if (!parameters?.length) {
return [];
}
return parameters.map(param => {
const convertedParam = this.convertChild(param);
convertedParam.decorators =
(0, getModifiers_1.getDecorators)(param)?.map(el => this.convertChild(el)) ?? [];
return convertedParam;
});
}
convertChainExpression(node, tsNode) {
const { child, isOptional } = (() => {
if (node.type === ts_estree_1.AST_NODE_TYPES.MemberExpression) {
return { child: node.object, isOptional: node.optional };
}
if (node.type === ts_estree_1.AST_NODE_TYPES.CallExpression) {
return { child: node.callee, isOptional: node.optional };
}
return { child: node.expression, isOptional: false };
})();
const isChildUnwrappable = (0, node_utils_1.isChildUnwrappableOptionalChain)(tsNode, child);
if (!isChildUnwrappable && !isOptional) {
return node;
}
if (isChildUnwrappable && (0, node_utils_1.isChainExpression)(child)) {
// unwrap the chain expression child
const newChild = child.expression;
if (node.type === ts_estree_1.AST_NODE_TYPES.MemberExpression) {
node.object = newChild;
}
else if (node.type === ts_estree_1.AST_NODE_TYPES.CallExpression) {
node.callee = newChild;
}
else {
node.expression = newChild;
}
}
return this.createNode(tsNode, {
type: ts_estree_1.AST_NODE_TYPES.ChainExpression,
expression: node,
});
}
/**
* For nodes that are copied directly from the TypeScript AST into
* ESTree mostly as-is. The only difference is the addition of a type
* property instead of a kind property. Recursively copies all children.
*/
deeplyCopy(node) {
if (node.kind === ts.SyntaxKind.JSDocFunctionType) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, node, 'JSDoc types can only be used inside documentation comments.');
}
const customType = `TS${SyntaxKind[node.kind]}`;
/**
* If the "errorOnUnknownASTType" option is set to true, throw an error,
* otherwise fallback to just including the unknown type as-is.
*/
if (this.options.errorOnUnknownASTType && !ts_estree_1.AST_NODE_TYPES[customType]) {
throw new Error(`Unknown AST_NODE_TYPE: "${customType}"`);
}
const result = this.createNode(node, {
type: customType,
});
if ('type' in node) {
result.typeAnnotation =
node.type && 'kind' in node.type && ts.isTypeNode(node.type)
? this.convertTypeAnnotation(node.type, node)
: null;
}
if ('typeArguments' in node) {
result.typeArguments =
node.typeArguments && 'pos' in node.typeArguments
? this.convertTypeArgumentsToTypeParameterInstantiation(node.typeArguments, node)
: null;
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_withDeprecatedAliasGetter).call(this, result, 'typeParameters', 'typeArguments');
}
if ('typeParameters' in node) {
result.typeParameters =
node.typeParameters && 'pos' in node.typeParameters
? this.convertTSTypeParametersToTypeParametersDeclaration(node.typeParameters)
: null;
}
const decorators = (0, getModifiers_1.getDecorators)(node);
if (decorators?.length) {
result.decorators = decorators.map(el => this.convertChild(el));
}
// keys we never want to clone from the base typescript node as they
// introduce garbage into our AST
const KEYS_TO_NOT_COPY = new Set([
'_children',
'decorators',
'end',
'flags',
'illegalDecorators',
'heritageClauses',
'locals',
'localSymbol',
'jsDoc',
'kind',
'modifierFlagsCache',
'modifiers',
'nextContainer',
'parent',
'pos',
'symbol',
'transformFlags',
'type',
'typeArguments',
'typeParameters',
]);
Object.entries(node)
.filter(([key]) => !KEYS_TO_NOT_COPY.has(key))
.forEach(([key, value]) => {
if (Array.isArray(value)) {
result[key] = value.map(el => this.convertChild(el));
}
else if (value && typeof value === 'object' && value.kind) {
// need to check node[key].kind to ensure we don't try to convert a symbol
result[key] = this.convertChild(value);
}
else {
result[key] = value;
}
});
return result;
}
convertJSXIdentifier(node) {
const result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXIdentifier,
name: node.getText(),
});
this.registerTSNodeInNodeMap(node, result);
return result;
}
convertJSXNamespaceOrIdentifier(node) {
// TypeScript@5.1 added in ts.JsxNamespacedName directly
// We prefer using that if it's relevant for this node type
if (node.kind === ts.SyntaxKind.JsxNamespacedName) {
const result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXNamespacedName,
namespace: this.createNode(node.namespace, {
type: ts_estree_1.AST_NODE_TYPES.JSXIdentifier,
name: node.namespace.text,
}),
name: this.createNode(node.name, {
type: ts_estree_1.AST_NODE_TYPES.JSXIdentifier,
name: node.name.text,
}),
});
this.registerTSNodeInNodeMap(node, result);
return result;
}
// TypeScript@<5.1 has to manually parse the JSX attributes
const text = node.getText();
const colonIndex = text.indexOf(':');
// this is intentional we can ignore conversion if `:` is in first character
if (colonIndex > 0) {
const range = (0, node_utils_1.getRange)(node, this.ast);
// @ts-expect-error -- TypeScript@<5.1 doesn't have ts.JsxNamespacedName
const result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXNamespacedName,
namespace: this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXIdentifier,
name: text.slice(0, colonIndex),
range: [range[0], range[0] + colonIndex],
}),
name: this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXIdentifier,
name: text.slice(colonIndex + 1),
range: [range[0] + colonIndex + 1, range[1]],
}),
range,
});
this.registerTSNodeInNodeMap(node, result);
return result;
}
return this.convertJSXIdentifier(node);
}
/**
* Converts a TypeScript JSX node.tagName into an ESTree node.name
* @param node the tagName object from a JSX ts.Node
* @param parent
* @returns the converted ESTree name object
*/
convertJSXTagName(node, parent) {
let result;
switch (node.kind) {
case SyntaxKind.PropertyAccessExpression:
if (node.name.kind === SyntaxKind.PrivateIdentifier) {
// This is one of the few times where TS explicitly errors, and doesn't even gracefully handle the syntax.
// So we shouldn't ever get into this state to begin with.
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, node.name, 'Non-private identifier expected.');
}
result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.JSXMemberExpression,
object: this.convertJSXTagName(node.expression, parent),
property: this.convertJSXIdentifier(node.name),
});
break;
case SyntaxKind.ThisKeyword:
case SyntaxKind.Identifier:
default:
return this.convertJSXNamespaceOrIdentifier(node);
}
this.registerTSNodeInNodeMap(node, result);
return result;
}
convertMethodSignature(node) {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.TSMethodSignature,
accessibility: (0, node_utils_1.getTSNodeAccessibility)(node),
computed: (0, node_utils_1.isComputedProperty)(node.name),
key: this.convertChild(node.name),
kind: (() => {
switch (node.kind) {
case SyntaxKind.GetAccessor:
return 'get';
case SyntaxKind.SetAccessor:
return 'set';
case SyntaxKind.MethodSignature:
return 'method';
}
})(),
optional: (0, node_utils_1.isOptional)(node),
params: this.convertParameters(node.parameters),
returnType: node.type && this.convertTypeAnnotation(node.type, node),
readonly: (0, node_utils_1.hasModifier)(SyntaxKind.ReadonlyKeyword, node),
static: (0, node_utils_1.hasModifier)(SyntaxKind.StaticKeyword, node),
typeParameters: node.typeParameters &&
this.convertTSTypeParametersToTypeParametersDeclaration(node.typeParameters),
});
}
convertAssertClasue(node) {
return node === undefined
? []
: node.elements.map(element => this.convertChild(element));
}
/**
* Uses the provided range location to adjust the location data of the given Node
* @param result The node that will have its location data mutated
* @param childRange The child node range used to expand location
*/
fixParentLocation(result, childRange) {
if (childRange[0] < result.range[0]) {
result.range[0] = childRange[0];
result.loc.start = (0, node_utils_1.getLineAndCharacterFor)(result.range[0], this.ast);
}
if (childRange[1] > result.range[1]) {
result.range[1] = childRange[1];
result.loc.end = (0, node_utils_1.getLineAndCharacterFor)(result.range[1], this.ast);
}
}
assertModuleSpecifier(node, allowNull) {
if (!allowNull && node.moduleSpecifier == null) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwUnlessAllowInvalidAST).call(this, node, 'Module specifier must be a string literal.');
}
if (node.moduleSpecifier &&
node.moduleSpecifier?.kind !== SyntaxKind.StringLiteral) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwUnlessAllowInvalidAST).call(this, node.moduleSpecifier, 'Module specifier must be a string literal.');
}
}
/**
* Converts a TypeScript node into an ESTree node.
* The core of the conversion logic:
* Identify and convert each relevant TypeScript SyntaxKind
* @param node the child ts.Node
* @param parent parentNode
* @returns the converted ESTree node
*/
convertNode(node, parent) {
switch (node.kind) {
case SyntaxKind.SourceFile: {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Program,
body: this.convertBodyExpressions(node.statements, node),
comments: undefined,
range: [node.getStart(this.ast), node.endOfFileToken.end],
sourceType: node.externalModuleIndicator ? 'module' : 'script',
tokens: undefined,
});
}
case SyntaxKind.Block: {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.BlockStatement,
body: this.convertBodyExpressions(node.statements, node),
});
}
case SyntaxKind.Identifier: {
if ((0, node_utils_1.isThisInTypeQuery)(node)) {
// special case for `typeof this.foo` - TS emits an Identifier for `this`
// but we want to treat it as a ThisExpression for consistency
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ThisExpression,
});
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Identifier,
decorators: [],
name: node.text,
optional: false,
typeAnnotation: undefined,
});
}
case SyntaxKind.PrivateIdentifier: {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.PrivateIdentifier,
// typescript includes the `#` in the text
name: node.text.slice(1),
});
}
case SyntaxKind.WithStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.WithStatement,
object: this.convertChild(node.expression),
body: this.convertChild(node.statement),
});
// Control Flow
case SyntaxKind.ReturnStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ReturnStatement,
argument: this.convertChild(node.expression),
});
case SyntaxKind.LabeledStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.LabeledStatement,
label: this.convertChild(node.label),
body: this.convertChild(node.statement),
});
case SyntaxKind.ContinueStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ContinueStatement,
label: this.convertChild(node.label),
});
case SyntaxKind.BreakStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.BreakStatement,
label: this.convertChild(node.label),
});
// Choice
case SyntaxKind.IfStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.IfStatement,
test: this.convertChild(node.expression),
consequent: this.convertChild(node.thenStatement),
alternate: this.convertChild(node.elseStatement),
});
case SyntaxKind.SwitchStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.SwitchStatement,
discriminant: this.convertChild(node.expression),
cases: node.caseBlock.clauses.map(el => this.convertChild(el)),
});
case SyntaxKind.CaseClause:
case SyntaxKind.DefaultClause:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.SwitchCase,
// expression is present in case only
test: node.kind === SyntaxKind.CaseClause
? this.convertChild(node.expression)
: null,
consequent: node.statements.map(el => this.convertChild(el)),
});
// Exceptions
case SyntaxKind.ThrowStatement:
if (node.expression.end === node.expression.pos) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwUnlessAllowInvalidAST).call(this, node, 'A throw statement must throw an expression.');
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ThrowStatement,
argument: this.convertChild(node.expression),
});
case SyntaxKind.TryStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.TryStatement,
block: this.convertChild(node.tryBlock),
handler: this.convertChild(node.catchClause),
finalizer: this.convertChild(node.finallyBlock),
});
case SyntaxKind.CatchClause:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.CatchClause,
param: node.variableDeclaration
? this.convertBindingNameWithTypeAnnotation(node.variableDeclaration.name, node.variableDeclaration.type)
: null,
body: this.convertChild(node.block),
});
// Loops
case SyntaxKind.WhileStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.WhileStatement,
test: this.convertChild(node.expression),
body: this.convertChild(node.statement),
});
/**
* Unlike other parsers, TypeScript calls a "DoWhileStatement"
* a "DoStatement"
*/
case SyntaxKind.DoStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.DoWhileStatement,
test: this.convertChild(node.expression),
body: this.convertChild(node.statement),
});
case SyntaxKind.ForStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ForStatement,
init: this.convertChild(node.initializer),
test: this.convertChild(node.condition),
update: this.convertChild(node.incrementor),
body: this.convertChild(node.statement),
});
case SyntaxKind.ForInStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ForInStatement,
left: this.convertPattern(node.initializer),
right: this.convertChild(node.expression),
body: this.convertChild(node.statement),
});
case SyntaxKind.ForOfStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ForOfStatement,
left: this.convertPattern(node.initializer),
right: this.convertChild(node.expression),
body: this.convertChild(node.statement),
await: Boolean(node.awaitModifier &&
node.awaitModifier.kind === SyntaxKind.AwaitKeyword),
});
// Declarations
case SyntaxKind.FunctionDeclaration: {
const isDeclare = (0, node_utils_1.hasModifier)(SyntaxKind.DeclareKeyword, node);
const result = this.createNode(node, {
type: isDeclare || !node.body
? ts_estree_1.AST_NODE_TYPES.TSDeclareFunction
: ts_estree_1.AST_NODE_TYPES.FunctionDeclaration,
async: (0, node_utils_1.hasModifier)(SyntaxKind.AsyncKeyword, node),
body: this.convertChild(node.body) || undefined,
declare: isDeclare,
expression: false,
generator: !!node.asteriskToken,
id: this.convertChild(node.name),
params: this.convertParameters(node.parameters),
returnType: node.type && this.convertTypeAnnotation(node.type, node),
typeParameters: node.typeParameters &&
this.convertTSTypeParametersToTypeParametersDeclaration(node.typeParameters),
});
return this.fixExports(node, result);
}
case SyntaxKind.VariableDeclaration: {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.VariableDeclarator,
definite: !!node.exclamationToken,
id: this.convertBindingNameWithTypeAnnotation(node.name, node.type, node),
init: this.convertChild(node.initializer),
});
}
case SyntaxKind.VariableStatement: {
const result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.VariableDeclaration,
declarations: node.declarationList.declarations.map(el => this.convertChild(el)),
declare: (0, node_utils_1.hasModifier)(SyntaxKind.DeclareKeyword, node),
kind: (0, node_utils_1.getDeclarationKind)(node.declarationList),
});
if (!result.declarations.length) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwUnlessAllowInvalidAST).call(this, node, 'A variable declaration list must have at least one variable declarator.');
}
/**
* Semantically, decorators are not allowed on variable declarations,
* Pre 4.8 TS would include them in the AST, so we did as well.
* However as of 4.8 TS no longer includes it (as it is, well, invalid).
*
* So for consistency across versions, we no longer include it either.
*/
return this.fixExports(node, result);
}
// mostly for for-of, for-in
case SyntaxKind.VariableDeclarationList:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.VariableDeclaration,
declarations: node.declarations.map(el => this.convertChild(el)),
declare: false,
kind: (0, node_utils_1.getDeclarationKind)(node),
});
// Expressions
case SyntaxKind.ExpressionStatement:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ExpressionStatement,
directive: undefined,
expression: this.convertChild(node.expression),
});
case SyntaxKind.ThisKeyword:
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ThisExpression,
});
case SyntaxKind.ArrayLiteralExpression: {
// TypeScript uses ArrayLiteralExpression in destructuring assignment, too
if (this.allowPattern) {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ArrayPattern,
decorators: [],
elements: node.elements.map(el => this.convertPattern(el)),
optional: false,
typeAnnotation: undefined,
});
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ArrayExpression,
elements: node.elements.map(el => this.convertChild(el)),
});
}
case SyntaxKind.ObjectLiteralExpression: {
// TypeScript uses ObjectLiteralExpression in destructuring assignment, too
if (this.allowPattern) {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ObjectPattern,
decorators: [],
optional: false,
properties: node.properties.map(el => this.convertPattern(el)),
typeAnnotation: undefined,
});
}
const properties = [];
for (const property of node.properties) {
if ((property.kind === SyntaxKind.GetAccessor ||
property.kind === SyntaxKind.SetAccessor ||
property.kind === SyntaxKind.MethodDeclaration) &&
!property.body) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwUnlessAllowInvalidAST).call(this, property.end - 1, "'{' expected.");
}
properties.push(this.convertChild(property));
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.ObjectExpression,
properties,
});
}
case SyntaxKind.PropertyAssignment: {
// eslint-disable-next-line deprecation/deprecation
const { questionToken, exclamationToken } = node;
if (questionToken) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, questionToken, 'A property assignment cannot have a question token.');
}
if (exclamationToken) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, exclamationToken, 'A property assignment cannot have an exclamation token.');
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Property,
key: this.convertChild(node.name),
value: this.converter(node.initializer, node, this.allowPattern),
computed: (0, node_utils_1.isComputedProperty)(node.name),
method: false,
optional: false,
shorthand: false,
kind: 'init',
});
}
case SyntaxKind.ShorthandPropertyAssignment: {
// eslint-disable-next-line deprecation/deprecation
const { modifiers, questionToken, exclamationToken } = node;
if (modifiers) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, modifiers[0], 'A shorthand property assignment cannot have modifiers.');
}
if (questionToken) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, questionToken, 'A shorthand property assignment cannot have a question token.');
}
if (exclamationToken) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, exclamationToken, 'A shorthand property assignment cannot have an exclamation token.');
}
if (node.objectAssignmentInitializer) {
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Property,
key: this.convertChild(node.name),
value: this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.AssignmentPattern,
decorators: [],
left: this.convertPattern(node.name),
optional: false,
right: this.convertChild(node.objectAssignmentInitializer),
typeAnnotation: undefined,
}),
computed: false,
method: false,
optional: false,
shorthand: true,
kind: 'init',
});
}
return this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Property,
computed: false,
key: this.convertChild(node.name),
kind: 'init',
method: false,
optional: false,
shorthand: true,
value: this.convertChild(node.name),
});
}
case SyntaxKind.ComputedPropertyName:
return this.convertChild(node.expression);
case SyntaxKind.PropertyDeclaration: {
const isAbstract = (0, node_utils_1.hasModifier)(SyntaxKind.AbstractKeyword, node);
if (isAbstract && node.initializer) {
__classPrivateFieldGet(this, _Converter_instances, "m", _Converter_throwError).call(this, node.initializer, `Abstract property cannot have an initializer.`);
}
const isAccessor = (0, node_utils_1.hasModifier)(SyntaxKind.AccessorKeyword, node);
const type = (() => {
if (isAccessor) {
if (isAbstract) {
return ts_estree_1.AST_NODE_TYPES.TSAbstractAccessorProperty;
}
return ts_estree_1.AST_NODE_TYPES.AccessorProperty;
}
if (isAbstract) {
return ts_estree_1.AST_NODE_TYPES.TSAbstractPropertyDefinition;
}
return ts_estree_1.AST_NODE_TYPES.PropertyDefinition;
})();
const key = this.convertChild(node.name);
return this.createNode(node, {
type,
key,
accessibility: (0, node_utils_1.getTSNodeAccessibility)(node),
value: isAbstract ? null : this.convertChild(node.initializer),
computed: (0, node_utils_1.isComputedProperty)(node.name),
static: (0, node_utils_1.hasModifier)(SyntaxKind.StaticKeyword, node),
readonly: (0, node_utils_1.hasModifier)(SyntaxKind.ReadonlyKeyword, node),
decorators: (0, getModifiers_1.getDecorators)(node)?.map(el => this.convertChild(el)) ?? [],
declare: (0, node_utils_1.hasModifier)(SyntaxKind.DeclareKeyword, node),
override: (0, node_utils_1.hasModifier)(SyntaxKind.OverrideKeyword, node),
typeAnnotation: node.type && this.convertTypeAnnotation(node.type, node),
optional: (key.type === ts_estree_1.AST_NODE_TYPES.Literal ||
node.name.kind === SyntaxKind.Identifier ||
node.name.kind === SyntaxKind.ComputedPropertyName ||
node.name.kind === SyntaxKind.PrivateIdentifier) &&
!!node.questionToken,
definite: !!node.exclamationToken,
});
}
case SyntaxKind.GetAccessor:
case SyntaxKind.SetAccessor: {
if (node.parent.kind === SyntaxKind.InterfaceDeclaration ||
node.parent.kind === SyntaxKind.TypeLiteral) {
return this.convertMethodSignature(node);
}
}
// otherwise, it is a non-type accessor - intentional fallthrough
case SyntaxKind.MethodDeclaration: {
const method = this.createNode(node, {
type: !node.body
? ts_estree_1.AST_NODE_TYPES.TSEmptyBodyFunctionExpression
: ts_estree_1.AST_NODE_TYPES.FunctionExpression,
id: null,
generator: !!node.asteriskToken,
expression: false,
async: (0, node_utils_1.hasModifier)(SyntaxKind.AsyncKeyword, node),
body: this.convertChild(node.body),
declare: false,
range: [node.parameters.pos - 1, node.end],
params: [],
returnType: node.type && this.convertTypeAnnotation(node.type, node),
typeParameters: node.typeParameters &&
this.convertTSTypeParametersToTypeParametersDeclaration(node.typeParameters),
});
if (method.typeParameters) {
this.fixParentLocation(method, method.typeParameters.range);
}
let result;
if (parent.kind === SyntaxKind.ObjectLiteralExpression) {
method.params = node.parameters.map(el => this.convertChild(el));
result = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Property,
key: this.convertChild(node.name),
value: method,
computed: (0, node_utils_1.isComputedProperty)(node.name),
optional: !!node.questionToken,
method: node.kind === SyntaxKind.MethodDeclaration,
shorthand: false,
kind: 'init',
});
}
else {
// class
/**
* Unlike in object literal methods, class method params can have decorators
*/
method.params = this.convertParameters(node.parameters);
/**
* TypeScript class methods can be defined as "abstract"
*/
const methodDefinitionType = (0, node_utils_1.hasModifier)(SyntaxKind.AbstractKeyword, node)
? ts_estree_1.AST_NODE_TYPES.TSAbstractMethodDefinition
: ts_estree_1.AST_NODE_TYPES.MethodDefinition;
result = this.createNode(node, {
type: methodDefinitionType,
accessibility: (0, node_utils_1.getTSNodeAccessibility)(node),
computed: (0, node_utils_1.isComputedProperty)(node.name),
decorators: (0, getModifiers_1.getDecorators)(node)?.map(el => this.convertChild(el)) ?? [],
key: this.convertChild(node.name),
kind: 'method',
optional: !!node.questionToken,
override: (0, node_utils_1.hasModifier)(SyntaxKind.OverrideKeyword, node),
static: (0, node_utils_1.hasModifier)(SyntaxKind.StaticKeyword, node),
value: method,
});
}
if (node.kind === SyntaxKind.GetAccessor) {
result.kind = 'get';
}
else if (node.kind === SyntaxKind.SetAccessor) {
result.kind = 'set';
}
else if (!result.static &&
node.name.kind === SyntaxKind.StringLiteral &&
node.name.text === 'constructor' &&
result.type !== ts_estree_1.AST_NODE_TYPES.Property) {
result.kind = 'constructor';
}
return result;
}
// TypeScript uses this even for static methods named "constructor"
case SyntaxKind.Constructor: {
const lastModifier = (0, node_utils_1.getLastModifier)(node);
const constructorToken = (lastModifier && (0, node_utils_1.findNextToken)(lastModifier, node, this.ast)) ??
node.getFirstToken();
const constructor = this.createNode(node, {
type: !node.body
? ts_estree_1.AST_NODE_TYPES.TSEmptyBodyFunctionExpression
: ts_estree_1.AST_NODE_TYPES.FunctionExpression,
async: false,
body: this.convertChild(node.body),
declare: false,
expression: false,
generator: false,
id: null,
params: this.convertParameters(node.parameters),
range: [node.parameters.pos - 1, node.end],
returnType: node.type && this.convertTypeAnnotation(node.type, node),
typeParameters: node.typeParameters &&
this.convertTSTypeParametersToTypeParametersDeclaration(node.typeParameters),
});
if (constructor.typeParameters) {
this.fixParentLocation(constructor, constructor.typeParameters.range);
}
const constructorKey = this.createNode(node, {
type: ts_estree_1.AST_NODE_TYPES.Identifier,
decorators: [],
name: 'constructor',
optional: false,
range: [constructorToken.getStart(this.ast), constructorToken.end],
typeAnnotation: undefined,
});
const isStatic = (0, node_util