Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
64 changes: 36 additions & 28 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@ import type {
} from "@humanwhocodes/momoa";
import type { JSONLanguageOptions, JSONSourceCode } from "./index.js";

//------------------------------------------------------------------------------
// Helpers
//------------------------------------------------------------------------------

/** Adds matching `:exit` selectors for all properties of a `RuleVisitor`. */
type WithExit<RuleVisitorType extends RuleVisitor> = {

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.

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

//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
Expand All @@ -41,36 +52,33 @@ type ValueNodeParent = DocumentNode | MemberNode | ElementNode;
*/
export type JSONSyntaxElement = Token | AnyNode;

type JSONNodeVisitor = {
Array?: ((node: ArrayNode, parent: ValueNodeParent) => void) | undefined;
Boolean?:
| ((node: BooleanNode, parent: ValueNodeParent) => void)
| undefined;
Document?: ((node: DocumentNode) => void) | undefined;
Element?: ((node: ElementNode, parent: ArrayNode) => void) | undefined;
Identifier?:
| ((node: IdentifierNode, parent: MemberNode) => void)
| undefined;
Infinity?:
| ((node: InfinityNode, parent: ValueNodeParent) => void)
| undefined;
Member?: ((node: MemberNode, parent: ObjectNode) => void) | undefined;
NaN?: ((node: NaNNode, parent: ValueNodeParent) => void) | undefined;
Null?: ((node: NullNode, parent: ValueNodeParent) => void) | undefined;
Number?: ((node: NumberNode, parent: ValueNodeParent) => void) | undefined;
Object?: ((node: ObjectNode, parent: ValueNodeParent) => void) | undefined;
String?: ((node: StringNode, parent: ValueNodeParent) => void) | undefined;
};

/**
* 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<JSONNodeVisitor> {}

export type JSONRuleDefinitionTypeOptions = CustomRuleTypeDefinitions;

Expand All @@ -81,7 +89,7 @@ export type JSONRuleDefinition<
LangOptions: JSONLanguageOptions;
Code: JSONSourceCode;
Visitor: JSONRuleVisitor;
Node: AnyNode;
Node: JSONSyntaxElement;
},
Options
>;
3 changes: 3 additions & 0 deletions tests/types/types.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ json.configs.recommended.plugins satisfies object;
"Object:exit": (...args) => testVisitor<ObjectNode>(...args),
String: (...args) => testVisitor<StringNode>(...args),
"String:exit": (...args) => testVisitor<StringNode>(...args),

// Unknown selectors allowed
"Identifier[name=foo]"(node: IdentifierNode, parent: MemberNode) {},

Choose a reason for hiding this comment

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

Same as in the other PR, please add additional test cases for this.

};
},
});
Expand Down