fix(DataListCheck): reordered onChange params

packages/eslint-plugin-pf-codemods/lib/helpers.js

@@ -1,179 +1,228 @@
 function getPackageImports(context, packageName) {
-  return context.getSourceCode().ast.body
-    .filter(node => node.type === 'ImportDeclaration')
-    .filter(node => node.source.value === packageName)
-    .map(node => node.specifiers)
+  return context
+    .getSourceCode()
+    .ast.body.filter((node) => node.type === "ImportDeclaration")
+    .filter((node) => node.source.value === packageName)
+    .map((node) => node.specifiers)
     .reduce((acc, val) => acc.concat(val), []);
 }
 
 function renameProps0(context, imports, node, renames) {
-  if (imports.map(imp => imp.local.name).includes(node.name.name)) {
-    const renamedProps = renames[node.name.name] || renames[
-      imports.find(imp => imp.local?.name === node.name.name)?.imported?.name
-    ];
+  if (imports.map((imp) => imp.local.name).includes(node.name.name)) {
+    const renamedProps =
+      renames[node.name.name] ||
+      renames[
+        imports.find((imp) => imp.local?.name === node.name.name)?.imported
+          ?.name
+      ];
     node.attributes
-      .filter(attribute => attribute.name && renamedProps.hasOwnProperty(attribute.name.name))
-      .forEach(attribute => {
-        if (renamedProps[attribute.name.name] === '') {
+      .filter(
+        (attribute) =>
+          attribute.name && renamedProps.hasOwnProperty(attribute.name.name)
+      )
+      .forEach((attribute) => {
+        if (renamedProps[attribute.name.name] === "") {
           context.report({
             node,
             message: `${attribute.name.name} prop for ${node.name.name} has been removed`,
             fix(fixer) {
-              return fixer.replaceText(attribute, '');
-            }
+              return fixer.replaceText(attribute, "");
+            },
           });
-        }
-        else {
+        } else {
           context.report({
             node,
-            message: `${attribute.name.name} prop for ${node.name.name} has been renamed to ${renamedProps[attribute.name.name]}`,
+            message: `${attribute.name.name} prop for ${
+              node.name.name
+            } has been renamed to ${renamedProps[attribute.name.name]}`,
             fix(fixer) {
-              return fixer.replaceText(attribute.name, renamedProps[attribute.name.name]);
-            }
+              return fixer.replaceText(
+                attribute.name,
+                renamedProps[attribute.name.name]
+              );
+            },
           });
         }
       });
   }
 }
 
-function renameProps(renames, packageName='@patternfly/react-core') {
-  return function(context) {
-    const imports = getPackageImports(context, packageName)
-      .filter(specifier => Object.keys(renames).includes(specifier.imported.name));
-
-    return imports.length === 0 ? {} : {
-      JSXOpeningElement(node) {
-        renameProps0(context, imports, node, renames);
-      }
-    };
-  }
+function renameProps(renames, packageName = "@patternfly/react-core") {
+  return function (context) {
+    const imports = getPackageImports(context, packageName).filter(
+      (specifier) => Object.keys(renames).includes(specifier.imported.name)
+    );
+
+    return imports.length === 0
+      ? {}
+      : {
+          JSXOpeningElement(node) {
+            renameProps0(context, imports, node, renames);
+          },
+        };
+  };
 }
 
-function renameProp(components, propMap, message, replaceAttribute, leaveComment = true) {
-  if (typeof components === 'string') {
-    components = [ components ];
+function renameProp(
+  components,
+  propMap,
+  message,
+  replaceAttribute,
+  leaveComment = true
+) {
+  if (typeof components === "string") {
+    components = [components];
   }
-  return function(context) {
-    const imports = getPackageImports(context, '@patternfly/react-core')
-      .filter(specifier => components.includes(specifier.imported.name));
-    return imports.length === 0 ? {} : {
-      JSXOpeningElement(node) {
-        if (imports.find(imp => imp.local.name === node.name.name)) {
-          const namedAttributes = node.attributes.filter(attr => attr.name);
+  return function (context) {
+    const imports = getPackageImports(context, "@patternfly/react-core").filter(
+      (specifier) => components.includes(specifier.imported.name)
+    );
+    return imports.length === 0
+      ? {}
+      : {
+          JSXOpeningElement(node) {
+            if (imports.find((imp) => imp.local.name === node.name.name)) {
+              const namedAttributes = node.attributes.filter(
+                (attr) => attr.name
+              );
 
-          namedAttributes.filter(attr => Object.keys(propMap).includes(attr.name.name))
-            .forEach(attribute => {
-              const newName = propMap[attribute.name.name];
-              context.report({
-                node,
-                message: message(node, attribute, newName),
-                fix(fixer) {
-                  // Delete entire prop if newName is empty
-                  if (!newName || replaceAttribute) {
-                    /** 
-                     * (dallas)
-                     * TODO: remove extra space? the following works but issues arise when attempting to remove multiple props.
-                     * i assume the ranges become invalid in the forEach loop? even though it seems to track attr correctly
-                     * (see datalist-remove-ondrags for example)
-                     * 
-                     * const tokenBefore = context.getSourceCode().getTokenBefore(attribute);
-                     * return fixer.replaceTextRange([tokenBefore.range[1], attribute.range[1]], '');
-                     * 
-                     * or
-                     * 
-                     * return fixer.replaceTextRange([attribute.range[0] - 1, attribute.range[1]], '');
-                     */
-                    return fixer.replaceText(attribute, newName);
-                  }
-                  const newNameAttrName = newName.split('=')[0];
-                  // Leave a comment if there's an existing prop with this name
-                  if (namedAttributes.find(attr => attr.name.name === newNameAttrName)) {
-                    return fixer.replaceText(attribute, leaveComment ? `/* ${newName} */` : '');
-                  }
-                  return fixer.replaceText(
-                    attribute.name,
-                    newName
-                  );
-                }
-              })
-            });
-        }
-      }
-    };
-  }
+              namedAttributes
+                .filter((attr) => Object.keys(propMap).includes(attr.name.name))
+                .forEach((attribute) => {
+                  const newName = propMap[attribute.name.name];
+                  context.report({
+                    node,
+                    message: message(node, attribute, newName),
+                    fix(fixer) {
+                      // Delete entire prop if newName is empty
+                      if (!newName || replaceAttribute) {
+                        /**
+                         * (dallas)
+                         * TODO: remove extra space? the following works but issues arise when attempting to remove multiple props.
+                         * i assume the ranges become invalid in the forEach loop? even though it seems to track attr correctly
+                         * (see datalist-remove-ondrags for example)
+                         *
+                         * const tokenBefore = context.getSourceCode().getTokenBefore(attribute);
+                         * return fixer.replaceTextRange([tokenBefore.range[1], attribute.range[1]], '');
+                         *
+                         * or
+                         *
+                         * return fixer.replaceTextRange([attribute.range[0] - 1, attribute.range[1]], '');
+                         */
+                        return fixer.replaceText(attribute, newName);
+                      }
+                      const newNameAttrName = newName.split("=")[0];
+                      // Leave a comment if there's an existing prop with this name
+                      if (
+                        namedAttributes.find(
+                          (attr) => attr.name.name === newNameAttrName
+                        )
+                      ) {
+                        return fixer.replaceText(
+                          attribute,
+                          leaveComment ? `/* ${newName} */` : ""
+                        );
+                      }
+                      return fixer.replaceText(attribute.name, newName);
+                    },
+                  });
+                });
+            }
+          },
+        };
+  };
 }
 
 function renameComponents(
   componentMap,
   condition = (_context, _package) => true,
-  message = (prevName, newName) => `${prevName} has been replaced with ${newName}`,
-  package = '@patternfly/react-core'
+  message = (prevName, newName) =>
+    `${prevName} has been replaced with ${newName}`,
+  package = "@patternfly/react-core"
 ) {
-  return function(context) {
-    const imports = getPackageImports(context, package)
-      .filter(specifier => Object.keys(componentMap).includes(specifier.imported.name));
-
-    return imports.length === 0 || !condition(context, package) ? {} : {
-      ImportDeclaration(node) {
-        ensureImports(context, node, package, Object.values(componentMap));
-      },
-      JSXIdentifier(node) {
-        const nodeName = node.name;
-        const importedNode = imports.find(imp => imp.local.name === nodeName);
-        if (
-          imports.find(imp => imp.imported.name === nodeName) &&
-          importedNode.imported.name === importedNode.local.name // don't rename an aliased component
-        ) {
-          // if data-codemods attribute, do nothing
-          const parentNode = node.parent;
-          const isOpeningTag = parentNode.type === 'JSXOpeningElement';
-          const openingTagAttributes = isOpeningTag ? parentNode.attributes : parentNode.parent.openingElement.attributes;
-          const hasDataAttr = openingTagAttributes && openingTagAttributes.filter(attr => attr.name?.name === 'data-codemods').length;
-          if (hasDataAttr) {
-            return;
-          }
-          // if no data-codemods && opening tag, add attribute & rename
-          // if no data-codemods && closing tag, rename
-          const newName = componentMap[nodeName];
-          const updateTagName = node => context.getSourceCode().getText(node).replace(nodeName, newName);
-          const addDataAttr = jsxStr => `${jsxStr.slice(0, -1)} data-codemods="true">`;
-          const newOpeningParentTag = newName.includes('Toolbar')
-            ? addDataAttr(updateTagName(parentNode))
-            : updateTagName(parentNode);
-          context.report({
-            node,
-            message: message(nodeName, newName),
-            fix(fixer) {
-              return isOpeningTag
-                ? fixer.replaceText(parentNode, newOpeningParentTag)
-                : fixer.replaceText(node, updateTagName(node));
+  return function (context) {
+    const imports = getPackageImports(context, package).filter((specifier) =>
+      Object.keys(componentMap).includes(specifier.imported.name)
+    );
+
+    return imports.length === 0 || !condition(context, package)
+      ? {}
+      : {
+          ImportDeclaration(node) {
+            ensureImports(context, node, package, Object.values(componentMap));
+          },
+          JSXIdentifier(node) {
+            const nodeName = node.name;
+            const importedNode = imports.find(
+              (imp) => imp.local.name === nodeName
+            );
+            if (
+              imports.find((imp) => imp.imported.name === nodeName) &&
+              importedNode.imported.name === importedNode.local.name // don't rename an aliased component
+            ) {
+              // if data-codemods attribute, do nothing
+              const parentNode = node.parent;
+              const isOpeningTag = parentNode.type === "JSXOpeningElement";
+              const openingTagAttributes = isOpeningTag
+                ? parentNode.attributes
+                : parentNode.parent.openingElement.attributes;
+              const hasDataAttr =
+                openingTagAttributes &&
+                openingTagAttributes.filter(
+                  (attr) => attr.name?.name === "data-codemods"
+                ).length;
+              if (hasDataAttr) {
+                return;
+              }
+              // if no data-codemods && opening tag, add attribute & rename
+              // if no data-codemods && closing tag, rename
+              const newName = componentMap[nodeName];
+              const updateTagName = (node) =>
+                context
+                  .getSourceCode()
+                  .getText(node)
+                  .replace(nodeName, newName);
+              const addDataAttr = (jsxStr) =>
+                `${jsxStr.slice(0, -1)} data-codemods="true">`;
+              const newOpeningParentTag = newName.includes("Toolbar")
+                ? addDataAttr(updateTagName(parentNode))
+                : updateTagName(parentNode);
+              context.report({
+                node,
+                message: message(nodeName, newName),
+                fix(fixer) {
+                  return isOpeningTag
+                    ? fixer.replaceText(parentNode, newOpeningParentTag)
+                    : fixer.replaceText(node, updateTagName(node));
+                },
+              });
             }
-          });
-        }
-      }
-    };
-  }
+          },
+        };
+  };
 }
 
 function ensureImports(context, node, package, imports) {
   if (node.source.value !== package) {
     return;
   }
   const patternflyImports = getPackageImports(context, package);
-  const patternflyImportNames = patternflyImports.map(imp => imp.imported.name);
-  const myImports = node.specifiers.map(imp => imp.imported.name);
+  const patternflyImportNames = patternflyImports.map(
+    (imp) => imp.imported.name
+  );
+  const myImports = node.specifiers.map((imp) => imp.imported.name);
   const missingImports = imports
-    .filter(imp => !patternflyImportNames.includes(imp)) // not added by consumer
-    .filter(imp => !myImports.includes(imp)) // not added by this rule
-    .join(', ');
+    .filter((imp) => !patternflyImportNames.includes(imp)) // not added by consumer
+    .filter((imp) => !myImports.includes(imp)) // not added by this rule
+    .join(", ");
   if (missingImports) {
     const lastSpecifier = node.specifiers[node.specifiers.length - 1];
     context.report({
       node,
       message: `add missing imports ${missingImports} from ${node.source.value}`,
       fix(fixer) {
         return fixer.insertTextAfter(lastSpecifier, `, ${missingImports}`);
-      }
+      },
     });
   }
 }
@@ -220,13 +269,13 @@ function addCallbackParam(componentsArray, propMap) {
                 const { type, params } = propProperties;
 
                 if (
-                  (params?.length === 1 &&
+                  (params?.length >= 1 &&
                     ["ArrowFunctionExpression", "Identifier"].includes(type)) ||
                   type === "MemberExpression"
                 ) {
                   context.report({
                     node,
-                    message: `The "${attribute.name.name}" prop for ${node.name.name} has been updated to include the "${newParam}" parameter as its first parameter. "${attribute.name.name}" handlers may require an update.`,
+                    message: `The "${attribute.name.name}" prop for ${node.name.name} has been updated so that the "${newParam}" parameter is the first parameter. "${attribute.name.name}" handlers may require an update.`,
                     fix(fixer) {
                       const fixes = [];
                       const createReplacerFix = (functionParam) => {
@@ -269,5 +318,5 @@ module.exports = {
   renameProps0,
   renameProps,
   renameComponents,
-  addCallbackParam
-}
+  addCallbackParam,
+};

packages/eslint-plugin-pf-codemods/lib/rules/v5/dataListCheck-updated-callback.js

@@ -0,0 +1,7 @@
+const { addCallbackParam } = require("../../helpers");
+
+// https://github.com/patternfly/patternfly-react/pull/8735
+module.exports = {
+  meta: { fixable: "code" },
+  create: addCallbackParam(["DataListCheck"], { onChange: "_event" }),
+};