eslint-plugin-react-x 5.17.3 → 5.18.0

package/dist/index.js

@@ -12,6 +12,7 @@ import { compare } from "compare-versions";
 import { P, isMatching, match } from "ts-pattern";
 import { getConstrainedTypeAtLocation } from "@typescript-eslint/type-utils";
 import { unionConstituents } from "ts-api-utils";
+import "typescript";
 import { simpleTraverse } from "@typescript-eslint/typescript-estree";
 import { delimiterCase, snakeCase, toLowerCase } from "string-ts";
 
@@ -144,7 +145,7 @@ const rules$6 = {
 //#endregion
 //#region package.json
 var name$6 = "eslint-plugin-react-x";
-var version = "5.17.3";
+var version = "5.18.0";
 
 //#endregion
 //#region src/utils/create-rule.ts
@@ -1391,7 +1392,8 @@ function isInitializedFromCall(context, node, isCall) {
 	return init.type === AST_NODE_TYPES.CallExpression && isCall(init);
 }
 function isInitializedFromUseRef(context, node) {
-	return isInitializedFromCall(context, node, (init) => core.isUseRefCall(context, init));
+	const { additionalRefHooks } = getSettingsFromContext(context);
+	return isInitializedFromCall(context, node, (init) => core.isUseRefLikeCall(init, additionalRefHooks));
 }
 function isKnownNonMutatingMethodCall(context, node) {
 	const callee = Extract.unwrap(node.callee);
@@ -2377,6 +2379,42 @@ function buildFixForComponentProps(context, fixer, node, typeArguments) {
 	].join(" ")), ...arg1 == null ? [] : [fixer.remove(arg1), fixer.removeRange([arg0.range[1], arg1.range[0]])]];
 }
 
+//#endregion
+//#region src/utils/create-implicit-prop-listener.ts
+/**
+* Creates a listener that detects JSX spread attributes implicitly passing a given prop
+* (ex: 'children', 'key', 'ref') to a component.
+*
+* For each union constituent of the spread argument's type, the prop is reported unless:
+* 1. The prop symbol's fully qualified name is allowed (pass-through of React internally defined props)
+* 2. The fully qualified name of the prop's type symbol (or its alias) is allowed (React type aliases)
+*
+* @param context The ESLint rule context
+* @param options The prop name, the allow-list predicates (receive lowercased fully qualified names), and the report callback
+* @param options.name The name of the prop to detect
+* @param options.isAllowedProp A predicate that receives the prop symbol's lowercased fully qualified name and returns `true` if it is allowed
+* @param options.isAllowedType A predicate that receives the prop's type symbol's lowercased fully qualified name and returns `true` if it is allowed
+* @param options.onImplicitProp A callback invoked with the spread attribute node when an implicit prop is detected
+* @returns A rule listener reporting on JSX spread attributes
+*/
+function createImplicitPropListener(context, options) {
+	const { name, isAllowedProp, isAllowedType, onImplicitProp } = options;
+	const services = ESLintUtils.getParserServices(context, false);
+	const checker = services.program.getTypeChecker();
+	const getFqn = (symbol) => core.getFullyQualifiedNameEx(checker, symbol).toLowerCase();
+	return { JSXSpreadAttribute(node) {
+		for (const type of unionConstituents(getConstrainedTypeAtLocation(services, node.argument))) {
+			const prop = type.getProperty(name);
+			if (prop == null) continue;
+			if (isAllowedProp(getFqn(prop))) continue;
+			const propType = checker.getTypeOfSymbol(prop);
+			const propTypeSymbol = propType.aliasSymbol ?? propType.symbol;
+			if (propTypeSymbol != null && isAllowedType(getFqn(propTypeSymbol))) continue;
+			onImplicitProp(node);
+		}
+	} };
+}
+
 //#endregion
 //#region src/rules/no-implicit-children/no-implicit-children.ts
 const RULE_NAME$30 = "no-implicit-children";
@@ -2393,26 +2431,17 @@ var no_implicit_children_default = createRule({
 	defaultOptions: []
 });
 function create$30(context) {
-	const services = ESLintUtils.getParserServices(context, false);
-	const checker = services.program.getTypeChecker();
-	return { JSXSpreadAttribute(node) {
-		for (const type of unionConstituents(getConstrainedTypeAtLocation(services, node.argument))) {
-			const children = type.getProperty("children");
-			if (children == null) continue;
-			const fqn = core.getFullyQualifiedNameEx(checker, children).toLowerCase();
-			if (fqn.endsWith("attributes.children") || fqn.endsWith("propswithchildren.children")) continue;
-			const childrenType = checker.getTypeOfSymbol(children);
-			const typeSymbol = childrenType.aliasSymbol ?? childrenType.symbol;
-			if (typeSymbol != null) {
-				const typeFqn = checker.getFullyQualifiedName(typeSymbol);
-				if (RE_REACT_CHILDREN_TYPE.test(typeFqn) || /^JSX\.Element$/i.test(typeFqn)) continue;
-			}
+	return createImplicitPropListener(context, {
+		name: "children",
+		isAllowedProp: (fqn) => fqn.endsWith("attributes.children") || fqn.endsWith("propswithchildren.children"),
+		isAllowedType: (fqn) => RE_REACT_CHILDREN_TYPE.test(fqn) || fqn === "jsx.element",
+		onImplicitProp(node) {
 			context.report({
 				messageId: "default",
 				node
 			});
 		}
-	} };
+	});
 }
 
 //#endregion
@@ -2430,23 +2459,17 @@ var no_implicit_key_default = createRule({
 	defaultOptions: []
 });
 function create$29(context) {
-	const services = ESLintUtils.getParserServices(context, false);
-	const checker = services.program.getTypeChecker();
-	return { JSXSpreadAttribute(node) {
-		for (const type of unionConstituents(getConstrainedTypeAtLocation(services, node.argument))) {
-			const key = type.getProperty("key");
-			if (key == null) continue;
-			if (core.getFullyQualifiedNameEx(checker, key).toLowerCase().endsWith("react.attributes.key")) continue;
-			const keyType = checker.getTypeOfSymbol(key);
-			if (keyType.aliasSymbol != null) {
-				if (checker.getFullyQualifiedName(keyType.aliasSymbol).toLowerCase().endsWith("react.key")) continue;
-			}
+	return createImplicitPropListener(context, {
+		name: "key",
+		isAllowedProp: (fqn) => fqn.endsWith("react.attributes.key"),
+		isAllowedType: (fqn) => fqn.endsWith("react.key"),
+		onImplicitProp(node) {
 			context.report({
 				messageId: "default",
 				node
 			});
 		}
-	} };
+	});
 }
 
 //#endregion
@@ -2465,25 +2488,17 @@ var no_implicit_ref_default = createRule({
 	defaultOptions: []
 });
 function create$28(context) {
-	const services = ESLintUtils.getParserServices(context, false);
-	const checker = services.program.getTypeChecker();
-	return { JSXSpreadAttribute(node) {
-		for (const type of unionConstituents(getConstrainedTypeAtLocation(services, node.argument))) {
-			const ref = type.getProperty("ref");
-			if (ref == null) continue;
-			if (core.getFullyQualifiedNameEx(checker, ref).toLowerCase().endsWith("attributes.ref")) continue;
-			const refType = checker.getTypeOfSymbol(ref);
-			const typeSymbol = refType.aliasSymbol ?? refType.symbol;
-			if (typeSymbol != null) {
-				const typeFqn = checker.getFullyQualifiedName(typeSymbol);
-				if (RE_REACT_REF_TYPE.test(typeFqn)) continue;
-			}
+	return createImplicitPropListener(context, {
+		name: "ref",
+		isAllowedProp: (fqn) => fqn.endsWith("attributes.ref"),
+		isAllowedType: (fqn) => RE_REACT_REF_TYPE.test(fqn),
+		onImplicitProp(node) {
 			context.report({
 				messageId: "default",
 				node
 			});
 		}
-	} };
+	});
 }
 
 //#endregion
@@ -4682,6 +4697,7 @@ const SYNC_ARRAY_CALLBACKS = /* @__PURE__ */ new Set([
 	"sort"
 ]);
 function createBindingResolver(context) {
+	const { additionalRefHooks } = getSettingsFromContext(context);
 	const bindings = /* @__PURE__ */ new Map();
 	const memberBindings = /* @__PURE__ */ new Map();
 	const jsxRefs = /* @__PURE__ */ new Set();
@@ -4701,7 +4717,7 @@ function createBindingResolver(context) {
 			kind: "function",
 			node: value
 		};
-		if (value.type === AST_NODE_TYPES.CallExpression && (core.isUseRefCall(context, value) || core.isCreateRefCall(context, value))) return { kind: "ref" };
+		if (value.type === AST_NODE_TYPES.CallExpression && (core.isUseRefLikeCall(value, additionalRefHooks) || core.isCreateRefCall(context, value))) return { kind: "ref" };
 		if (value.type === AST_NODE_TYPES.MemberExpression && value.property.type === AST_NODE_TYPES.Identifier) {
 			if (isRefLikeName(value.property.name)) return { kind: "ref" };
 		}
@@ -7344,6 +7360,7 @@ function isHookDecl(node) {
 	return name != null && core.isHookName(name);
 }
 function isInitializedFromRef(context, name, initialScope, seen = /* @__PURE__ */ new Set()) {
+	const { additionalRefHooks } = getSettingsFromContext(context);
 	if (seen.has(name)) return false;
 	seen.add(name);
 	for (const { node } of findVariable(initialScope, name)?.defs ?? []) {
@@ -7352,7 +7369,7 @@ function isInitializedFromRef(context, name, initialScope, seen = /* @__PURE__ *
 		if (init == null) continue;
 		switch (true) {
 			case init.type === AST_NODE_TYPES.MemberExpression && init.object.type === AST_NODE_TYPES.Identifier && (init.object.name === "ref" || init.object.name.endsWith("Ref")): return true;
-			case init.type === AST_NODE_TYPES.CallExpression && core.isUseRefCall(context, init): return true;
+			case init.type === AST_NODE_TYPES.CallExpression && core.isUseRefLikeCall(init, additionalRefHooks): return true;
 			case init.type === AST_NODE_TYPES.CallExpression: return getNestedIdentifiers(init).some((id) => isInitializedFromRef(context, id.name, context.sourceCode.getScope(id), seen));
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-x",
-  "version": "5.17.3",
+  "version": "5.18.0",
   "description": "A set of composable ESLint rules for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
     "react",
@@ -36,30 +36,30 @@
     "dist"
   ],
   "dependencies": {
-    "@typescript-eslint/scope-manager": "^8.64.0",
-    "@typescript-eslint/type-utils": "^8.64.0",
-    "@typescript-eslint/types": "^8.64.0",
-    "@typescript-eslint/typescript-estree": "^8.64.0",
-    "@typescript-eslint/utils": "^8.64.0",
+    "@typescript-eslint/scope-manager": "^8.65.0",
+    "@typescript-eslint/type-utils": "^8.65.0",
+    "@typescript-eslint/types": "^8.65.0",
+    "@typescript-eslint/typescript-estree": "^8.65.0",
+    "@typescript-eslint/utils": "^8.65.0",
     "compare-versions": "^6.1.1",
     "string-ts": "^2.3.1",
     "ts-api-utils": "^2.5.0",
     "ts-pattern": "^5.9.0",
-    "@eslint-react/ast": "5.17.3",
-    "@eslint-react/eslint": "5.17.3",
-    "@eslint-react/jsx": "5.17.3",
-    "@eslint-react/core": "5.17.3",
-    "@eslint-react/shared": "5.17.3",
-    "@eslint-react/var": "5.17.3"
+    "@eslint-react/ast": "5.18.0",
+    "@eslint-react/eslint": "5.18.0",
+    "@eslint-react/core": "5.18.0",
+    "@eslint-react/jsx": "5.18.0",
+    "@eslint-react/shared": "5.18.0",
+    "@eslint-react/var": "5.18.0"
   },
   "devDependencies": {
     "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
     "dedent": "^1.7.2",
     "eslint": "^10.7.0",
-    "react": "^19.2.7",
-    "react-dom": "^19.2.7",
-    "tsdown": "^0.22.9",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "tsdown": "^0.22.13",
     "tsl": "^1.0.30",
     "tsl-dx": "^0.13.3",
     "typescript": "6.0.3",