eslint-plugin-react-x 1.26.3-beta.2 → 1.26.3-beta.20

package/dist/index.js

@@ -1,7 +1,7 @@
 'use strict';
 
-var JSX7 = require('@eslint-react/jsx');
 var shared = require('@eslint-react/shared');
+var JSX7 = require('@eslint-react/jsx');
 var AST11 = require('@eslint-react/ast');
 var core = require('@eslint-react/core');
 var eff = require('@eslint-react/eff');
@@ -40,9 +40,104 @@ var AST11__namespace = /*#__PURE__*/_interopNamespace(AST11);
 var VAR__namespace = /*#__PURE__*/_interopNamespace(VAR);
 var ts__default = /*#__PURE__*/_interopDefault(ts);
 
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name5 in all)
+    __defProp(target, name5, { get: all[name5], enumerable: true });
+};
+
+// src/configs/recommended.ts
+var recommended_exports = {};
+__export(recommended_exports, {
+  name: () => name,
+  rules: () => rules,
+  settings: () => settings
+});
+var name = "react-x/recommended";
+var rules = {
+  "react-x/ensure-forward-ref-using-ref": "warn",
+  "react-x/no-access-state-in-setstate": "error",
+  "react-x/no-array-index-key": "warn",
+  "react-x/no-children-count": "warn",
+  "react-x/no-children-for-each": "warn",
+  "react-x/no-children-map": "warn",
+  "react-x/no-children-only": "warn",
+  "react-x/no-children-to-array": "warn",
+  "react-x/no-clone-element": "warn",
+  "react-x/no-comment-textnodes": "warn",
+  "react-x/no-component-will-mount": "error",
+  "react-x/no-component-will-receive-props": "error",
+  "react-x/no-component-will-update": "error",
+  "react-x/no-context-provider": "warn",
+  "react-x/no-create-ref": "error",
+  "react-x/no-default-props": "error",
+  "react-x/no-direct-mutation-state": "error",
+  "react-x/no-duplicate-jsx-props": "warn",
+  "react-x/no-duplicate-key": "warn",
+  "react-x/no-forward-ref": "warn",
+  "react-x/no-implicit-key": "warn",
+  "react-x/no-missing-key": "error",
+  "react-x/no-nested-components": "error",
+  "react-x/no-prop-types": "error",
+  "react-x/no-redundant-should-component-update": "error",
+  "react-x/no-set-state-in-component-did-mount": "warn",
+  "react-x/no-set-state-in-component-did-update": "warn",
+  "react-x/no-set-state-in-component-will-update": "warn",
+  "react-x/no-string-refs": "error",
+  "react-x/no-unsafe-component-will-mount": "warn",
+  "react-x/no-unsafe-component-will-receive-props": "warn",
+  "react-x/no-unsafe-component-will-update": "warn",
+  "react-x/no-unstable-context-value": "warn",
+  "react-x/no-unstable-default-props": "warn",
+  "react-x/no-unused-class-component-members": "warn",
+  "react-x/no-unused-state": "warn",
+  "react-x/no-use-context": "warn",
+  "react-x/use-jsx-vars": "warn"
+};
+var settings = {
+  "react-x": shared.DEFAULT_ESLINT_REACT_SETTINGS
+};
+
+// src/configs/recommended-type-checked.ts
+var recommended_type_checked_exports = {};
+__export(recommended_type_checked_exports, {
+  name: () => name3,
+  rules: () => rules3,
+  settings: () => settings3
+});
+
+// src/configs/recommended-typescript.ts
+var recommended_typescript_exports = {};
+__export(recommended_typescript_exports, {
+  name: () => name2,
+  rules: () => rules2,
+  settings: () => settings2
+});
+var name2 = "react-x/recommended-typescript";
+var rules2 = {
+  ...rules,
+  "react-x/dom/no-unknown-property": "off",
+  "react-x/no-duplicate-jsx-props": "off",
+  "react-x/use-jsx-vars": "off"
+};
+var settings2 = {
+  ...settings
+};
+
+// src/configs/recommended-type-checked.ts
+var name3 = "react-x/recommended-type-checked";
+var rules3 = {
+  ...rules2,
+  "react-x/no-leaked-conditional-rendering": "warn"
+  // "react-x/prefer-read-only-props": "warn",
+};
+var settings3 = {
+  ...settings2
+};
+
 // package.json
-var name = "eslint-plugin-react-x";
-var version = "1.26.3-beta.2";
+var name4 = "eslint-plugin-react-x";
+var version = "1.26.3-beta.20";
 var createRule = shared.createRuleForPlugin("x");
 
 // src/utils/get-associated-tokens.ts
@@ -279,7 +374,7 @@ var no_access_state_in_setstate_default = createRule({
         if (setState == null || hasThisState) {
           return;
         }
-        if (!(node.init != null && AST11__namespace.isThisExpression(node.init) && node.id.type === types.AST_NODE_TYPES.ObjectPattern)) {
+        if (node.init == null || !AST11__namespace.isThisExpression(node.init) || node.id.type !== types.AST_NODE_TYPES.ObjectPattern) {
           return;
         }
         const hasState = node.id.properties.some(
@@ -313,8 +408,8 @@ var iteratorFunctionIndexParamPosition = /* @__PURE__ */ new Map([
   ["reduceRight", 2],
   ["some", 1]
 ]);
-function isReactChildrenMethod(name2) {
-  return reactChildrenMethod.some((method) => method === name2);
+function isReactChildrenMethod(name5) {
+  return reactChildrenMethod.some((method) => method === name5);
 }
 function isUsingReactChildren(node, context) {
   const { importSource = "react" } = shared.unsafeDecodeSettings(context.settings);
@@ -342,8 +437,8 @@ function getMapIndexParamName(node, context) {
   if (callee.property.type !== types.AST_NODE_TYPES.Identifier) {
     return eff._;
   }
-  const { name: name2 } = callee.property;
-  if (!iteratorFunctionIndexParamPosition.has(name2)) {
+  const { name: name5 } = callee.property;
+  if (!iteratorFunctionIndexParamPosition.has(name5)) {
     return eff._;
   }
   const callbackArg = node.arguments[isUsingReactChildren(node, context) ? 1 : 0];
@@ -354,7 +449,7 @@ function getMapIndexParamName(node, context) {
     return eff._;
   }
   const { params } = callbackArg;
-  const indexParamPosition = iteratorFunctionIndexParamPosition.get(name2);
+  const indexParamPosition = iteratorFunctionIndexParamPosition.get(name5);
   if (indexParamPosition == null) {
     return eff._;
   }
@@ -380,7 +475,7 @@ var no_array_index_key_default = createRule({
   create(context) {
     const indexParamNames = [];
     function isArrayIndex(node) {
-      return node.type === types.AST_NODE_TYPES.Identifier && indexParamNames.some((name2) => name2 != null && name2 === node.name);
+      return node.type === types.AST_NODE_TYPES.Identifier && indexParamNames.some((name5) => name5 != null && name5 === node.name);
     }
     function isCreateOrCloneElementCall(node) {
       return core.isCreateElementCall(node, context) || core.isCloneElementCall(node, context);
@@ -389,7 +484,7 @@ var no_array_index_key_default = createRule({
       switch (node.type) {
         // key={bar}
         case types.AST_NODE_TYPES.Identifier: {
-          if (indexParamNames.some((name2) => name2 != null && name2 === node.name)) {
+          if (indexParamNames.some((name5) => name5 != null && name5 === node.name)) {
             return [{
               messageId: "noArrayIndexKey",
               node
@@ -699,7 +794,7 @@ var no_class_component_default = createRule({
       ...listeners,
       "Program:exit"(node) {
         const components = ctx.getAllComponents(node);
-        for (const { name: name2 = "anonymous", node: component } of components.values()) {
+        for (const { name: name5 = "anonymous", node: component } of components.values()) {
           if (component.body.body.some((m) => core.isComponentDidCatch(m) || core.isGetDerivedStateFromError(m))) {
             continue;
           }
@@ -707,7 +802,7 @@ var no_class_component_default = createRule({
             messageId: "noClassComponent",
             node: component,
             data: {
-              name: name2
+              name: name5
             }
           });
         }
@@ -1025,8 +1120,8 @@ var no_context_provider_default = createRule({
     }
     return {
       JSXElement(node) {
-        const [name2, ...rest] = JSX7__namespace.getElementName(node).split(".").reverse();
-        if (name2 !== "Provider") return;
+        const [name5, ...rest] = JSX7__namespace.getElementName(node).split(".").reverse();
+        if (name5 !== "Provider") return;
         const contextName = rest.reverse().join(".");
         context.report({
           messageId: "noContextProvider",
@@ -1223,12 +1318,12 @@ var no_duplicate_jsx_props_default = createRule({
           if (attr.type === types.AST_NODE_TYPES.JSXSpreadAttribute) {
             continue;
           }
-          const name2 = attr.name.name;
-          if (typeof name2 !== "string") {
+          const name5 = attr.name.name;
+          if (typeof name5 !== "string") {
             continue;
           }
-          if (!props.includes(name2)) {
-            props.push(name2);
+          if (!props.includes(name5)) {
+            props.push(name5);
             continue;
           }
           context.report({
@@ -1693,8 +1788,8 @@ var no_missing_key_default = createRule({
       [Symbol.for("rule_features")]: RULE_FEATURES29
     },
     messages: {
-      noMissingKey: "Missing 'key' for element when rendering list.",
-      noMissingKeyWithFragment: "Use fragment component instead of '<>' because it does not support `key`."
+      missingKey: "Missing 'key' for element when rendering list.",
+      unexpectedFragmentSyntax: "Use fragment component instead of '<>' because it does not support `key`."
     },
     schema: []
   },
@@ -1707,7 +1802,7 @@ var no_missing_key_default = createRule({
           const initialScope = context.sourceCode.getScope(node);
           if (!JSX7__namespace.hasAttribute("key", node.openingElement.attributes, initialScope)) {
             return {
-              messageId: "noMissingKey",
+              messageId: "missingKey",
               node
             };
           }
@@ -1715,7 +1810,7 @@ var no_missing_key_default = createRule({
         }
         case types.AST_NODE_TYPES.JSXFragment: {
           return {
-            messageId: "noMissingKeyWithFragment",
+            messageId: "unexpectedFragmentSyntax",
             node
           };
         }
@@ -1768,7 +1863,7 @@ var no_missing_key_default = createRule({
         for (const element of elements) {
           if (!JSX7__namespace.hasAttribute("key", element.openingElement.attributes, initialScope)) {
             context.report({
-              messageId: "noMissingKey",
+              messageId: "missingKey",
               node: element
             });
           }
@@ -1810,7 +1905,7 @@ var no_missing_key_default = createRule({
         }
         if (node.parent.type === types.AST_NODE_TYPES.ArrayExpression) {
           context.report({
-            messageId: "noMissingKeyWithFragment",
+            messageId: "unexpectedFragmentSyntax",
             node
           });
         }
@@ -1860,11 +1955,11 @@ var no_nested_components_default = createRule({
         const isClassComponent11 = (node2) => {
           return AST11__namespace.isClass(node2) && classComponents.some((component) => component.node === node2);
         };
-        for (const { name: name2, node: component } of functionComponents) {
+        for (const { name: name5, node: component } of functionComponents) {
           if (core.isDirectValueOfRenderPropertyLoose(component)) {
             continue;
           }
-          if (name2 === eff._) {
+          if (name5 === eff._) {
             continue;
           }
           const isInsideProperty = component.parent.type === types.AST_NODE_TYPES.Property;
@@ -1875,7 +1970,7 @@ var no_nested_components_default = createRule({
                 messageId: "nestedComponentInProps",
                 node: component,
                 data: {
-                  name: name2
+                  name: name5
                 }
               });
             }
@@ -1886,19 +1981,19 @@ var no_nested_components_default = createRule({
               messageId: "nestedComponentInProps",
               node: component,
               data: {
-                name: name2
+                name: name5
               }
             });
             continue;
           }
           const parentComponent = AST11__namespace.findParentNode(component, isFunctionComponent);
-          const isParnetComponentNotDirectValueOfRenderProperty = parentComponent != null && !core.isDirectValueOfRenderPropertyLoose(parentComponent);
-          if (isParnetComponentNotDirectValueOfRenderProperty) {
+          const isParentComponentNotDirectValueOfRenderProperty = parentComponent != null && !core.isDirectValueOfRenderPropertyLoose(parentComponent);
+          if (isParentComponentNotDirectValueOfRenderProperty) {
             context.report({
               messageId: isInsideProperty ? "nestedComponentInProps" : "nestedComponent",
               node: component,
               data: {
-                name: name2
+                name: name5
               }
             });
             continue;
@@ -1908,12 +2003,12 @@ var no_nested_components_default = createRule({
               messageId: "nestedComponent",
               node: component,
               data: {
-                name: name2
+                name: name5
               }
             });
           }
         }
-        for (const { name: name2 = "unknown", node: component } of classComponents) {
+        for (const { name: name5 = "unknown", node: component } of classComponents) {
           if (AST11__namespace.findParentNode(component, (n) => isClassComponent11(n) || isFunctionComponent(n)) == null) {
             continue;
           }
@@ -1921,7 +2016,7 @@ var no_nested_components_default = createRule({
             messageId: "nestedComponent",
             node: component,
             data: {
-              name: name2
+              name: name5
             }
           });
         }
@@ -2014,7 +2109,7 @@ var no_redundant_should_component_update_default = createRule({
       ...listeners,
       "Program:exit"(node) {
         const components = ctx.getAllComponents(node);
-        for (const { name: name2 = "PureComponent", node: component, flag } of components.values()) {
+        for (const { name: name5 = "PureComponent", node: component, flag } of components.values()) {
           if ((flag & core.ERComponentFlag.PureComponent) === 0n) {
             continue;
           }
@@ -2025,7 +2120,7 @@ var no_redundant_should_component_update_default = createRule({
                 messageId: "noRedundantShouldComponentUpdate",
                 node: member,
                 data: {
-                  componentName: name2
+                  componentName: name5
                 }
               });
             }
@@ -2364,9 +2459,7 @@ var no_unstable_context_value_default = createRule({
       [Symbol.for("rule_features")]: RULE_FEATURES40
     },
     messages: {
-      noUnstableContextValue: "A/an '{{type}}' passed as the value prop to the context provider should not be constructed. It will change on every render.",
-      noUnstableContextValueWithFunction: "A/an '{{type}}' passed as the value prop to the context provider should not be constructed. It will change on every render. Consider wrapping it in a useCallback hook.",
-      noUnstableContextValueWithIdentifier: "A/an '{{type}}' passed as the value prop to the context provider should not be constructed. It will change on every render. Consider wrapping it in a useMemo hook."
+      unstableContextValue: "A/an '{{type}}' passed as the value prop to the context provider should not be constructed. It will change on every render. {{suggestion}}"
     },
     schema: []
   },
@@ -2406,12 +2499,13 @@ var no_unstable_context_value_default = createRule({
         for (const { node: component } of components) {
           for (const construction of constructions.get(component) ?? []) {
             const { kind, node: constructionNode } = construction;
-            const messageId = kind.startsWith("Function") ? "noUnstableContextValueWithFunction" : "noUnstableContextValueWithIdentifier";
+            const suggestion = kind.startsWith("Function") ? "Consider wrapping it in a useCallback hook." : "Consider wrapping it in a useMemo hook.";
             context.report({
-              messageId,
+              messageId: "unstableContextValue",
               node: constructionNode,
               data: {
-                type: AST11__namespace.toReadableNodeType(constructionNode)
+                type: AST11__namespace.toReadableNodeType(constructionNode),
+                suggestion
               }
             });
           }
@@ -2451,8 +2545,8 @@ var no_unstable_default_props_default = createRule({
           if (props == null) {
             continue;
           }
-          const properties = tsPattern.match(props).with({ type: types.AST_NODE_TYPES.ObjectPattern }, ({ properties: properties2 }) => properties2).with({ type: types.AST_NODE_TYPES.Identifier }, ({ name: name2 }) => {
-            return declarators.get(component)?.filter((d) => d.init.name === name2).flatMap((d) => d.id.properties) ?? [];
+          const properties = tsPattern.match(props).with({ type: types.AST_NODE_TYPES.ObjectPattern }, ({ properties: properties2 }) => properties2).with({ type: types.AST_NODE_TYPES.Identifier }, ({ name: name5 }) => {
+            return declarators.get(component)?.filter((d) => d.init.name === name5).flatMap((d) => d.id.properties) ?? [];
           }).otherwise(() => []);
           for (const prop of properties) {
             if (prop.type !== types.AST_NODE_TYPES.Property || prop.value.type !== types.AST_NODE_TYPES.AssignmentPattern) {
@@ -2810,7 +2904,7 @@ var no_unused_state_default = createRule({
         if (!currentClass.body.body.includes(currentMethod)) {
           return;
         }
-        if (!(node.init != null && AST11__namespace.isThisExpression(node.init) && node.id.type === types.AST_NODE_TYPES.ObjectPattern)) {
+        if (node.init == null || !AST11__namespace.isThisExpression(node.init) || node.id.type !== types.AST_NODE_TYPES.ObjectPattern) {
           return;
         }
         const hasState = node.id.properties.some((prop) => {
@@ -2850,9 +2944,9 @@ var no_use_context_default = createRule({
   name: RULE_NAME44,
   create(context) {
     if (!context.sourceCode.text.includes("useContext")) return {};
-    const settings = shared.getSettingsFromContext(context);
+    const settings4 = shared.getSettingsFromContext(context);
     const useContextAlias = /* @__PURE__ */ new Set();
-    if (compareVersions.compare(settings.version, "19.0.0", "<")) {
+    if (compareVersions.compare(settings4.version, "19.0.0", "<")) {
       return {};
     }
     return {
@@ -2878,7 +2972,7 @@ var no_use_context_default = createRule({
         });
       },
       ImportDeclaration(node) {
-        if (node.source.value !== settings.importSource) {
+        if (node.source.value !== settings4.importSource) {
           return;
         }
         const isUseImported = node.specifiers.some(tsPattern.isMatching({ local: { type: types.AST_NODE_TYPES.Identifier, name: "use" } }));
@@ -2927,7 +3021,7 @@ function trimLikeReact(text) {
 }
 function checkAndReport(node, context, allowExpressions) {
   function fix(fixer) {
-    if (!(node.parent.type === types.AST_NODE_TYPES.JSXElement || node.parent.type === types.AST_NODE_TYPES.JSXFragment)) {
+    if (node.parent.type !== types.AST_NODE_TYPES.JSXElement && node.parent.type !== types.AST_NODE_TYPES.JSXFragment) {
       if (node.children.length === 0) {
         return null;
       }
@@ -2950,10 +3044,24 @@ function checkAndReport(node, context, allowExpressions) {
     return;
   }
   if (JSX7__namespace.isBuiltInElement(node.parent)) {
-    context.report({ messageId: "noUselessFragmentInBuiltIn", node, fix });
+    context.report({
+      messageId: "uselessFragment",
+      node,
+      data: {
+        reason: "placed inside a built-in component"
+      },
+      fix
+    });
   }
   if (node.children.length === 0) {
-    context.report({ messageId: "noUselessFragment", node, fix });
+    context.report({
+      messageId: "uselessFragment",
+      node,
+      data: {
+        reason: "contains less than two children"
+      },
+      fix
+    });
     return;
   }
   const isChildElement = AST11__namespace.isOneOf([types.AST_NODE_TYPES.JSXElement, types.AST_NODE_TYPES.JSXFragment])(node.parent);
@@ -2964,11 +3072,25 @@ function checkAndReport(node, context, allowExpressions) {
     }
     // <Foo><>hello, world</></Foo>
     case (!allowExpressions && isChildElement): {
-      context.report({ messageId: "noUselessFragment", node, fix });
+      context.report({
+        messageId: "uselessFragment",
+        node,
+        data: {
+          reason: "contains less than two children"
+        },
+        fix
+      });
       return;
     }
     case (!allowExpressions && !isChildElement && node.children.length === 1): {
-      context.report({ messageId: "noUselessFragment", node, fix });
+      context.report({
+        messageId: "uselessFragment",
+        node,
+        data: {
+          reason: "contains less than two children"
+        },
+        fix
+      });
       return;
     }
   }
@@ -2977,7 +3099,14 @@ function checkAndReport(node, context, allowExpressions) {
   switch (true) {
     case nonPaddingChildren.length === 0:
     case (nonPaddingChildren.length === 1 && firstNonPaddingChild?.type !== types.AST_NODE_TYPES.JSXExpressionContainer): {
-      context.report({ messageId: "noUselessFragment", node, fix });
+      context.report({
+        messageId: "uselessFragment",
+        node,
+        data: {
+          reason: "contains less than two children"
+        },
+        fix
+      });
       return;
     }
   }
@@ -2988,12 +3117,11 @@ var no_useless_fragment_default = createRule({
     type: "problem",
     defaultOptions: [...defaultOptions],
     docs: {
-      description: "disallow unnecessary fragments"
+      description: "disallow useless fragments"
     },
     fixable: "code",
     messages: {
-      noUselessFragment: "A fragment contains less than two children is unnecessary.",
-      noUselessFragmentInBuiltIn: "A fragment placed inside a built-in component is unnecessary."
+      uselessFragment: "A fragment {{reason}} is useless."
     },
     schema: [{
       type: "object",
@@ -3299,7 +3427,7 @@ var use_jsx_vars_default = createRule({
   meta: {
     type: "problem",
     docs: {
-      description: "helpes `eslint/no-unused-vars` to correctly mark JSX variables as used.",
+      description: "marks variables used in JSX as used",
       [Symbol.for("rule_features")]: RULE_FEATURES50
     },
     messages: {
@@ -3333,10 +3461,10 @@ var use_jsx_vars_default = createRule({
   defaultOptions: []
 });
 
-// src/index.ts
-var index_default = {
+// src/plugin.ts
+var plugin = {
   meta: {
-    name,
+    name: name4,
     version
   },
   rules: {
@@ -3401,4 +3529,31 @@ var index_default = {
   }
 };
 
+// src/index.ts
+function makeConfig(config) {
+  return {
+    ...config,
+    plugins: {
+      "react-x": plugin
+    }
+  };
+}
+function makeLegacyConfig({ rules: rules4 }) {
+  return {
+    plugins: ["react-x"],
+    rules: rules4
+  };
+}
+var index_default = {
+  ...plugin,
+  configs: {
+    ["recommended"]: makeConfig(recommended_exports),
+    ["recommended-legacy"]: makeLegacyConfig(recommended_exports),
+    ["recommended-type-checked"]: makeConfig(recommended_type_checked_exports),
+    ["recommended-type-checked-legacy"]: makeLegacyConfig(recommended_type_checked_exports),
+    ["recommended-typescript"]: makeConfig(recommended_typescript_exports),
+    ["recommended-typescript-legacy"]: makeLegacyConfig(recommended_typescript_exports)
+  }
+};
+
 module.exports = index_default;