import { ruleTester } from "@local/testkit";
import { createJSXElementResolver } from "./create-jsx-element-resolver";
import { createRule } from "./create-rule";
const RULE_NAME = "jsx-element-resolver-test";
function resolved(domElementType: string, jsxElementType: string) {
return JSON.stringify({ domElementType, jsxElementType });
}
// A pass-through rule that reports the resolver output as JSON on every JSX element
const testRule = createRule<[], "default">({
meta: {
type: "problem",
docs: {
description: "Test rule that reports the resolved element types as JSON.",
},
messages: {
default: "{{data}}",
},
schema: [],
},
name: RULE_NAME,
create(context) {
const resolver = createJSXElementResolver(context);
return {
JSXElement(node) {
context.report({
data: { data: JSON.stringify(resolver.resolve(node)) },
messageId: "default",
node,
});
},
};
},
defaultOptions: [],
});
ruleTester.run(RULE_NAME, testRule, {
invalid: [
// Host element: lowercase identifier resolves to itself
{
code: "
;",
errors: [{ data: { data: resolved("div", "div") }, messageId: "default" }],
},
// Host element with a hyphen (custom element)
{
code: ";",
errors: [{ data: { data: resolved("custom-element", "custom-element") }, messageId: "default" }],
},
// Boundary: uppercase tag is a component per React semantics, not a host element
{
code: ";",
errors: [{ data: { data: resolved("DIV", "DIV") }, messageId: "default" }],
},
// Boundary: the polymorphic prop on a host element is ignored
{
code: ';',
errors: [{ data: { data: resolved("div", "div") }, messageId: "default" }],
},
// Spread props are not resolved: the polymorphic prop must be a direct attribute
{
code: ';',
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
{
code: 'const props = { as: "button" }; ;',
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
// A direct polymorphic prop takes precedence even when a spread is placed after it
{
code: ';',
errors: [{ data: { data: resolved("div", "Box") }, messageId: "default" }],
},
// ... and when it is placed after the spread
{
code: ';',
errors: [{ data: { data: resolved("div", "Box") }, messageId: "default" }],
},
// Member expression without a polymorphic prop keeps its full name
{
code: ";",
errors: [{ data: { data: resolved("motion.iframe", "motion.iframe") }, messageId: "default" }],
},
// Member expression resolves via the polymorphic prop (ex: motion.div)
{
code: ';',
errors: [{ data: { data: resolved("iframe", "motion.div") }, messageId: "default" }],
},
// Namespaced name is treated as a component
{
code: ";",
errors: [{ data: { data: resolved("svg:rect", "svg:rect") }, messageId: "default" }],
},
// Polymorphic component with a string value (default polymorphicPropName is 'as')
{
code: ';',
errors: [{ data: { data: resolved("a", "Box") }, messageId: "default" }],
},
// Uppercase polymorphic prop value is normalized to lowercase
{
code: ';',
errors: [{ data: { data: resolved("a", "Box") }, messageId: "default" }],
},
// Statically evaluable expression container
{
code: ';',
errors: [{ data: { data: resolved("a", "Box") }, messageId: "default" }],
},
// Uppercase string in an expression container is normalized to lowercase
{
code: ';',
errors: [{ data: { data: resolved("iframe", "Box") }, messageId: "default" }],
},
// Boundary: a non-string static value (number) falls back to the element name
{
code: ";",
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
// Boolean polymorphic prop falls back to the element name
{
code: ";",
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
// Component reference cannot be resolved statically (documented limitation)
{
code: ";",
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
// Non-static expression falls back to the element name
{
code: ';',
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
},
// Custom polymorphicPropName setting
{
code: ';',
errors: [{ data: { data: resolved("span", "Box") }, messageId: "default" }],
settings: {
"react-x": {
polymorphicPropName: "component",
},
},
},
// With a custom polymorphicPropName, 'as' is just an ordinary prop
{
code: ';',
errors: [{ data: { data: resolved("Box", "Box") }, messageId: "default" }],
settings: {
"react-x": {
polymorphicPropName: "component",
},
},
},
],
valid: [],
});