@react-spectrum/codemods 0.2.1 → 0.3.0

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

@@ -22,6 +22,39 @@ exports.changes = {
             }
         ]
     },
+    ActionGroup: {
+        changes: [
+            {
+                description: 'Comment out overflowMode',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'overflowMode' }
+                }
+            },
+            {
+                description: 'Comment out buttonLabelBehavior',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'buttonLabelBehavior' }
+                }
+            },
+            {
+                description: 'Comment out summaryIcon',
+                reason: 'It has not been implemented yet',
+                function: {
+                    name: 'commentOutProp',
+                    args: { propToComment: 'summaryIcon' }
+                }
+            },
+            {
+                description: 'Replace with ActionButtonGroup or ToggleButtonGroup',
+                reason: 'The API has changed',
+                function: { name: 'updateActionGroup', args: {} }
+            }
+        ]
+    },
     ActionMenu: {
         changes: [
             {
@@ -334,6 +367,30 @@ exports.changes = {
                     name: 'moveRenderPropsToChild',
                     args: { newChildComponent: 'Dialog' }
                 }
+            },
+            {
+                description: 'Rename isDismissable to isDismissible',
+                reason: 'Fixed spelling',
+                function: { name: 'updatePropName', args: { oldProp: 'isDismissable', newProp: 'isDismissible' } }
+            },
+            {
+                description: 'Update Dialog child to Popover or FullscreenDialog depending on type prop',
+                reason: 'Updated API',
+                function: { name: 'updateDialogChild', args: {} }
+            }
+        ]
+    },
+    DialogContainer: {
+        changes: [
+            {
+                description: 'Rename isDismissable to isDismissible',
+                reason: 'Fixed spelling',
+                function: { name: 'updatePropName', args: { oldProp: 'isDismissable', newProp: 'isDismissible' } }
+            },
+            {
+                description: 'Update Dialog child to Popover or FullscreenDialog depending on type prop',
+                reason: 'Updated API',
+                function: { name: 'updateDialogChild', args: {} }
             }
         ]
     },

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

@@ -49,6 +49,8 @@ availableComponents.add('Item');
 availableComponents.add('Section');
 // Don't update v3 Provider
 availableComponents.delete('Provider');
+// Replaced by ActionButtonGroup and ToggleButtonGroup
+availableComponents.add('ActionGroup');
 function transformer(file, api, options) {
     let j = api.jscodeshift.withParser({
         parse(source) {
@@ -227,7 +229,7 @@ function transformer(file, api, options) {
     if (importedComponents.size) {
         // Add imports to existing @react-spectrum/s2 import if it exists, otherwise add a new one.
         let importSpecifiers = new Set([...importedComponents]
-            .filter(([c]) => c !== 'Flex' && c !== 'Grid' && c !== 'View' && c !== 'Item' && c !== 'Section')
+            .filter(([c]) => c !== 'Flex' && c !== 'Grid' && c !== 'View' && c !== 'Item' && c !== 'Section' && c !== 'ActionGroup')
             .map(([, specifier]) => specifier));
         let existingImport = root.find(j.ImportDeclaration, {
             source: { value: '@react-spectrum/s2' }

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

@@ -140,7 +140,7 @@ const UNIT_RE = /(%|px|em|rem|vw|vh|auto|cm|mm|in|pt|pc|ex|ch|rem|vmin|vmax|fr)$
 const FUNC_RE = /^\s*\w+\(/;
 // const SPECTRUM_VARIABLE_RE = /(static-)?size-\d+|single-line-(height|width)/g;
 const SIZING_RE = /auto|100vh|min-content|max-content|fit-content/;
-function convertDimension(value, toPixels = false) {
+function convertDimension(value, type) {
     let pixelValue;
     if (typeof value === 'number') {
         pixelValue = value;
@@ -170,10 +170,10 @@ function convertDimension(value, toPixels = false) {
     if (pixelValue == null) {
         throw new Error('invalid dimension: ' + value);
     }
-    if (toPixels) {
+    if (type === 'px') {
         return `${pixelValue}px`;
     }
-    if (spacingValues.includes(pixelValue)) {
+    if (type === 'size' || spacingValues.includes(pixelValue)) {
         return pixelValue;
     }
     // TODO: Convert to rems? Find nearest value?
@@ -184,16 +184,16 @@ function convertGridTrack(value, toPixels = false) {
         return value;
     }
     else {
-        return convertDimension(value, toPixels);
+        return convertDimension(value, toPixels ? 'px' : 'space');
     }
 }
-function convertUnsafeDimension(value) {
+function convertUnsafeDimension(value, type) {
     if (typeof value === 'number') {
-        return convertDimension(value);
+        return convertDimension(value, type);
     }
     let m = value.match(/^var\(--spectrum-global-dimension-(static-)?size-(.*)\)$/);
     if (m) {
-        return convertDimension(`${m[1] || ''}size-${m[2]}`);
+        return convertDimension(`${m[1] || ''}size-${m[2]}`, type);
     }
     return null;
 }

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

@@ -63,7 +63,21 @@ function getStylePropValue(prop, value, element, colorVersion, condition = '') {
         case 'maxWidth':
         case 'height':
         case 'minHeight':
-        case 'maxHeight':
+        case 'maxHeight': {
+            if (value.type === 'StringLiteral' || value.type === 'NumericLiteral') {
+                let val = (0, dimensions_1.convertDimension)(value.value, 'size');
+                if (val != null) {
+                    return {
+                        macroValues: [{ key: mappedProp, value: val }]
+                    };
+                }
+            }
+            else if (value.type === 'ObjectExpression') {
+                return getResponsiveValue(prop, value, element, colorVersion);
+            }
+            // return [mappedProp, customProp, [[customProp, value]]];
+            return null;
+        }
         case 'margin':
         case 'marginStart':
         case 'marginEnd':
@@ -79,7 +93,7 @@ function getStylePropValue(prop, value, element, colorVersion, condition = '') {
         case 'end':
         case 'flexBasis': {
             if (value.type === 'StringLiteral' || value.type === 'NumericLiteral') {
-                let val = (0, dimensions_1.convertDimension)(value.value);
+                let val = (0, dimensions_1.convertDimension)(value.value, 'space');
                 if (val != null) {
                     return {
                         macroValues: [{ key: mappedProp, value: val }]
@@ -182,7 +196,7 @@ function getStylePropValue(prop, value, element, colorVersion, condition = '') {
         case 'rowGap':
             if (element === 'Flex' || element === 'Grid') {
                 if (value.type === 'StringLiteral' || value.type === 'NumericLiteral') {
-                    let val = (0, dimensions_1.convertDimension)(value.value);
+                    let val = (0, dimensions_1.convertDimension)(value.value, 'space');
                     if (val != null) {
                         return {
                             macroValues: [{ key: mappedProp, value: val }]
@@ -308,7 +322,7 @@ function getStylePropValue(prop, value, element, colorVersion, condition = '') {
         case 'paddingBottom':
             if (element === 'View') {
                 if (value.type === 'StringLiteral' || value.type === 'NumericLiteral') {
-                    let val = (0, dimensions_1.convertDimension)(value.value);
+                    let val = (0, dimensions_1.convertDimension)(value.value, 'space');
                     if (val != null) {
                         return {
                             macroValues: [{ key: mappedProp, value: val }]
@@ -410,7 +424,7 @@ function getStylePropValue(prop, value, element, colorVersion, condition = '') {
             // Try to automatically convert size prop to a macro value for components that supported size.
             if (element === 'ColorArea' || element === 'ColorWheel') {
                 if (value.type === 'StringLiteral' || value.type === 'NumericLiteral') {
-                    let val = (0, dimensions_1.convertDimension)(value.value);
+                    let val = (0, dimensions_1.convertDimension)(value.value, 'size');
                     if (val != null) {
                         return {
                             macroValues: [{ key: 'size', value: val }]

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

@@ -285,7 +285,16 @@ function moveRenderPropsToChild(path, options) {
         t.isArrowFunctionExpression(renderFunction.expression) &&
         t.isJSXElement(renderFunction.expression.body)) {
         const dialogElement = renderFunction.expression.body;
-        const newRenderFunction = t.jsxExpressionContainer(t.arrowFunctionExpression(renderFunction.expression.params, t.jsxFragment(t.jsxOpeningFragment(), t.jsxClosingFragment(), dialogElement.children)));
+        const originalParam = renderFunction.expression.params[0];
+        if (!t.isIdentifier(originalParam)) {
+            (0, utils_1.addComment)(path.node.children[renderFunctionIndex], ' TODO(S2-upgrade): Could not automatically move the render props. You\'ll need to update this manually.');
+            return;
+        }
+        const paramName = originalParam.name;
+        const objectPattern = t.objectPattern([
+            t.objectProperty(t.identifier(paramName), t.identifier(paramName), false, true)
+        ]);
+        const newRenderFunction = t.jsxExpressionContainer(t.arrowFunctionExpression([objectPattern], t.jsxFragment(t.jsxOpeningFragment(), t.jsxClosingFragment(), dialogElement.children)));
         let removedOnDismiss = false;
         const attributes = dialogElement.openingElement.attributes.filter((attr) => {
             if (t.isJSXAttribute(attr) && attr.name.name === 'onDismiss') {
@@ -358,7 +367,7 @@ function updateComponentWithinCollection(path, options) {
  * Example: If they're declaring declaring Items somewhere above the collection.
  */
 function commentIfParentCollectionNotDetected(path) {
-    const collectionItemParents = new Set(['Menu', 'ActionMenu', 'TagGroup', 'Breadcrumbs', 'Picker', 'ComboBox', 'ListBox', 'TabList', 'TabPanels', 'ActionGroup', 'ListBox', 'ListView', 'Collection', 'SearchAutocomplete', 'Accordion', 'ActionBar', 'StepList']);
+    const collectionItemParents = new Set(['Menu', 'ActionMenu', 'TagGroup', 'Breadcrumbs', 'Picker', 'ComboBox', 'ListBox', 'TabList', 'TabPanels', 'ActionGroup', 'ActionButtonGroup', 'ToggleButtonGroup', 'ListBox', 'ListView', 'Collection', 'SearchAutocomplete', 'Accordion', 'ActionBar', 'StepList']);
     if (t.isJSXElement(path.node)) {
         // Find closest parent collection component
         let closestParentCollection = path.findParent((p) => t.isJSXElement(p.node) &&
@@ -532,7 +541,7 @@ function convertDimensionValueToPx(path, options) {
     if (attrPath && t.isJSXAttribute(attrPath.node) && attrPath.node.name.name === propToConvertValue) {
         if (t.isStringLiteral(attrPath.node.value)) {
             try {
-                let value = (0, dimensions_1.convertDimension)(attrPath.node.value.value);
+                let value = (0, dimensions_1.convertDimension)(attrPath.node.value.value, 'size');
                 if (value && typeof value === 'number') {
                     attrPath.node.value = t.jsxExpressionContainer(t.numericLiteral(value));
                 }
@@ -685,6 +694,158 @@ function updateLegacyLink(path) {
         }
     }
 }
+/**
+ * Updates DialogTrigger and DialogContainer to the new API.
+ *
+ * Example:
+ * - When `type="popover"`, replaces Dialog with `<Popover>`.
+ * - When `type="fullscreen"`, replaces Dialog with `<FullscreenDialog>`.
+ * - When `type="fullscreenTakeover"`, replaces Dialog with `<FullscreenDialog variant="fullscreenTakeover">`.
+ */
+function updateDialogChild(path) {
+    let typePath = path.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'type');
+    let type = typePath?.node.value?.type === 'StringLiteral' ? typePath.node.value?.value : 'modal';
+    let newComponent = 'Dialog';
+    let props = [];
+    if (type === 'popover') {
+        newComponent = 'Popover';
+    }
+    else if (type === 'fullscreen' || type === 'fullscreenTakeover') {
+        newComponent = 'FullscreenDialog';
+        if (type === 'fullscreenTakeover') {
+            props.push(t.jsxAttribute(t.jsxIdentifier('variant'), t.stringLiteral(type)));
+        }
+    }
+    for (let prop of ['isDismissible', 'mobileType', 'hideArrow', 'placement', 'shouldFlip', 'isKeyboardDismissDisabled', 'containerPadding', 'offset', 'crossOffset']) {
+        let attr = path.get('openingElement').get('attributes').find(attr => attr.isJSXAttribute() && attr.node.name.name === prop);
+        if (attr) {
+            props.push(attr.node);
+            attr.remove();
+        }
+    }
+    typePath?.remove();
+    let localName = newComponent;
+    if (newComponent !== 'Dialog' && availableComponents.has(newComponent)) {
+        let program = path.findParent((p) => t.isProgram(p.node));
+        localName = (0, utils_1.addComponentImport)(program, newComponent);
+    }
+    path.traverse({
+        JSXElement(dialog) {
+            if (!t.isJSXIdentifier(dialog.node.openingElement.name) || (0, utils_1.getName)(dialog, dialog.node.openingElement.name) !== 'Dialog') {
+                return;
+            }
+            dialog.node.openingElement.name = t.jsxIdentifier(localName);
+            if (dialog.node.closingElement) {
+                dialog.node.closingElement.name = t.jsxIdentifier(localName);
+            }
+            dialog.node.openingElement.attributes.push(...props);
+        }
+    });
+}
+function updateActionGroup(path) {
+    let selectionModePath = path.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'selectionMode');
+    let selectionMode = t.isStringLiteral(selectionModePath?.node.value) ? selectionModePath.node.value.value : 'none';
+    let newComponent, childComponent;
+    if (selectionMode === 'none') {
+        newComponent = 'ActionButtonGroup';
+        childComponent = 'ActionButton';
+        selectionModePath?.remove();
+    }
+    else {
+        newComponent = 'ToggleButtonGroup';
+        childComponent = 'ToggleButton';
+    }
+    let localName = newComponent;
+    if (availableComponents.has(newComponent)) {
+        let program = path.findParent((p) => t.isProgram(p.node));
+        localName = (0, utils_1.addComponentImport)(program, newComponent);
+    }
+    let localChildName = childComponent;
+    if (availableComponents.has(childComponent)) {
+        let program = path.findParent((p) => t.isProgram(p.node));
+        localChildName = (0, utils_1.addComponentImport)(program, childComponent);
+    }
+    // Convert dynamic collection to an array.map.
+    let items = path.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'items');
+    let itemArg;
+    if (items && t.isJSXExpressionContainer(items.node.value) && t.isExpression(items.node.value.expression)) {
+        let child = path.get('children').find(c => c.isJSXExpressionContainer());
+        if (child && child.isJSXExpressionContainer() && t.isFunction(child.node.expression)) {
+            let arg = child.node.expression.params[0];
+            if (t.isIdentifier(arg)) {
+                itemArg = arg;
+            }
+            child.replaceWith(t.jsxExpressionContainer(t.callExpression(t.memberExpression(items.node.value.expression, t.identifier('map')), [child.node.expression])));
+        }
+    }
+    items?.remove();
+    let onAction = path.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'onAction');
+    // Pull disabledKeys prop out into a variable, converted to a Set.
+    // Then we can check it in the isDisabled prop of each item.
+    let disabledKeysPath = path.get('openingElement').get('attributes').find((attr) => t.isJSXAttribute(attr.node) && attr.node.name.name === 'disabledKeys');
+    let disabledKeys;
+    if (disabledKeysPath && t.isJSXExpressionContainer(disabledKeysPath.node.value) && t.isExpression(disabledKeysPath.node.value.expression)) {
+        disabledKeys = path.scope.generateUidIdentifier('disabledKeys');
+        path.scope.push({
+            id: disabledKeys,
+            init: t.newExpression(t.identifier('Set'), [disabledKeysPath.node.value.expression]),
+            kind: 'let'
+        });
+        disabledKeysPath.remove();
+    }
+    path.traverse({
+        JSXElement(child) {
+            if (t.isJSXIdentifier(child.node.openingElement.name) && child.node.openingElement.name.name === 'Item') {
+                // Replace Item with ActionButton or ToggleButton.
+                let childNode = t.cloneNode(child.node);
+                childNode.openingElement.name = t.jsxIdentifier(localChildName);
+                if (childNode.closingElement) {
+                    childNode.closingElement.name = t.jsxIdentifier(localChildName);
+                }
+                // If there is no key prop and we are using dynamic collections, add a default computed from item.key ?? item.id.
+                let key = childNode.openingElement.attributes.find(attr => t.isJSXAttribute(attr) && attr.name.name === 'key');
+                if (!key && itemArg) {
+                    let id = t.jsxExpressionContainer(t.logicalExpression('??', t.memberExpression(itemArg, t.identifier('key')), t.memberExpression(itemArg, t.identifier('id'))));
+                    key = t.jsxAttribute(t.jsxIdentifier('key'), id);
+                    childNode.openingElement.attributes.push(key);
+                }
+                // If this is a ToggleButtonGroup, add an id prop in addition to key when needed.
+                if (key && newComponent === 'ToggleButtonGroup') {
+                    // If we are in an array.map we need both key and id. Otherwise, we only need id.
+                    if (itemArg) {
+                        childNode.openingElement.attributes.push(t.jsxAttribute(t.jsxIdentifier('id'), key.value));
+                    }
+                    else {
+                        key.name.name = 'id';
+                    }
+                }
+                let keyValue = undefined;
+                if (key && t.isJSXExpressionContainer(key.value) && t.isExpression(key.value.expression)) {
+                    keyValue = key.value.expression;
+                }
+                else if (key && t.isStringLiteral(key.value)) {
+                    keyValue = key.value;
+                }
+                // Add an onPress to each item that calls the previous onAction, passing in the key.
+                if (onAction && t.isJSXExpressionContainer(onAction.node.value) && t.isExpression(onAction.node.value.expression)) {
+                    childNode.openingElement.attributes.push(t.jsxAttribute(t.jsxIdentifier('onPress'), t.jsxExpressionContainer(keyValue
+                        ? t.arrowFunctionExpression([], t.callExpression(onAction.node.value.expression, [keyValue]))
+                        : onAction.node.value.expression)));
+                }
+                // Add an isDisabled prop to each item, testing whether it is in disabledKeys.
+                if (disabledKeys && keyValue) {
+                    childNode.openingElement.attributes.push(t.jsxAttribute(t.jsxIdentifier('isDisabled'), t.jsxExpressionContainer(t.callExpression(t.memberExpression(disabledKeys, t.identifier('has')), [keyValue]))));
+                }
+                child.replaceWith(childNode);
+            }
+        }
+    });
+    onAction?.remove();
+    path.node.openingElement.name = t.jsxIdentifier(localName);
+    if (path.node.closingElement) {
+        path.node.closingElement.name = t.jsxIdentifier(localName);
+    }
+}
 exports.functionMap = {
     updatePropNameAndValue,
     updatePropValueAndAddNewProp,
@@ -704,5 +865,7 @@ exports.functionMap = {
     updatePlacementToSingleValue,
     removeComponentIfWithinParent,
     updateAvatarSize,
-    updateLegacyLink
+    updateLegacyLink,
+    updateDialogChild,
+    updateActionGroup
 };

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

@@ -160,7 +160,12 @@ function handleProperty(element, property, value) {
         case 'maxWidth':
         case 'height':
         case 'minHeight':
-        case 'maxHeight':
+        case 'maxHeight': {
+            if (value.type === 'NumericLiteral' || value.type === 'StringLiteral') {
+                return (0, dimensions_1.convertUnsafeDimension)(value.value, 'size');
+            }
+            break;
+        }
         case 'margin':
         case 'marginInlineStart':
         case 'marginInlineEnd':
@@ -178,7 +183,7 @@ function handleProperty(element, property, value) {
         case 'insetInlineEnd':
         case 'flexBasis': {
             if (value.type === 'NumericLiteral' || value.type === 'StringLiteral') {
-                return (0, dimensions_1.convertUnsafeDimension)(value.value);
+                return (0, dimensions_1.convertUnsafeDimension)(value.value, 'space');
             }
             break;
         }
@@ -196,7 +201,7 @@ function handleProperty(element, property, value) {
         case 'columnGap': {
             if (element === 'View' || element === 'Flex' || element === 'Grid') {
                 if (value.type === 'NumericLiteral' || value.type === 'StringLiteral') {
-                    return (0, dimensions_1.convertUnsafeDimension)(value.value);
+                    return (0, dimensions_1.convertUnsafeDimension)(value.value, 'space');
                 }
             }
             break;

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

@@ -155,10 +155,6 @@ exports.iconMap = new Map([
         'Channel',
         'Channel'
     ],
-    [
-        'ChatAdd',
-        'Channel'
-    ],
     [
         'Checkmark',
         'CheckmarkSize300'
@@ -711,10 +707,22 @@ exports.iconMap = new Map([
         'Pause',
         'Pause'
     ],
+    [
+        'PauseCircle',
+        'PauseCircle'
+    ],
     [
         'Pending',
         'ClockPending'
     ],
+    [
+        'PinOff',
+        'PinOff'
+    ],
+    [
+        'PinOn',
+        'PinOn'
+    ],
     [
         'Play',
         'Play'
@@ -991,6 +999,10 @@ exports.iconMap = new Map([
         'TextBulleted',
         'ListBulleted'
     ],
+    [
+        'TextIncrease',
+        'TextIncrease'
+    ],
     [
         'TextItalic',
         'TextItalic'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-spectrum/codemods",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "main": "dist/index.js",
   "source": "src/index.ts",
   "bin": "dist/index.js",
@@ -24,8 +24,8 @@
     "@babel/parser": "^7.24.5",
     "@babel/traverse": "^7.24.5",
     "@babel/types": "^7.24.5",
-    "@react-spectrum/s2": "^0.4.1",
-    "@react-types/shared": "^3.25.0",
+    "@react-spectrum/s2": "^0.5.0",
+    "@react-types/shared": "^3.26.0",
     "@types/node": "^20",
     "boxen": "^5.1.2",
     "build": "^0.1.4",
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8e0a28d188cdbdbd2b32296fa034b1b02ddde229"
+  "gitHead": "71f0ef23053f9e03ee7e97df736e8b083e006849"
 }