refactor(plugins): share small AST helper utilities #1754
+151
−111
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| export type AstRecord = { | ||
| type: string; | ||
| start?: number; | ||
| end?: number; | ||
| [key: string]: unknown; | ||
| }; | ||
|
|
||
| export type AstRange = AstRecord & { | ||
| start: number; | ||
| end: number; | ||
| }; | ||
|
|
||
| const SKIP_CHILD_KEYS = new Set(["type", "parent", "loc", "start", "end"]); | ||
|
|
||
| function getObjectProperty(value: unknown, key: string): unknown { | ||
| if (typeof value !== "object" || value === null) return null; | ||
| return Reflect.get(value, key); | ||
| } | ||
|
|
||
| export function isAstRecord(value: unknown): value is AstRecord { | ||
| return typeof getObjectProperty(value, "type") === "string"; | ||
| } | ||
|
|
||
| function toAstRecord(value: unknown): AstRecord | null { | ||
| return isAstRecord(value) ? value : null; | ||
| } | ||
|
|
||
| export function nodeArray(value: unknown): unknown[] { | ||
| return Array.isArray(value) ? value : []; | ||
| } | ||
|
|
||
| export function hasRange(node: AstRecord | null): node is AstRange { | ||
| return node !== null && typeof node.start === "number" && typeof node.end === "number"; | ||
| } | ||
|
|
||
| export function isIdentifierNamed(value: unknown, name: string): boolean { | ||
| return isAstRecord(value) && value.type === "Identifier" && value.name === name; | ||
| } | ||
|
|
||
| export function getAstName(value: unknown): string | null { | ||
|
Contributor
There was a problem hiding this comment.
|
||
| const node = toAstRecord(value); | ||
| if (!node) return null; | ||
| if (node.type === "Identifier" && typeof node.name === "string") return node.name; | ||
| if (typeof node.value === "string") return node.value; | ||
| return null; | ||
| } | ||
|
|
||
| export function forEachAstChild(node: AstRecord, callback: (child: AstRecord) => void): void { | ||
| for (const [key, value] of Object.entries(node)) { | ||
| if (SKIP_CHILD_KEYS.has(key)) continue; | ||
| const child = toAstRecord(value); | ||
| if (child) { | ||
| callback(child); | ||
| continue; | ||
| } | ||
| if (Array.isArray(value)) { | ||
| for (const item of value) { | ||
| const itemNode = toAstRecord(item); | ||
| if (itemNode) callback(itemNode); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export function collectBindingNames(pattern: unknown, target: Set<string>): void { | ||
| const node = toAstRecord(pattern); | ||
| if (!node) return; | ||
|
|
||
| switch (node.type) { | ||
| case "Identifier": | ||
| if (typeof node.name === "string") target.add(node.name); | ||
| return; | ||
| case "RestElement": | ||
| collectBindingNames(node.argument, target); | ||
| return; | ||
| case "AssignmentPattern": | ||
| collectBindingNames(node.left, target); | ||
| return; | ||
| case "ArrayPattern": | ||
| for (const element of nodeArray(node.elements)) collectBindingNames(element, target); | ||
| return; | ||
| case "ObjectPattern": | ||
| for (const property of nodeArray(node.properties)) { | ||
| const propertyNode = toAstRecord(property); | ||
| if (!propertyNode) continue; | ||
| collectBindingNames( | ||
| propertyNode.type === "Property" ? propertyNode.value : propertyNode.argument, | ||
| target, | ||
| ); | ||
| } | ||
| return; | ||
| case "Property": | ||
| collectBindingNames(node.value, target); | ||
| return; | ||
| } | ||
| } | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optional: the old inline walkers in
import-meta-url.tsskipped onlytype/start/end/locand did not skipparent. Addingparenthere is a safe, defensive change (avoids cycles if aparentbackref ever exists), but it is a behavioral difference worth a short comment so the intent is clear, e.g.// skip backrefs + positional metadata.