eslint-plugin-react-x 2.0.5-beta.2 → 2.0.5-beta.6

package/dist/index.js

@@ -6,7 +6,7 @@ import { P, isMatching, match } from "ts-pattern";
 import ts from "typescript";
 import * as AST from "@eslint-react/ast";
 import { ConstructionDetectionHint, findVariable, getChildScopes, getConstruction, getVariableDefinitionNode } from "@eslint-react/var";
-import { ComponentDetectionHint, ComponentFlag, DEFAULT_COMPONENT_DETECTION_HINT, JsxEmit, findParentJsxAttribute, getInstanceId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, hasJsxAttribute, isAssignmentToThisState, isCaptureOwnerStackCall, isChildrenCount, isChildrenForEach, isChildrenMap, isChildrenOnly, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElementCall, isComponentDidCatch, isComponentDidMount, isComponentDidUpdate, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUpdate, isCreateContextCall, isCreateElementCall, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRefCall, isGetDerivedStateFromError, isGetDerivedStateFromProps, isInitializedFromReact, isInstanceIdEqual, isJsxFragmentElement, isJsxHostElement, isJsxText, isLazyCall, isReactHookCall, isReactHookName, isRenderMethodLike, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseCall, isUseCallbackCall, isUseContextCall, isUseMemoCall, isUseStateCall, useComponentCollector, useComponentCollectorLegacy, useHookCollector } from "@eslint-react/core";
+import { ComponentDetectionHint, ComponentFlag, DEFAULT_COMPONENT_DETECTION_HINT, JsxEmit, findParentJsxAttribute, getInstanceId, getJsxAttribute, getJsxAttributeName, getJsxConfigFromAnnotation, getJsxConfigFromContext, getJsxElementType, isAssignmentToThisState, isCaptureOwnerStackCall, isChildrenCount, isChildrenForEach, isChildrenMap, isChildrenOnly, isChildrenToArray, isChildrenToArrayCall, isClassComponent, isCloneElementCall, isComponentDidCatch, isComponentDidMount, isComponentDidUpdate, isComponentNameLoose, isComponentWillMount, isComponentWillReceiveProps, isComponentWillUpdate, isCreateContextCall, isCreateElementCall, isCreateRefCall, isDeclaredInRenderPropLoose, isDirectValueOfRenderPropertyLoose, isForwardRefCall, isGetDerivedStateFromError, isGetDerivedStateFromProps, isInitializedFromReact, isInstanceIdEqual, isJsxFragmentElement, isJsxHostElement, isJsxText, isLazyCall, isReactHookCall, isReactHookName, isRenderMethodLike, isThisSetState, isUnsafeComponentWillMount, isUnsafeComponentWillReceiveProps, isUnsafeComponentWillUpdate, isUseCall, isUseCallbackCall, isUseContextCall, isUseMemoCall, isUseStateCall, useComponentCollector, useComponentCollectorLegacy, useHookCollector } from "@eslint-react/core";
 import { report, toRegExp } from "@eslint-react/kit";
 import { constFalse, constTrue, flow, getOrElseUpdate, identity, unit } from "@eslint-react/eff";
 import { compare } from "compare-versions";
@@ -115,7 +115,7 @@ const settings = { ...settings$1 };
 //#endregion
 //#region package.json
 var name = "eslint-plugin-react-x";
-var version = "2.0.5-beta.2";
+var version = "2.0.5-beta.6";
 
 //#endregion
 //#region src/utils/create-rule.ts
@@ -208,10 +208,10 @@ var jsx_key_before_spread_default = createRule({
 	meta: {
 		type: "problem",
 		docs: {
-			description: "Enforces that the 'key' attribute is placed before the spread attribute in JSX elements.",
+			description: "Enforces that the 'key' prop is placed before the spread prop in JSX elements.",
 			[Symbol.for("rule_features")]: RULE_FEATURES$59
 		},
-		messages: { jsxKeyBeforeSpread: "The 'key' attribute must be placed before the spread attribute." },
+		messages: { jsxKeyBeforeSpread: "The 'key' prop must be placed before any spread props." },
 		schema: []
 	},
 	name: RULE_NAME$61,
@@ -220,16 +220,16 @@ var jsx_key_before_spread_default = createRule({
 });
 function create$61(context) {
 	return { JSXOpeningElement(node) {
-		let firstSpreadAttributeIndex = null;
-		for (const [index, attr] of node.attributes.entries()) {
-			if (attr.type === AST_NODE_TYPES.JSXSpreadAttribute) {
-				firstSpreadAttributeIndex ??= index;
+		let firstSpreadPropIndex = null;
+		for (const [index, prop] of node.attributes.entries()) {
+			if (prop.type === AST_NODE_TYPES.JSXSpreadAttribute) {
+				firstSpreadPropIndex ??= index;
 				continue;
 			}
-			if (firstSpreadAttributeIndex == null) continue;
-			if (attr.name.name === "key" && index > firstSpreadAttributeIndex) context.report({
+			if (firstSpreadPropIndex == null) continue;
+			if (prop.name.name === "key" && index > firstSpreadPropIndex) context.report({
 				messageId: "jsxKeyBeforeSpread",
-				node: attr
+				node: prop
 			});
 		}
 	} };
@@ -262,7 +262,6 @@ function create$60(context) {
 	const visitorFunction = (node) => {
 		if (!AST.isOneOf([AST_NODE_TYPES.JSXElement, AST_NODE_TYPES.JSXFragment])(node.parent)) return;
 		if (!hasCommentLike(node)) return;
-		if (!node.parent.type.includes("JSX")) return;
 		context.report({
 			messageId: "jsxNoCommentTextnodes",
 			node
@@ -905,7 +904,7 @@ var no_children_prop_default = createRule({
 });
 function create$46(context) {
 	return { JSXElement(node) {
-		const childrenProp = getJsxAttribute(context, node.openingElement.attributes, context.sourceCode.getScope(node))("children");
+		const childrenProp = getJsxAttribute(context, node)("children");
 		if (childrenProp != null) context.report({
 			messageId: "noChildrenProp",
 			node: childrenProp
@@ -1287,7 +1286,7 @@ var no_duplicate_key_default = createRule({
 	defaultOptions: []
 });
 function create$35(context) {
-	if (!context.sourceCode.getText().includes("key=")) return {};
+	if (!context.sourceCode.text.includes("key=")) return {};
 	const keyedEntries = /* @__PURE__ */ new Map();
 	function isKeyValueEqual(a, b) {
 		const aValue = a.value;
@@ -1452,11 +1451,11 @@ function create$33(context) {
 }
 /**
 * Determines whether the given CallExpression can be safely auto-fixed by replacing
-* the usage of `forwardRef` with passing `ref` as a prop.
+* the usage of `forwardRef` with passing `ref` as a prop
 *
-* @param context - The rule context object.
-* @param node - The CallExpression node to check.
-* @returns True if the call can be auto-fixed, false otherwise.
+* @param context - The rule context object
+* @param node - The CallExpression node to check
+* @returns True if the call can be auto-fixed, false otherwise
 */
 function canFix$1(context, node) {
 	const { importSource } = getSettingsFromContext(context);
@@ -1467,6 +1466,12 @@ function canFix$1(context, node) {
 		default: return false;
 	}
 }
+/**
+* Generates the fix for the `forwardRef` call
+* @param context - The rule context
+* @param node - The `forwardRef` call expression
+* @returns A fixer function that applies the changes
+*/
 function getFix$1(context, node) {
 	return (fixer) => {
 		const [componentNode] = node.arguments;
@@ -1478,6 +1483,14 @@ function getFix$1(context, node) {
 		];
 	};
 }
+/**
+* Generates fixes for the component's props and ref arguments
+* @param context - The rule context
+* @param fixer - The rule fixer
+* @param node - The function component node
+* @param typeArguments - The type arguments from the `forwardRef` call
+* @returns An array of fixes for the component's signature
+*/
 function getComponentPropsFixes(context, fixer, node, typeArguments) {
 	const getText = (node$1) => context.sourceCode.getText(node$1);
 	const [arg0, arg1] = node.params;
@@ -1534,8 +1547,7 @@ var no_implicit_key_default = createRule({
 });
 function create$32(context) {
 	return { JSXOpeningElement(node) {
-		const initialScope = context.sourceCode.getScope(node);
-		const keyProp = getJsxAttribute(context, node.attributes, initialScope)("key");
+		const keyProp = getJsxAttribute(context, node.parent)("key");
 		const isKeyPropOnElement = node.attributes.some((n) => n.type === AST_NODE_TYPES.JSXAttribute && n.name.type === AST_NODE_TYPES.JSXIdentifier && n.name.name === "key");
 		if (keyProp != null && !isKeyPropOnElement) context.report({
 			messageId: "noImplicitKey",
@@ -1578,6 +1590,11 @@ function create$31(context) {
 		...compare(version$1, "18.0.0", "<") ? [] : ["string", "falsy string"]
 	];
 	const services = ESLintUtils.getParserServices(context, false);
+	/**
+	* Recursively inspects a node to find potential leaked conditional rendering
+	* @param node The AST node to inspect
+	* @returns A report descriptor if a problem is found, otherwise `unit`
+	*/
 	function getReportDescriptor(node) {
 		if (node == null) return unit;
 		if (AST.is(AST_NODE_TYPES.JSXExpressionContainer)(node)) return getReportDescriptor(node.expression);
@@ -1751,14 +1768,12 @@ function create$28(context) {
 	const state = { isWithinChildrenToArray: false };
 	function checkIteratorElement(node) {
 		switch (node.type) {
-			case AST_NODE_TYPES.JSXElement: {
-				const initialScope = context.sourceCode.getScope(node);
-				if (!hasJsxAttribute(context, "key", node.openingElement.attributes, initialScope)) return {
+			case AST_NODE_TYPES.JSXElement:
+				if (getJsxAttribute(context, node)("key") == null) return {
 					messageId: "missingKey",
 					node
 				};
 				return null;
-			}
 			case AST_NODE_TYPES.JSXFragment: return {
 				messageId: "unexpectedFragmentSyntax",
 				node
@@ -1794,7 +1809,7 @@ function create$28(context) {
 			const elements = node.elements.filter(AST.is(AST_NODE_TYPES.JSXElement));
 			if (elements.length === 0) return;
 			const initialScope = context.sourceCode.getScope(node);
-			for (const element of elements) if (!hasJsxAttribute(context, "key", element.openingElement.attributes, initialScope)) context.report({
+			for (const element of elements) if (getJsxAttribute(context, element, initialScope)("key") == null) context.report({
 				messageId: "missingKey",
 				node: element
 			});
@@ -1838,8 +1853,8 @@ var no_misused_capture_owner_stack_default = createRule({
 		},
 		fixable: "code",
 		messages: {
-			useNamespaceImport: "Don't use named imports of 'captureOwnerStack' in files that are bundled for development and production. Use a namespace import instead.",
-			missingDevelopmentOnlyCheck: `Don't call 'captureOwnerStack' directly. Use 'if (process.env.NODE_ENV !== "production") {...}' to conditionally access it.`
+			missingDevelopmentOnlyCheck: `Don't call 'captureOwnerStack' directly. Use 'if (process.env.NODE_ENV !== "production") {...}' to conditionally access it.`,
+			useNamespaceImport: "Don't use named imports of 'captureOwnerStack' in files that are bundled for development and production. Use a namespace import instead."
 		},
 		schema: []
 	},
@@ -1980,28 +1995,19 @@ function isInsideJSXAttributeValue(node) {
 	return node.parent.type === AST_NODE_TYPES.JSXAttribute || findParentJsxAttribute(node, (n) => n.value?.type === AST_NODE_TYPES.JSXExpressionContainer) != null;
 }
 /**
-* Check whether given node is declared inside class component's render block
-* ```tsx
-* class Component extends React.Component {
-*   render() {
-*     class NestedClassComponent extends React.Component {
-*      render() { return <div />; }
-*     }
-*     const nestedFunctionComponent = () => <div />;
-*  }
-* }
-* ```
+* Checks whether a given node is declared inside a class component's render block
+* Ex: class C extends React.Component { render() { const Nested = () => <div />; } }
 * @param node The AST node being checked
-* @returns `true` if node is inside class component's render block, `false` if not
+* @returns `true` if the node is inside a class component's render block
 */
 function isInsideRenderMethod(node) {
 	return AST.findParentNode(node, (n) => isRenderMethodLike(n) && isClassComponent(n.parent.parent)) != null;
 }
 /**
-* Determines whether inside `createElement`'s props.
+* Determines whether the node is inside `createElement`'s props argument
 * @param context The rule context
 * @param node The AST node to check
-* @returns `true` if the node is inside createElement's props
+* @returns `true` if the node is inside `createElement`'s props
 */
 function isInsideCreateElementProps(context, node) {
 	const call = AST.findParentNode(node, isCreateElementCall(context));
@@ -2166,12 +2172,12 @@ function create$22(context) {
 	if (!context.sourceCode.text.includes("componentDidMount")) return {};
 	return { CallExpression(node) {
 		if (!isThisSetState(node)) return;
-		const clazz = AST.findParentNode(node, isClassComponent);
-		const method = AST.findParentNode(node, (n) => n === clazz || isComponentDidMount(n));
-		if (clazz == null || method == null || method === clazz) return;
-		const methodScope = context.sourceCode.getScope(method);
-		const upperScope = context.sourceCode.getScope(node).upper;
-		if (method.parent === clazz.body && upperScope === methodScope) context.report({
+		const enclosingClassNode = AST.findParentNode(node, isClassComponent);
+		const enclosingMethodNode = AST.findParentNode(node, (n) => n === enclosingClassNode || isComponentDidMount(n));
+		if (enclosingClassNode == null || enclosingMethodNode == null || enclosingMethodNode === enclosingClassNode) return;
+		const enclosingMethodScope = context.sourceCode.getScope(enclosingMethodNode);
+		const setStateCallParentScope = context.sourceCode.getScope(node).upper;
+		if (enclosingMethodNode.parent === enclosingClassNode.body && setStateCallParentScope === enclosingMethodScope) context.report({
 			messageId: "noSetStateInComponentDidMount",
 			node
 		});
@@ -2200,12 +2206,12 @@ function create$21(context) {
 	if (!context.sourceCode.text.includes("componentDidUpdate")) return {};
 	return { CallExpression(node) {
 		if (!isThisSetState(node)) return;
-		const clazz = AST.findParentNode(node, isClassComponent);
-		const method = AST.findParentNode(node, (n) => n === clazz || isComponentDidUpdate(n));
-		if (clazz == null || method == null || method === clazz) return;
-		const methodScope = context.sourceCode.getScope(method);
-		const upperScope = context.sourceCode.getScope(node).upper;
-		if (method.parent === clazz.body && upperScope === methodScope) context.report({
+		const enclosingClassNode = AST.findParentNode(node, isClassComponent);
+		const enclosingMethodNode = AST.findParentNode(node, (n) => n === enclosingClassNode || isComponentDidUpdate(n));
+		if (enclosingClassNode == null || enclosingMethodNode == null || enclosingMethodNode === enclosingClassNode) return;
+		const enclosingMethodScope = context.sourceCode.getScope(enclosingMethodNode);
+		const setStateCallParentScope = context.sourceCode.getScope(node).upper;
+		if (enclosingMethodNode.parent === enclosingClassNode.body && setStateCallParentScope === enclosingMethodScope) context.report({
 			messageId: "noSetStateInComponentDidUpdate",
 			node
 		});
@@ -2220,7 +2226,7 @@ var no_set_state_in_component_will_update_default = createRule({
 	meta: {
 		type: "problem",
 		docs: {
-			description: "Disallows calling `this.setState` in `componentWillUpdate` outside of functions, such as callbacks.",
+			description: "Disallow calling `this.setState` in `componentWillUpdate` outside of functions, such as callbacks.",
 			[Symbol.for("rule_features")]: RULE_FEATURES$19
 		},
 		messages: { noSetStateInComponentWillUpdate: "Do not call `this.setState` in `componentWillUpdate` outside of functions, such as callbacks." },
@@ -2234,12 +2240,12 @@ function create$20(context) {
 	if (!context.sourceCode.text.includes("componentWillUpdate")) return {};
 	return { CallExpression(node) {
 		if (!isThisSetState(node)) return;
-		const clazz = AST.findParentNode(node, isClassComponent);
-		const method = AST.findParentNode(node, (n) => n === clazz || isComponentWillUpdate(n));
-		if (clazz == null || method == null || method === clazz) return;
-		const methodScope = context.sourceCode.getScope(method);
-		const upperScope = context.sourceCode.getScope(node).upper;
-		if (method.parent === clazz.body && upperScope === methodScope) context.report({
+		const enclosingClassNode = AST.findParentNode(node, isClassComponent);
+		const enclosingMethodNode = AST.findParentNode(node, (n) => n === enclosingClassNode || isComponentWillUpdate(n));
+		if (enclosingClassNode == null || enclosingMethodNode == null || enclosingMethodNode === enclosingClassNode) return;
+		const enclosingMethodScope = context.sourceCode.getScope(enclosingMethodNode);
+		const setStateCallParentScope = context.sourceCode.getScope(node).upper;
+		if (enclosingMethodNode.parent === enclosingClassNode.body && setStateCallParentScope === enclosingMethodScope) context.report({
 			messageId: "noSetStateInComponentWillUpdate",
 			node
 		});
@@ -2278,21 +2284,27 @@ function create$19(context) {
 		"ClassBody:exit": onClassBodyExit,
 		JSXAttribute(node) {
 			if (node.name.name !== "ref") return;
-			const refNameText = getAttributeValueText(context, node.value);
-			if (refNameText == null) return;
+			const refName = getJsxAttributeValueText(context, node.value);
+			if (refName == null) return;
 			context.report({
 				messageId: "noStringRefs",
 				node,
 				fix(fixer) {
 					if (node.value == null) return null;
 					if (!state.isWithinClassComponent) return null;
-					return fixer.replaceText(node.value, `{(ref) => { this.refs[${refNameText}] = ref; }}`);
+					return fixer.replaceText(node.value, `{(ref) => { this.refs[${refName}] = ref; }}`);
 				}
 			});
 		}
 	};
 }
-function getAttributeValueText(context, node) {
+/**
+* Extracts the text content from a JSX attribute's value
+* @param context - The rule context
+* @param node - The JSX attribute value node
+* @returns The text of the attribute value, or null if not a string-like value
+*/
+function getJsxAttributeValueText(context, node) {
 	if (node == null) return null;
 	switch (true) {
 		case node.type === AST_NODE_TYPES.Literal && typeof node.value === "string": return context.sourceCode.getText(node);
@@ -2339,6 +2351,11 @@ function create$18(context) {
 		});
 	} };
 }
+/**
+* Checks if a node is a callback function passed to an array's `.map()` method
+* @param node The node to check
+* @returns `true` if the node is a map callback, `false` otherwise
+*/
 function isMapCallback(node) {
 	if (node.parent == null) return false;
 	if (!AST.isArrayMapCall(node.parent)) return false;
@@ -2784,7 +2801,7 @@ function create$9(context) {
 		for (const def of defs) {
 			const methodName = AST.getPropertyName(def);
 			if (methodName == null) continue;
-			if (usages?.has(methodName) || LIFECYCLE_METHODS.has(methodName)) continue;
+			if ((usages?.has(methodName) ?? false) || LIFECYCLE_METHODS.has(methodName)) continue;
 			context.report({
 				messageId: "noUnusedClassComponentMembers",
 				node: def,
@@ -3266,8 +3283,7 @@ function trimLikeReact(text) {
 * Check if a fragment node is useless and should be reported
 */
 function checkNode(context, node, allowExpressions) {
-	const initialScope = context.sourceCode.getScope(node);
-	if (node.type === AST_NODE_TYPES.JSXElement && hasJsxAttribute(context, "key", node.openingElement.attributes, initialScope)) return;
+	if (node.type === AST_NODE_TYPES.JSXElement && getJsxAttribute(context, node)("key") != null) return;
 	if (isJsxHostElement(context, node.parent)) context.report({
 		messageId: "uselessFragment",
 		node,
@@ -3312,9 +3328,6 @@ function checkNode(context, node, allowExpressions) {
 		fix: getFix(context, node)
 	});
 }
-/**
-* Generate fix for removing useless fragment
-*/
 function getFix(context, node) {
 	if (!canFix(context, node)) return null;
 	return (fixer) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-react-x",
-  "version": "2.0.5-beta.2",
+  "version": "2.0.5-beta.6",
   "description": "A set of composable ESLint rules for for libraries and frameworks that use React as a UI runtime.",
   "keywords": [
     "react",
@@ -43,16 +43,16 @@
     "string-ts": "^2.2.1",
     "ts-api-utils": "^2.1.0",
     "ts-pattern": "^5.8.0",
-    "@eslint-react/core": "2.0.5-beta.2",
-    "@eslint-react/ast": "2.0.5-beta.2",
-    "@eslint-react/eff": "2.0.5-beta.2",
-    "@eslint-react/kit": "2.0.5-beta.2",
-    "@eslint-react/shared": "2.0.5-beta.2",
-    "@eslint-react/var": "2.0.5-beta.2"
+    "@eslint-react/ast": "2.0.5-beta.6",
+    "@eslint-react/core": "2.0.5-beta.6",
+    "@eslint-react/eff": "2.0.5-beta.6",
+    "@eslint-react/kit": "2.0.5-beta.6",
+    "@eslint-react/shared": "2.0.5-beta.6",
+    "@eslint-react/var": "2.0.5-beta.6"
   },
   "devDependencies": {
-    "@types/react": "^19.1.16",
-    "@types/react-dom": "^19.1.9",
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
     "tsdown": "^0.15.6",
     "@local/configs": "0.0.0"
   },