Skip to content

fix: correct parent typing for rule visitors #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: correct parent typing for rule visitors #172

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18d6399
refactor: simplify `JSONRuleVisitor`
jaymarvelz Oct 25, 2025
68a17c9
chore: clean up test visitor function
jaymarvelz Oct 25, 2025
0224229
fix: correct parent typing for rule visitors
jaymarvelz Oct 29, 2025
39c2698
test: add more test cases
jaymarvelz Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 18 additions & 29 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,19 @@ import type {
import type { JSONLanguageOptions, JSONSourceCode } from "./index.js";

//------------------------------------------------------------------------------
// Types
// Helpers
//------------------------------------------------------------------------------

type ValueNodeParent = DocumentNode | MemberNode | ElementNode;
/** Adds matching `:exit` selectors for all properties of a `RuleVisitor`. */
type WithExit<RuleVisitorType extends RuleVisitor> = {
Copy link

@DMartens DMartens Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be a shared helper from @eslint/core as all ESLint languages require it.

Copy link
Author

@jaymarvelz jaymarvelz Nov 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened eslint/rewrite#318

[Key in keyof RuleVisitorType as
| Key
| `${Key & string}:exit`]: RuleVisitorType[Key];
};

//------------------------------------------------------------------------------
// Exports
//------------------------------------------------------------------------------

/**
* A JSON syntax element, including nodes and tokens.
Expand All @@ -44,33 +53,13 @@ export type JSONSyntaxElement = Token | AnyNode;
/**
* The visitor format returned from rules in this package.
*/
export interface JSONRuleVisitor extends RuleVisitor {
Document?(node: DocumentNode): void;
Member?(node: MemberNode, parent?: ObjectNode): void;
Element?(node: ElementNode, parent?: ArrayNode): void;
Object?(node: ObjectNode, parent?: ValueNodeParent): void;
Array?(node: ArrayNode, parent?: ValueNodeParent): void;
String?(node: StringNode, parent?: ValueNodeParent): void;
Null?(node: NullNode, parent?: ValueNodeParent): void;
Number?(node: NumberNode, parent?: ValueNodeParent): void;
Boolean?(node: BooleanNode, parent?: ValueNodeParent): void;
NaN?(node: NaNNode, parent?: ValueNodeParent): void;
Infinity?(node: InfinityNode, parent?: ValueNodeParent): void;
Identifier?(node: IdentifierNode, parent?: ValueNodeParent): void;

"Document:exit"?(node: DocumentNode): void;
"Member:exit"?(node: MemberNode, parent?: ObjectNode): void;
"Element:exit"?(node: ElementNode, parent?: ArrayNode): void;
"Object:exit"?(node: ObjectNode, parent?: ValueNodeParent): void;
"Array:exit"?(node: ArrayNode, parent?: ValueNodeParent): void;
"String:exit"?(node: StringNode, parent?: ValueNodeParent): void;
"Null:exit"?(node: NullNode, parent?: ValueNodeParent): void;
"Number:exit"?(node: NumberNode, parent?: ValueNodeParent): void;
"Boolean:exit"?(node: BooleanNode, parent?: ValueNodeParent): void;
"NaN:exit"?(node: NaNNode, parent?: ValueNodeParent): void;
"Infinity:exit"?(node: InfinityNode, parent?: ValueNodeParent): void;
"Identifier:exit"?(node: IdentifierNode, parent?: ValueNodeParent): void;
}
export interface JSONRuleVisitor
extends RuleVisitor,
WithExit<{
[Node in AnyNode as Node["type"]]?:
| ((node: Node) => void)
| undefined;
}> {}

export type JSONRuleDefinitionTypeOptions = CustomRuleTypeDefinitions;

Expand Down
62 changes: 28 additions & 34 deletions tests/types/types.test.ts
View file
Open in desktop
Copy link
Member

@lumirlumir lumirlumir Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests currently pass even when I revert the changes in types.ts.

Could we add tests that fail if the change is reverted so we can verify the before-and-after behavior?

Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,7 @@ json.configs.recommended.plugins satisfies object;
sourceCode.lines satisfies string[];
sourceCode.text satisfies string;

function testVisitor<NodeType extends AnyNode>(
node: NodeType,
parent?:
| DocumentNode
| MemberNode
| ElementNode
| ArrayNode
| ObjectNode,
) {
function testVisitor<NodeType extends AnyNode>(node: NodeType) {
sourceCode.getLoc(node) satisfies SourceLocation;
sourceCode.getLocFromIndex(0) satisfies {
line: number;
Expand All @@ -100,31 +92,33 @@ json.configs.recommended.plugins satisfies object;
}

return {
Array: (...args) => testVisitor<ArrayNode>(...args),
"Array:exit": (...args) => testVisitor<ArrayNode>(...args),
Boolean: (...args) => testVisitor<BooleanNode>(...args),
"Boolean:exit": (...args) => testVisitor<BooleanNode>(...args),
Document: (...args) => testVisitor<DocumentNode>(...args),
"Document:exit": (...args) => testVisitor<DocumentNode>(...args),
Element: (...args) => testVisitor<ElementNode>(...args),
"Element:exit": (...args) => testVisitor<ElementNode>(...args),
Identifier: (...args) => testVisitor<IdentifierNode>(...args),
"Identifier:exit": (...args) =>
testVisitor<IdentifierNode>(...args),
Infinity: (...args) => testVisitor<InfinityNode>(...args),
"Infinity:exit": (...args) => testVisitor<InfinityNode>(...args),
Member: (...args) => testVisitor<MemberNode>(...args),
"Member:exit": (...args) => testVisitor<MemberNode>(...args),
NaN: (...args) => testVisitor<NaNNode>(...args),
"NaN:exit": (...args) => testVisitor<NaNNode>(...args),
Null: (...args) => testVisitor<NullNode>(...args),
"Null:exit": (...args) => testVisitor<NullNode>(...args),
Number: (...args) => testVisitor<NumberNode>(...args),
"Number:exit": (...args) => testVisitor<NumberNode>(...args),
Object: (...args) => testVisitor<ObjectNode>(...args),
"Object:exit": (...args) => testVisitor<ObjectNode>(...args),
String: (...args) => testVisitor<StringNode>(...args),
"String:exit": (...args) => testVisitor<StringNode>(...args),
Array: node => testVisitor<ArrayNode>(node),
"Array:exit": node => testVisitor<ArrayNode>(node),
Boolean: node => testVisitor<BooleanNode>(node),
"Boolean:exit": node => testVisitor<BooleanNode>(node),
Document: node => testVisitor<DocumentNode>(node),
"Document:exit": node => testVisitor<DocumentNode>(node),
Element: node => testVisitor<ElementNode>(node),
"Element:exit": node => testVisitor<ElementNode>(node),
Identifier: node => testVisitor<IdentifierNode>(node),
"Identifier:exit": node => testVisitor<IdentifierNode>(node),
Infinity: node => testVisitor<InfinityNode>(node),
"Infinity:exit": node => testVisitor<InfinityNode>(node),
Member: node => testVisitor<MemberNode>(node),
"Member:exit": node => testVisitor<MemberNode>(node),
NaN: node => testVisitor<NaNNode>(node),
"NaN:exit": node => testVisitor<NaNNode>(node),
Null: node => testVisitor<NullNode>(node),
"Null:exit": node => testVisitor<NullNode>(node),
Number: node => testVisitor<NumberNode>(node),
"Number:exit": node => testVisitor<NumberNode>(node),
Object: node => testVisitor<ObjectNode>(node),
"Object:exit": node => testVisitor<ObjectNode>(node),
String: node => testVisitor<StringNode>(node),
"String:exit": node => testVisitor<StringNode>(node),

// Unknown selectors allowed
"Identifier[name=foo]"(node) {},
};
},
});
Expand Down