@react-spectrum/codemods 0.3.0 → 0.4.0

package/dist/s1-to-s2/src/codemods/changes.js

@@ -1148,5 +1148,113 @@ exports.changes = {
                 }
             }
         ]
+    },
+    TableView: {
+        changes: [
+            {
+                description: 'Add columns prop to Row',
+                reason: 'Rows now require a columns prop from TableHeader',
+                function: {
+                    name: 'addColumnsPropToRow',
+                    args: {}
+                }
+            },
+            {
+                description: 'Leave comment if nested columns are used',
+                reason: 'Nested columns are not supported yet',
+                function: {
+                    name: 'commentIfNestedColumns',
+                    args: {}
+                }
+            },
+            {
+                description: 'Comment out dragAndDropHooks',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'dragAndDropHooks' }
+                }
+            },
+            {
+                description: 'Comment out selectionStyle="highlight"',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'selectionStyle' }
+                }
+            },
+            {
+                description: 'Comment out UNSTABLE_allowsExpandableRows',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'UNSTABLE_allowsExpandableRows' }
+                }
+            },
+            {
+                description: 'Comment out UNSTABLE_defaultExpandedKeys',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'UNSTABLE_defaultExpandedKeys' }
+                }
+            },
+            {
+                description: 'Comment out UNSTABLE_expandedKeys',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'UNSTABLE_expandedKeys' }
+                }
+            },
+            {
+                description: 'Comment out UNSTABLE_onExpandedChange',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'UNSTABLE_onExpandedChange' }
+                }
+            },
+            {
+                description: 'Add isRowHeader prop to fist Column if one doesn\'t eixst already',
+                reason: 'Updated API',
+                function: {
+                    name: 'addRowHeader',
+                    args: {}
+                }
+            }
+        ]
+    },
+    Column: {
+        changes: [
+            {
+                description: 'Update key prop to id',
+                reason: 'Updated API',
+                function: {
+                    name: 'updateKeyToId',
+                    args: {}
+                }
+            }
+        ]
+    },
+    Row: {
+        changes: [
+            {
+                description: 'Update key prop to id',
+                reason: 'Updated API',
+                function: {
+                    name: 'updateKeyToId',
+                    args: {}
+                }
+            },
+            {
+                description: 'Update child function to receive column object instead of column key',
+                reason: 'Updated API',
+                function: {
+                    name: 'updateRowFunctionArg',
+                    args: {}
+                }
+            }
+        ]
     }
 };

package/dist/s1-to-s2/src/codemods/transforms.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.functionMap = void 0;
+exports.commentIfNestedColumns = commentIfNestedColumns;
 const utils_1 = require("./utils");
 const dimensions_1 = require("./dimensions");
 const getComponents_1 = require("../getComponents");
@@ -331,32 +332,13 @@ function updateComponentWithinCollection(path, options) {
             t.isJSXIdentifier(closestParentCollection.node.openingElement.name) &&
             (0, utils_1.getName)(path, closestParentCollection.node.openingElement.name) === parentComponent) {
             // If closest parent collection component matches parentComponent, replace with newComponent
-            let attributes = path.node.openingElement.attributes;
-            let keyProp = attributes.find((attr) => t.isJSXAttribute(attr) && attr.name.name === 'key');
-            if (keyProp &&
-                t.isJSXAttribute(keyProp)) {
-                // Update key prop to be id
-                keyProp.name = t.jsxIdentifier('id');
-            }
-            if (t.isArrowFunctionExpression(path.parentPath.node) &&
-                path.parentPath.parentPath &&
-                t.isCallExpression(path.parentPath.parentPath.node) &&
-                path.parentPath.parentPath.node.callee.type === 'MemberExpression' &&
-                path.parentPath.parentPath.node.callee.property.type === 'Identifier' &&
-                path.parentPath.parentPath.node.callee.property.name === 'map') {
-                // If Array.map is used, keep the key prop
-                if (keyProp &&
-                    t.isJSXAttribute(keyProp)) {
-                    let newKeyProp = t.jsxAttribute(t.jsxIdentifier('key'), keyProp.value);
-                    attributes.push(newKeyProp);
-                }
-            }
+            updateKeyToId(path);
             let localName = newComponent;
             if (availableComponents.has(newComponent)) {
                 let program = path.findParent((p) => t.isProgram(p.node));
                 localName = (0, utils_1.addComponentImport)(program, newComponent);
             }
-            let newNode = t.jsxElement(t.jsxOpeningElement(t.jsxIdentifier(localName), attributes), t.jsxClosingElement(t.jsxIdentifier(localName)), path.node.children);
+            let newNode = t.jsxElement(t.jsxOpeningElement(t.jsxIdentifier(localName), path.node.openingElement.attributes), t.jsxClosingElement(t.jsxIdentifier(localName)), path.node.children);
             path.replaceWith(newNode);
         }
     }
@@ -694,6 +676,144 @@ function updateLegacyLink(path) {
         }
     }
 }
+/**
+ * Copies the columns prop from the TableHeader to the Row component.
+ */
+function addColumnsPropToRow(path) {
+    const tableHeaderPath = path.get('children').find((child) => t.isJSXElement(child.node) &&
+        t.isJSXIdentifier(child.node.openingElement.name) &&
+        (0, utils_1.getName)(child, child.node.openingElement.name) === 'TableHeader');
+    if (!tableHeaderPath) {
+        (0, utils_1.addComment)(path.node, ' TODO(S2-upgrade): Could not find TableHeader within Table to retrieve columns prop.');
+        return;
+    }
+    const columnsProp = tableHeaderPath
+        .get('openingElement')
+        .get('attributes')
+        .find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'columns');
+    if (columnsProp) {
+        path.traverse({
+            JSXElement(innerPath) {
+                if (t.isJSXElement(innerPath.node) &&
+                    t.isJSXIdentifier(innerPath.node.openingElement.name) &&
+                    (0, utils_1.getName)(innerPath, innerPath.node.openingElement.name) === 'Row') {
+                    let rowPath = innerPath;
+                    rowPath.node.openingElement.attributes.push(columnsProp.node);
+                    // If Row doesn't contain id prop, leave a comment for the user to check manually
+                    let idProp = rowPath.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'id');
+                    if (!idProp) {
+                        (0, utils_1.addComment)(rowPath.node, ' TODO(S2-upgrade): If the items do not have id properties, you\'ll need to add an id prop to the Row.');
+                    }
+                }
+            }
+        });
+    }
+}
+/**
+ * Updates the function signature of the Row component.
+ */
+function updateRowFunctionArg(path) {
+    // Find the function passed as a child
+    let functionChild = path.get('children').find(childPath => childPath.isJSXExpressionContainer() &&
+        childPath.get('expression').isArrowFunctionExpression());
+    let tablePath = path.findParent((p) => t.isJSXElement(p.node) &&
+        t.isJSXIdentifier(p.node.openingElement.name) &&
+        (0, utils_1.getName)(path, p.node.openingElement.name) === 'TableView');
+    let tableHeaderPath = tablePath?.get('children').find((child) => t.isJSXElement(child.node) &&
+        t.isJSXIdentifier(child.node.openingElement.name) &&
+        (0, utils_1.getName)(child, child.node.openingElement.name) === 'TableHeader');
+    function findColumnKeyProp(path) {
+        let columnKeyProp = 'id';
+        path.traverse({
+            JSXElement(columnPath) {
+                if (t.isArrowFunctionExpression(columnPath.parentPath.node) &&
+                    t.isJSXElement(columnPath.node) &&
+                    t.isJSXIdentifier(columnPath.node.openingElement.name) &&
+                    (0, utils_1.getName)(columnPath, columnPath.node.openingElement.name) === 'Column') {
+                    let openingElement = columnPath.get('openingElement');
+                    let keyPropPath = openingElement.get('attributes').find(attr => t.isJSXAttribute(attr.node) &&
+                        (attr.node.name.name === 'key' || attr.node.name.name === 'id'));
+                    keyPropPath?.traverse({
+                        Identifier(innerPath) {
+                            if (innerPath.node.name === 'column' &&
+                                innerPath.parentPath.node.type === 'MemberExpression' &&
+                                t.isIdentifier(innerPath.parentPath.node.property)) {
+                                columnKeyProp = innerPath.parentPath.node.property.name;
+                            }
+                        }
+                    });
+                }
+            }
+        });
+        return columnKeyProp || 'id';
+    }
+    let columnKey = findColumnKeyProp(tableHeaderPath);
+    if (functionChild && functionChild.isJSXExpressionContainer()) {
+        let arrowFuncPath = functionChild.get('expression');
+        if (arrowFuncPath.isArrowFunctionExpression()) {
+            let params = arrowFuncPath.node.params;
+            if (params.length === 1 && t.isIdentifier(params[0])) {
+                let paramName = params[0].name;
+                // Rename parameter to 'column'
+                params[0].name = 'column';
+                // Replace references to the old parameter name inside the function body
+                arrowFuncPath.get('body').traverse({
+                    Identifier(innerPath) {
+                        if (innerPath.node.name === paramName &&
+                            // Ensure we're not replacing the parameter declaration
+                            innerPath.node !== params[0]) {
+                            // Replace with column key
+                            innerPath.replaceWith(t.memberExpression(t.identifier('column'), t.identifier(columnKey ?? 'id')));
+                        }
+                    }
+                });
+            }
+        }
+    }
+}
+/**
+ * Updates the key prop to id. Keeps the key prop if it's used in an array.map function.
+ */
+function updateKeyToId(path) {
+    let attributes = path.node.openingElement.attributes;
+    let keyProp = attributes.find((attr) => t.isJSXAttribute(attr) && attr.name.name === 'key');
+    if (keyProp &&
+        t.isJSXAttribute(keyProp)) {
+        // Update key prop to be id
+        keyProp.name = t.jsxIdentifier('id');
+    }
+    if (t.isArrowFunctionExpression(path.parentPath.node) &&
+        path.parentPath.parentPath &&
+        t.isCallExpression(path.parentPath.parentPath.node) &&
+        path.parentPath.parentPath.node.callee.type === 'MemberExpression' &&
+        path.parentPath.parentPath.node.callee.property.type === 'Identifier' &&
+        path.parentPath.parentPath.node.callee.property.name === 'map') {
+        // If Array.map is used, keep the key prop
+        if (keyProp &&
+            t.isJSXAttribute(keyProp)) {
+            let newKeyProp = t.jsxAttribute(t.jsxIdentifier('key'), keyProp.value);
+            attributes.push(newKeyProp);
+        }
+    }
+}
+function commentIfNestedColumns(path) {
+    const headerPath = path.get('children').find((child) => t.isJSXElement(child.node) &&
+        t.isJSXIdentifier(child.node.openingElement.name) &&
+        (0, utils_1.getName)(child, child.node.openingElement.name) === 'TableHeader');
+    const columns = headerPath?.get('children') || [];
+    let hasNestedColumns = false;
+    columns.forEach(column => {
+        let columnChildren = column.get('children');
+        if (columnChildren.find(child => t.isJSXElement(child.node) &&
+            t.isJSXIdentifier(child.node.openingElement.name) &&
+            (0, utils_1.getName)(child, child.node.openingElement.name) === 'Column')) {
+            hasNestedColumns = true;
+        }
+    });
+    if (hasNestedColumns) {
+        (0, utils_1.addComment)(path.node, ' TODO(S2-upgrade): Nested Column components are not supported yet.');
+    }
+}
 /**
  * Updates DialogTrigger and DialogContainer to the new API.
  *
@@ -846,6 +966,53 @@ function updateActionGroup(path) {
         path.node.closingElement.name = t.jsxIdentifier(localName);
     }
 }
+/**
+ * Adds isRowHeader to the first Column in a table if there isn't already a row header.
+ * @param path
+ */
+function addRowHeader(path) {
+    let tableHeaderPath = path.get('children').find((child) => t.isJSXElement(child.node) &&
+        t.isJSXIdentifier(child.node.openingElement.name) &&
+        (0, utils_1.getName)(child, child.node.openingElement.name) === 'TableHeader');
+    // Check if isRowHeader is already set on a Column
+    let hasRowHeader = false;
+    tableHeaderPath?.get('children').forEach((child) => {
+        if (t.isJSXElement(child.node) &&
+            t.isJSXIdentifier(child.node.openingElement.name) &&
+            (0, utils_1.getName)(child, child.node.openingElement.name) === 'Column') {
+            let isRowHeaderProp = child.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'isRowHeader');
+            if (isRowHeaderProp) {
+                hasRowHeader = true;
+            }
+        }
+    });
+    // If there isn't already a row header, add one to the first Column if possible
+    if (!hasRowHeader) {
+        tableHeaderPath?.get('children').forEach((child) => {
+            // Add to first Column if static
+            if (!hasRowHeader &&
+                t.isJSXElement(child.node) &&
+                t.isJSXIdentifier(child.node.openingElement.name) &&
+                (0, utils_1.getName)(child, child.node.openingElement.name) === 'Column') {
+                child.node.openingElement.attributes.push(t.jsxAttribute(t.jsxIdentifier('isRowHeader'), t.jsxExpressionContainer(t.booleanLiteral(true))));
+                hasRowHeader = true;
+            }
+            // If render function is used, leave a comment to update manually
+            if (t.isJSXExpressionContainer(child.node) &&
+                t.isArrowFunctionExpression(child.node.expression)) {
+                (0, utils_1.addComment)(child.node, ' TODO(S2-upgrade): You\'ll need to add isRowHeader to one of the columns manually.');
+            }
+            // If array.map is used, leave a comment to update manually
+            if (t.isJSXExpressionContainer(child.node) &&
+                t.isCallExpression(child.node.expression) &&
+                t.isMemberExpression(child.node.expression.callee) &&
+                t.isIdentifier(child.node.expression.callee.property) &&
+                child.node.expression.callee.property.name === 'map') {
+                (0, utils_1.addComment)(child.node, ' TODO(S2-upgrade): You\'ll need to add isRowHeader to one of the columns manually.');
+            }
+        });
+    }
+}
 exports.functionMap = {
     updatePropNameAndValue,
     updatePropValueAndAddNewProp,
@@ -866,6 +1033,11 @@ exports.functionMap = {
     removeComponentIfWithinParent,
     updateAvatarSize,
     updateLegacyLink,
+    addColumnsPropToRow,
+    updateRowFunctionArg,
     updateDialogChild,
-    updateActionGroup
+    updateActionGroup,
+    updateKeyToId,
+    commentIfNestedColumns,
+    addRowHeader
 };

package/dist/s1-to-s2/src/getComponents.js

@@ -14,12 +14,7 @@ const skipped = new Set([
     'Accordion',
     'Card',
     'CardView',
-    'TableView',
-    'TableHeader',
-    'Column',
-    'TableBody',
-    'Row',
-    'Cell'
+    'ActionBar'
 ]);
 function getComponents() {
     // Determine list of available components in S2 from index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-spectrum/codemods",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "dist/index.js",
   "source": "src/index.ts",
   "bin": "dist/index.js",
@@ -24,29 +24,31 @@
     "@babel/parser": "^7.24.5",
     "@babel/traverse": "^7.24.5",
     "@babel/types": "^7.24.5",
-    "@react-spectrum/s2": "^0.5.0",
-    "@react-types/shared": "^3.26.0",
+    "@react-spectrum/s2": "^0.6.0",
+    "@react-types/shared": "^3.27.0",
     "@types/node": "^20",
     "boxen": "^5.1.2",
     "build": "^0.1.4",
     "chalk": "^4.0.0",
     "execa": "^5.1.1",
     "jscodeshift": "^0.15.2",
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0",
     "recast": "^0.23.9",
     "ts-node": "^10.9.2",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
     "@types/jscodeshift": "^0.11.11",
-    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0",
     "typescript": "^5.5.0"
   },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0-rc.1",
+    "react-dom": "^18.0.0 || ^19.0.0-rc.1"
+  },
   "rsp": {
     "type": "cli"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "71f0ef23053f9e03ee7e97df736e8b083e006849"
+  "gitHead": "09e7f44bebdc9d89122926b2b439a0a38a2814ea"
 }