Stop Oxc::Node from shadowing the ESTree fields it reads - #5
Merged
Conversation
This file contains hidden or 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
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.
This pull request fixes three fields that
Oxc::Nodewas hiding behind methods of its own, and teaches a field to answer to its snake_case name.A node reads a field through
method_missing, so every method it defines shadows a field called the same thing. Three of them did, and each answered something plausible instead of raising.Identifier#nameis the one that matters, since it is the most common read in any codemod.JSXElement#childrenanswered the opening and closing elements instead of what the element wraps, andImportDeclaration#attributesanswered the wrapper's own hash instead of the import'swithclause. Nothing raised in any of the three, so the wrong answer just flowed onward.What makes a name safe
ESTree spells its fields in camelCase or as a single lowercase word, so a method name carrying an underscore can never collide with one.
Checking a candidate name against
@oxc-project/typesoverreports. It declaresparenton all 121 interfaces and the serializer emits it on none of them, so the only reliable check is what a parse actually returns.Reading a field the Ruby way
Since ESTree is camelCase throughout, reading an AST used to mean writing JavaScript casing in Ruby. A field now answers to either spelling.
respond_to?answers for both names. An unknown field still raisesNoMethodError, and a method the walker defines still wins, sincemethod_missingnever sees it.