fix: Use updated types from @eslint/core

[nzakas]

Prerequisites checklist

• I have read the contributing guidelines.

What is the purpose of this pull request?

Update the plugin to use the latest types from @eslint/core.

What changes did you make? (Give an overview)

• Added types.ts files to define types.
• Updated rules to use RuleDefinition type
• Updated JSONLanguage to use IJSONLanguage type
• Updated JSONSourceCode to use IJSONSourceCode type

Related Issues

Is there anything you'd like reviewers to focus on?

The types test fails with this, and I don't understand why. The project builds just fine. Maybe @fasttime can take a look?

[nzakas]

RuleModule is eslint is not compatible with RuleDefinition, so need to comment this out for now. I'll work on updating the types in eslint next.

[fasttime]

It looks like the type tests are failing because the strict option is not compatible with the @eslint/core types:

json/tests/types/tsconfig.json

Line 6 in a6c0bc9

"strict": true

We could remove that option for the moment since it's only used in the tests. In the long term I think it would be good to make sure that the @eslint/core types are strict compliant, so they can be used by TS projects with that option enabled. As I said in a previous comment, I don't think it's necessary to enable strict mode for the whole rewrite repo.

[nzakas]

It looks like the type tests are failing because the strict option is not compatible with the @eslint/core types

Can you explain what the compatibility issue is? And why does running tsc on the project build fine but the type tests fails?

[fasttime]

Can you explain what the compatibility issue is?

The issue is in the definition of RuleVisitor in @eslint/core:

export interface RuleVisitor {
	/**
	 * Called for each node in the AST or at specific times during the traversal.
	 */
	[key: string]: (...args: any[]) => void;
}

from https://github.com/eslint/rewrite/blob/3591a7805a060cb130d40d61f200431b782431d8/packages/core/src/types.ts#L102-L107

When the TypeScript strict option is set (or strictNullChecks more specifically) it's no longer possible to assign null or undefined to a property of the RuleVisitorInterface, or to extend it with an optional method (where the value can be a function or undefined).

For example:

let ruleVisitor: RuleVisitor = {};
ruleVisitor.foo = undefined; // Error with strictNullChecks, else OK

interface Bar extends RuleVisitor {
    bar?(): void; // Error with strictNullChecks, else OK
}

• Demo with strictNullChecks: true
• Demo with strictNullChecks: false

The JSONRuleVisitor interface extends RuleVisitor but also defines optional methods, that's why it fails to compile with the strict option.

json/src/types.ts

Lines 58 to 84 in fdde59d

	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;
	}

It's possible that there are more incompatibilities in the core types but in this is the only one that's causing troubles with this PR. I tried manually changing the RuleVisitor interface to accept optional methods and then all type tests passed:

export type RuleVisitor = {
    /**
     * Called for each node in the AST or at specific times during the traversal.
     */
-   [key: string]: (...args: any[]) => void;
+   [key in string]?: (...args: any[]) => void;
};

And why does running tsc on the project build fine but the type tests fails?

Because the strict option is only enabled in tests/types/tsconfig.json (the config for type tests), not in the root tsconfig.json which is used for building.

[nzakas]

Ah! That is very helpful, thank you.

I think we should change RuleVisitor, then, as I've run into other problems caused by this.