[eslint] create NodeListener and extend RuleListener #25399
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
typescript-bot
added
Popular package
|
@stas-vilchik Thank you for submitting this PR! 🔔 @pmdartus @j-f1 - please review this PR in the next few days. Be sure to explicitly select If no reviewer appears after a week, a DefinitelyTyped maintainer will review the PR instead. |
typescript-bot
moved this from Waiting for Reviewers
to Review
in Pull Request Status Board
typescript-bot
added
the
Unmerged
|
A definition owner has approved this PR ⭐️. A maintainer will merge this PR shortly. If it shouldn't be merged yet, please leave a comment saying so and we'll wait. Thank you for your contribution to DefinitelyTyped! |
j-f1
approved these changes
May 4, 2018
typescript-bot
added
Owner Approved
SimenB
reviewed
Nov 27, 2018
| @@ -241,7 +241,10 @@ export namespace Rule { | |||
| meta?: RuleMetaData; | |||
| } | |||
|
|
|||
| interface RuleListener { | |||
| type NodeTypes = ESTree.Node['type']; | |||
| type NodeListener = { [T in NodeTypes]?: (node: ESTree.Node) => void }; | |||
There was a problem hiding this comment.
Would it be possible to type node to be T?
(I'm a TS newbie, so might not be needed).
const rule: Rule.RuleModule = {
create() {
return {
CallExpression(node: CallExpression) {
console.log(node.callee);
},
};
},
};Gives me Type 'Node' is not assignable to type 'CallExpression'
There was a problem hiding this comment.
const rule: Rule.RuleModule = {
create() {
return {
CallExpression(node: CallExpression) {
if (node.type !== 'CallExpression') {
return;
}
console.log(node.callee);
},
};
},
};Seems to fix it, but that's dead code...
There was a problem hiding this comment.
The solution to this is a two-parter:
-
Add a new mapping to
@types/estree. This maps from the name of the node to its type.// yes, this is necessary :( type _NodeMap = { [K in Node['type']]: Node } export interface NodeByType extends _NodeMap { Identifier: Identifier SimpleLiteral: SimpleLiteral RegExpLiteral: RegExpLiteral Program: Program FunctionDeclaration: FunctionDeclaration FunctionExpression: FunctionExpression ArrowFunctionExpression: ArrowFunctionExpression SwitchCase: SwitchCase CatchClause: CatchClause VariableDeclarator: VariableDeclarator ExpressionStatement: ExpressionStatement BlockStatement: BlockStatement EmptyStatement: EmptyStatement DebuggerStatement: DebuggerStatement WithStatement: WithStatement ReturnStatement: ReturnStatement LabeledStatement: LabeledStatement BreakStatement: BreakStatement ContinueStatement: ContinueStatement IfStatement: IfStatement SwitchStatement: SwitchStatement ThrowStatement: ThrowStatement TryStatement: TryStatement WhileStatement: WhileStatement DoWhileStatement: DoWhileStatement ForStatement: ForStatement ForInStatement: ForInStatement ForOfStatement: ForOfStatement // FunctionDeclaration: FunctionDeclaration VariableDeclaration: VariableDeclaration ClassDeclaration: ClassDeclaration ThisExpression: ThisExpression ArrayExpression: ArrayExpression ObjectExpression: ObjectExpression // FunctionExpression: FunctionExpression // ArrowFunctionExpression: ArrowFunctionExpression YieldExpression: YieldExpression // Literal: Literal UnaryExpression: UnaryExpression UpdateExpression: UpdateExpression BinaryExpression: BinaryExpression AssignmentExpression: AssignmentExpression LogicalExpression: LogicalExpression MemberExpression: MemberExpression ConditionalExpression: ConditionalExpression CallExpression: SimpleCallExpression // <-- Important! NewExpression: NewExpression SequenceExpression: SequenceExpression TemplateLiteral: TemplateLiteral TaggedTemplateExpression: TaggedTemplateExpression ClassExpression: ClassExpression MetaProperty: MetaProperty // Identifier: Identifier AwaitExpression: AwaitExpression Property: Property AssignmentProperty: AssignmentProperty Super: Super TemplateElement: TemplateElement SpreadElement: SpreadElement // Identifier: Identifier ObjectPattern: ObjectPattern ArrayPattern: ArrayPattern RestElement: RestElement AssignmentPattern: AssignmentPattern // MemberExpression: MemberExpression ClassBody: ClassBody // ClassDeclaration: ClassDeclaration // ClassExpression: ClassExpression MethodDefinition: MethodDefinition ImportDeclaration: ImportDeclaration ExportNamedDeclaration: ExportNamedDeclaration ExportDefaultDeclaration: ExportDefaultDeclaration ExportAllDeclaration: ExportAllDeclaration ImportSpecifier: ImportSpecifier ImportDefaultSpecifier: ImportDefaultSpecifier ImportNamespaceSpecifier: ImportNamespaceSpecifier ExportSpecifier: ExportSpecifier }
-
Redefine the listener:
type NodeListener = { [T in ESTree.Node['type']]?: (node: ESTree.NodeByType[T]) => void }
I defined the mapping in @types/estree so it gets updated as new nodes are added.
There was a problem hiding this comment.
@j-f1 could you send a PR for that? 👼
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've created a new type
NodeListenerand extend theRuleListenerwith it. This way I get the code completion when implementing a rule:Right now each handler has the same shape
(node: ESTree.Node) => void. Would be great to find a way to infer the specific node type for each property, i.e.Suggestions are welcome!