@sanity/ui-codemod 1.0.0-alpha.4 → 1.0.0-alpha.6

package/src/transforms/latest/code/code.ts

@@ -3,10 +3,12 @@ import {type API, type FileInfo} from 'jscodeshift'
 import type {BaseOptions} from '../../../types/BaseOptions'
 import {addAttribute} from '../../../utils/addAttribute'
 import {getComponentLocalNames} from '../../../utils/getComponentLocalNames'
+import {getStyledComponentAliases} from '../../../utils/getStyledComponentAliases'
 import {shouldTransformComponent} from '../../../utils/shouldTransformComponent'
 import {transformAttributes} from '../../../utils/transformAttributes'
 import {transformComponent} from '../../../utils/transformComponent'
 import {transformImport} from '../../../utils/transformImport'
+import {transformStyledComponents} from '../../../utils/transformStyledComponents'
 import {CODE_MODS} from './code.mods'
 
 const TODO_WARNING = 'Please double check the Code migration below'
@@ -21,8 +23,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Code', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Code',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Code', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Code', localNames, options, styledAliases)) {
       return
     }
 
@@ -30,24 +40,45 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Code'},
-      })
-      .forEach((path) => {
-        let changed = false
+    root.find(j.JSXOpeningElement).forEach((path) => {
+      let changed = false
+      const name = path.node.name
+
+      if (name.type !== 'JSXIdentifier' || !localNames.has(name.name)) {
+        return
+      }
+
+      if (transformAttributes(j, path, CODE_MODS, TODO_WARNING)) {
+        changed = true
+      }
+
+      if (addAttribute(j, path.node, 'trim', true)) {
+        changed = true
+      }
 
-        if (transformAttributes(j, path, CODE_MODS, TODO_WARNING)) {
-          changed = true
-        }
+      if (changed) {
+        markChanged()
+      }
+    })
 
-        if (addAttribute(j, path.node, 'trim', true)) {
-          changed = true
-        }
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => {
+          let changed = false
 
-        if (changed) {
-          markChanged()
-        }
+          if (transformAttributes(j, path, CODE_MODS, TODO_WARNING)) {
+            changed = true
+          }
+
+          if (addAttribute(j, path.node, 'trim', true)) {
+            changed = true
+          }
+
+          return changed
+        },
       })
+    ) {
+      markChanged()
+    }
   })
 }

package/src/transforms/latest/container/container.test.ts

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './container'
 
 defineInlineTest(
@@ -103,3 +105,78 @@ defineInlineTest(
   `,
   'moves grid props to style and updates mapped values',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Container} from '@sanity/ui'
+
+    export const RootContainer = styled(Container)(({theme}) => ({}))
+  `,
+  `
+    import {RootContainer} from './Component.styled'
+
+    export function Component() {
+      return <RootContainer width={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootContainer size={2} />')
+  },
+  'transforms attributes on imported styled Container wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Container} from '@sanity/ui'
+
+    export const RootContainer = styled(Container)(({theme}) => ({}))
+  `,
+  `
+    import {Container} from 'another-package'
+    import {RootContainer} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootContainer width={2} />
+          <Container width={2} />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootContainer size={2} />')
+    expect(output).toContain('<Container width={2} />')
+  },
+  'does not transform attributes on unrelated Container from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Container} from '@sanity/ui'
+
+    export const RootContainer = styled(Container)(({theme}) => ({}))
+  `,
+  `
+    import {RootContainer} from './index'
+
+    export function Component() {
+      return <RootContainer width={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootContainer size={2} />')
+  },
+  'transforms styled Container wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootContainer} from './Component.styled'`,
+    },
+  },
+)

package/src/transforms/latest/container/container.ts

@@ -2,10 +2,12 @@ import {type API, type FileInfo} from 'jscodeshift'
 
 import type {BaseOptions} from '../../../types/BaseOptions'
 import {getComponentLocalNames} from '../../../utils/getComponentLocalNames'
+import {getStyledComponentAliases} from '../../../utils/getStyledComponentAliases'
 import {shouldTransformComponent} from '../../../utils/shouldTransformComponent'
 import {transformAttributes} from '../../../utils/transformAttributes'
 import {transformComponent} from '../../../utils/transformComponent'
 import {transformImport} from '../../../utils/transformImport'
+import {transformStyledComponents} from '../../../utils/transformStyledComponents'
 import {CONTAINER_MODS} from './container.mods'
 
 const TODO_WARNING = 'Please double check the Container migration below'
@@ -20,8 +22,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Container', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Container',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Container', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Container', localNames, options, styledAliases)) {
       return
     }
 
@@ -29,14 +39,24 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Container'},
-      })
-      .forEach((path) => {
-        if (transformAttributes(j, path, CONTAINER_MODS, TODO_WARNING)) {
-          markChanged()
-        }
+    root.find(j.JSXOpeningElement).forEach((path) => {
+      const name = path.node.name
+
+      if (name.type !== 'JSXIdentifier' || !localNames.has(name.name)) {
+        return
+      }
+
+      if (transformAttributes(j, path, CONTAINER_MODS, TODO_WARNING)) {
+        markChanged()
+      }
+    })
+
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => transformAttributes(j, path, CONTAINER_MODS, TODO_WARNING),
       })
+    ) {
+      markChanged()
+    }
   })
 }

package/src/transforms/latest/flex/flex.test.ts

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './flex'
 
 defineInlineTest(
@@ -78,3 +80,78 @@ defineInlineTest(
   `,
   'moves grid props to style and updates mapped values',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Flex} from '@sanity/ui'
+
+    export const RootFlex = styled(Flex)(({theme}) => ({}))
+  `,
+  `
+    import {RootFlex} from './Component.styled'
+
+    export function Component() {
+      return <RootFlex align="center" />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootFlex alignItems="center" />')
+  },
+  'transforms attributes on imported styled Flex wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Flex} from '@sanity/ui'
+
+    export const RootFlex = styled(Flex)(({theme}) => ({}))
+  `,
+  `
+    import {Flex} from 'another-package'
+    import {RootFlex} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootFlex align="center" />
+          <Flex direction="column" />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootFlex alignItems="center" />')
+    expect(output).toContain('<Flex direction="column" />')
+  },
+  'does not transform attributes on unrelated Flex from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Flex} from '@sanity/ui'
+
+    export const RootFlex = styled(Flex)(({theme}) => ({}))
+  `,
+  `
+    import {RootFlex} from './index'
+
+    export function Component() {
+      return <RootFlex align="center" />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootFlex alignItems="center" />')
+  },
+  'transforms styled Flex wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootFlex} from './Component.styled'`,
+    },
+  },
+)

package/src/transforms/latest/flex/flex.ts

@@ -2,10 +2,12 @@ import {type API, type FileInfo} from 'jscodeshift'
 
 import type {BaseOptions} from '../../../types/BaseOptions'
 import {getComponentLocalNames} from '../../../utils/getComponentLocalNames'
+import {getStyledComponentAliases} from '../../../utils/getStyledComponentAliases'
 import {shouldTransformComponent} from '../../../utils/shouldTransformComponent'
 import {transformAttributes} from '../../../utils/transformAttributes'
 import {transformComponent} from '../../../utils/transformComponent'
 import {transformImport} from '../../../utils/transformImport'
+import {transformStyledComponents} from '../../../utils/transformStyledComponents'
 import {FLEX_MODS} from './flex.mods'
 
 const TODO_WARNING = 'Please double check the Flex migration below'
@@ -20,8 +22,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Flex', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Flex',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Flex', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Flex', localNames, options, styledAliases)) {
       return
     }
 
@@ -29,14 +39,24 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Flex'},
-      })
-      .forEach((path) => {
-        if (transformAttributes(j, path, FLEX_MODS, TODO_WARNING)) {
-          markChanged()
-        }
+    root.find(j.JSXOpeningElement).forEach((path) => {
+      const name = path.node.name
+
+      if (name.type !== 'JSXIdentifier' || !localNames.has(name.name)) {
+        return
+      }
+
+      if (transformAttributes(j, path, FLEX_MODS, TODO_WARNING)) {
+        markChanged()
+      }
+    })
+
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => transformAttributes(j, path, FLEX_MODS, TODO_WARNING),
       })
+    ) {
+      markChanged()
+    }
   })
 }

package/src/transforms/latest/grid/grid.test.ts

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './grid'
 
 defineInlineTest(
@@ -95,3 +97,78 @@ defineInlineTest(
   `,
   'updates v3 grid props mapped values',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Grid} from '@sanity/ui'
+
+    export const RootGrid = styled(Grid)(({theme}) => ({}))
+  `,
+  `
+    import {RootGrid} from './Component.styled'
+
+    export function Component() {
+      return <RootGrid autoCols="auto" />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootGrid gridAutoColumns="auto" />')
+  },
+  'transforms attributes on imported styled Grid wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Grid} from '@sanity/ui'
+
+    export const RootGrid = styled(Grid)(({theme}) => ({}))
+  `,
+  `
+    import {Grid} from 'another-package'
+    import {RootGrid} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootGrid autoCols="auto" />
+          <Grid autoCols="auto" />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootGrid gridAutoColumns="auto" />')
+    expect(output).toContain('<Grid autoCols="auto" />')
+  },
+  'does not transform attributes on unrelated Grid from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Grid} from '@sanity/ui'
+
+    export const RootGrid = styled(Grid)(({theme}) => ({}))
+  `,
+  `
+    import {RootGrid} from './index'
+
+    export function Component() {
+      return <RootGrid autoCols="auto" />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootGrid gridAutoColumns="auto" />')
+  },
+  'transforms styled Grid wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootGrid} from './Component.styled'`,
+    },
+  },
+)

package/src/transforms/latest/grid/grid.ts

@@ -2,10 +2,12 @@ import {type API, type FileInfo} from 'jscodeshift'
 
 import type {BaseOptions} from '../../../types/BaseOptions'
 import {getComponentLocalNames} from '../../../utils/getComponentLocalNames'
+import {getStyledComponentAliases} from '../../../utils/getStyledComponentAliases'
 import {shouldTransformComponent} from '../../../utils/shouldTransformComponent'
 import {transformAttributes} from '../../../utils/transformAttributes'
 import {transformComponent} from '../../../utils/transformComponent'
 import {transformImport} from '../../../utils/transformImport'
+import {transformStyledComponents} from '../../../utils/transformStyledComponents'
 import {GRID_MODS} from './grid.mods'
 
 const TODO_WARNING = 'Please double check the Grid migration below'
@@ -20,8 +22,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Grid', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Grid',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Grid', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Grid', localNames, options, styledAliases)) {
       return
     }
 
@@ -29,14 +39,24 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Grid'},
-      })
-      .forEach((path) => {
-        if (transformAttributes(j, path, GRID_MODS, TODO_WARNING)) {
-          markChanged()
-        }
+    root.find(j.JSXOpeningElement).forEach((path) => {
+      const name = path.node.name
+
+      if (name.type !== 'JSXIdentifier' || !localNames.has(name.name)) {
+        return
+      }
+
+      if (transformAttributes(j, path, GRID_MODS, TODO_WARNING)) {
+        markChanged()
+      }
+    })
+
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => transformAttributes(j, path, GRID_MODS, TODO_WARNING),
       })
+    ) {
+      markChanged()
+    }
   })
 }

package/src/transforms/latest/heading/heading.test.ts

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './heading'
 
 defineInlineTest(
@@ -85,3 +87,84 @@ defineInlineTest(
   `,
   'warns if as props is missing',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Heading} from '@sanity/ui'
+
+    export const RootHeading = styled(Heading)(({theme}) => ({}))
+  `,
+  `
+    import {RootHeading} from './Component.styled'
+
+    export function RootCode() {
+      return <RootHeading flex="auto" />
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootHeading style={{ flex: "1 1 auto" }} trim={true} />',
+    )
+  },
+  'transforms attributes on imported styled Heading wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Heading} from '@sanity/ui'
+
+    export const RootHeading = styled(Heading)(({theme}) => ({}))
+  `,
+  `
+    import {Heading} from 'another-package'
+    import {RootHeading} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootHeading flex="auto" />
+          <Heading flex="auto" />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootHeading style={{ flex: "1 1 auto" }} trim={true} />',
+    )
+    expect(output).toContain('<Heading flex="auto" />')
+  },
+  'does not transform attributes on unrelated Heading from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Heading} from '@sanity/ui'
+
+    export const RootHeading = styled(Heading)(({theme}) => ({}))
+  `,
+  `
+    import {RootHeading} from './index'
+
+    export function Component() {
+      return <RootHeading flex="auto" />
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootHeading style={{ flex: "1 1 auto" }} trim={true} />',
+    )
+  },
+  'transforms styled Heading wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootHeading} from './Component.styled'`,
+    },
+  },
+)