-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Description
Right now a node's .parent property is loosely typed as TESTree.Node. This is pretty sucky as it means that users need to either add unnecessary logic or explicit casts to refine types in some cases.
There are a number of nodes wherein we know exactly what the parent node will always be due to the defined structure of the AST.
For example, we know that a VariableDeclarator will always have a VariableDeclaration parent.
We should define some of these simpler relationships in our types to improve the experience of consuming the AST types.
Some cases we can define:
-
AccessorPropertyhas parentClassBody(feat(ast-spec): add parent property to AccessorProperty node types #9487) -
CatchClausehas parentTryStatement -
ClassBodyhas parentClassDeclaration | ClassExpression | TSAbstractClassDeclaration -
ExportSpecifierhas parentExportNamedDeclaration -
ImportAttributehas parentImportDeclaration | ImportExpression -
ImportDefaultSpecifierhas parentImportDeclaration -
ImportNamespaceSpecifierhas parentImportDeclaration -
ImportSpecifierhas parentExportAllDeclaration | ExportNamedDeclaration | ImportDeclaration -
JSXAttributehas parentJSXOpeningElement -
JSXClosingElementhas parentJSXElement -
JSXClosingFragmenthas parentJSXFragment -
JSXOpeningElementhas parentJSXElement -
JSXOpeningFragmenthas parentJSXFragment -
JSXSpreadAttributehas parentJSXOpeningElement -
MethodDefinitionhas parentClassBody -
Propertyhas parentObjectExpression | ObjectPattern -
PropertyDefinitionhas parentClassBody -
SpreadElementhas parentArrayExpression | CallExpression | ObjectExpression -
StaticBlockhas parentClassBody -
SwitchCasehas parentSwitchStatement -
TemplateElementhas parentTemplateLiteral | TSTemplateLiteralType -
TSAbstractAccessorPropertyhas parentClassBody -
TSAbstractMethodDefinitionhas parentClassBody -
TSAbstractPropertyDefinitionhas parentClassBody -
TSCallSignatureDeclarationhas parentTSInterfaceBody | TSTypeLiteral -
TSConstructSignatureDeclarationhas parentTSInterfaceBody | TSTypeLiteral -
TSClassImplementshas parentClassDeclaration | ClassExpression -
TSEnumMemberhas parentTSEnumDeclaration -
TSIndexSignaturehas parentClassBody | TSInterfaceBody | TSTypeLiteral -
TSInterfaceBodyhas parentTSInterfaceDeclaration -
TSInterfaceHeritagehas parentTSInterfaceBody -
TSMethodSignaturehas parentTSInterfaceBody | TSTypeLiteral -
TSModuleBlockhas parentTSModuleDeclaration -
TSParameterPropertyhas parentFunctionLike -
TSPropertySignaturehas parentTSInterfaceBody | TSTypeLiteral -
TSTypeParameterhas parentTSInferType | TSTypeParameterDeclaration | TSMappedType -
VariableDeclaratorhas parentVariableDeclaration(feat(typescript-estree): restrict variable declarator definite/init combinations #9228)
Note: the implementor should double check that I've written these correctly by comparing them against the AST types.
The import thing to note is that we shouldn't define all of the relationships that exist - just a subset of them that we can easily statically define and maintain. I'd probably put a rule around ~3 parent types being the maximum.