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

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'`,
+    },
+  },
+)

package/src/transforms/latest/heading/heading.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 {HEADING_MODS} from './heading.mods'
 
 const TODO_WARNING = 'Please double check the Heading migration below'
@@ -21,8 +23,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Heading', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Heading',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Heading', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Heading', localNames, options, styledAliases)) {
       return
     }
 
@@ -30,24 +40,45 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Heading'},
-      })
-      .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, HEADING_MODS, TODO_WARNING)) {
+        changed = true
+      }
+
+      if (addAttribute(j, path.node, 'trim', true)) {
+        changed = true
+      }
 
-        if (transformAttributes(j, path, HEADING_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, HEADING_MODS, TODO_WARNING)) {
+            changed = true
+          }
+
+          if (addAttribute(j, path.node, 'trim', true)) {
+            changed = true
+          }
+
+          return changed
+        },
       })
+    ) {
+      markChanged()
+    }
   })
 }

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

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './inline'
 
 defineInlineTest(
@@ -55,3 +57,78 @@ defineInlineTest(
   `,
   'warns if margin prop is present',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Inline} from '@sanity/ui'
+
+    export const RootInline = styled(Inline)(({theme}) => ({}))
+  `,
+  `
+    import {RootInline} from './Component.styled'
+
+    export function Component() {
+      return <RootInline space={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootInline gap={2} />')
+  },
+  'transforms attributes on imported styled Inline wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Inline} from '@sanity/ui'
+
+    export const RootInline = styled(Inline)(({theme}) => ({}))
+  `,
+  `
+    import {Inline} from 'another-package'
+    import {RootInline} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootInline space={2} />
+          <Inline space={2} />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootInline gap={2} />')
+    expect(output).toContain('<Inline space={2} />')
+  },
+  'does not transform attributes on unrelated Inline from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Inline} from '@sanity/ui'
+
+    export const RootInline = styled(Inline)(({theme}) => ({}))
+  `,
+  `
+    import {RootInline} from './index'
+
+    export function Component() {
+      return <RootInline space={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootInline gap={2} />')
+  },
+  'transforms styled Inline wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootInline} from './Component.styled'`,
+    },
+  },
+)

package/src/transforms/latest/inline/inline.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 {INLINE_MODS} from './inline.mods'
 
 const TODO_WARNING = 'Please double check the Inline migration below'
@@ -20,8 +22,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Inline', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Inline',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Inline', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Inline', localNames, options, styledAliases)) {
       return
     }
 
@@ -29,14 +39,24 @@ export default function transform(
       markChanged()
     }
 
-    root
-      .find(j.JSXOpeningElement, {
-        name: {type: 'JSXIdentifier', name: 'Inline'},
-      })
-      .forEach((path) => {
-        if (transformAttributes(j, path, INLINE_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, INLINE_MODS, TODO_WARNING)) {
+        markChanged()
+      }
+    })
+
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => transformAttributes(j, path, INLINE_MODS, TODO_WARNING),
       })
+    ) {
+      markChanged()
+    }
   })
 }

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

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './label'
 
 defineInlineTest(
@@ -111,3 +113,84 @@ defineInlineTest(
   `,
   'moves width props to style and updates mapped value',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Label} from '@sanity/ui'
+
+    export const RootLabel = styled(Label)(({theme}) => ({}))
+  `,
+  `
+    import {RootLabel} from './Component.styled'
+
+    export function RootCode() {
+      return <RootLabel flex="auto" />
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootLabel style={{ flex: "1 1 auto" }} as="div" trim={true} />',
+    )
+  },
+  'transforms attributes on imported styled Label wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Label} from '@sanity/ui'
+
+    export const RootLabel = styled(Label)(({theme}) => ({}))
+  `,
+  `
+    import {Label} from 'another-package'
+    import {RootLabel} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootLabel flex="auto" />
+          <Label flex="auto" />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootLabel style={{ flex: "1 1 auto" }} as="div" trim={true} />',
+    )
+    expect(output).toContain('<Label flex="auto" />')
+  },
+  'does not transform attributes on unrelated Label from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Label} from '@sanity/ui'
+
+    export const RootLabel = styled(Label)(({theme}) => ({}))
+  `,
+  `
+    import {RootLabel} from './index'
+
+    export function Component() {
+      return <RootLabel flex="auto" />
+    }
+  `,
+  (output) => {
+    expect(output.replace(/\s+/g, ' ')).toContain(
+      '<RootLabel style={{ flex: "1 1 auto" }} as="div" trim={true} />',
+    )
+  },
+  'transforms styled Label wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootLabel} from './Component.styled'`,
+    },
+  },
+)

package/src/transforms/latest/label/label.ts

@@ -3,11 +3,13 @@ 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 {replaceElement} from '../../../utils/replaceElement'
 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 {LABEL_MODS} from './label.mods'
 
 const TODO_WARNING = 'Please double check the Label migration below'
@@ -22,8 +24,16 @@ export default function transform(
 
   return transformComponent(fileInfo, api, ({j, root, markChanged}) => {
     const localNames = getComponentLocalNames(j, root, 'Label', options)
+    const styledAliases = getStyledComponentAliases(
+      j,
+      root,
+      'Label',
+      fileInfo.path,
+      localNames,
+      options,
+    )
 
-    if (!shouldTransformComponent(j, root, 'Label', localNames, options)) {
+    if (!shouldTransformComponent(j, root, 'Label', localNames, options, styledAliases)) {
       return
     }
 
@@ -38,6 +48,7 @@ export default function transform(
         () => true,
         {
           element: 'Label',
+          localNames,
         },
         {
           element: 'Eyebrow',
@@ -63,5 +74,29 @@ export default function transform(
     ) {
       markChanged()
     }
+
+    if (
+      transformStyledComponents(j, root, styledAliases, () => true, {
+        callback: (path) => {
+          let changed = false
+
+          if (transformAttributes(j, path, LABEL_MODS, TODO_WARNING)) {
+            changed = true
+          }
+
+          if (addAttribute(j, path.node, 'as', 'div')) {
+            changed = true
+          }
+
+          if (addAttribute(j, path.node, 'trim', true)) {
+            changed = true
+          }
+
+          return changed
+        },
+      })
+    ) {
+      markChanged()
+    }
   })
 }

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

@@ -1,4 +1,6 @@
-import {defineInlineTest} from '../../../utils/testUtils'
+import {expect} from 'vitest'
+
+import {defineCrossFileTest, defineInlineTest} from '../../../utils/testUtils'
 import transform from './stack'
 
 defineInlineTest(
@@ -158,3 +160,100 @@ defineInlineTest(
   `,
   'replaces Stack with Flex and transforms attributes',
 )
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Stack} from '@sanity/ui'
+
+    export const RootStack = styled(Stack)(({theme}) => ({}))
+  `,
+  `
+    import {RootStack} from './Component.styled'
+
+    export function Component() {
+      return <RootStack space={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootStack gap={2} />')
+  },
+  'transforms attributes on imported styled Stack wrappers',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Stack} from '@sanity/ui'
+
+    export const RootStack = styled(Stack)(({theme}) => ({}))
+  `,
+  `
+    import {RootStack} from './Component.styled'
+
+    export function Component() {
+      return <RootStack padding={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('UI-CODEMOD TODO: Please double check styled(Stack) migration below')
+    expect(output).toContain('<RootStack padding={2} />')
+  },
+  'adds todo warning when imported styled Stack wrapper should be replaced',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Stack} from '@sanity/ui'
+
+    export const RootStack = styled(Stack)(({theme}) => ({}))
+  `,
+  `
+    import {Stack} from 'another-package'
+    import {RootStack} from './Component.styled'
+
+    export function Component() {
+      return (
+        <>
+          <RootStack space={2} />
+          <Stack space={2} />
+        </>
+      )
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootStack gap={2} />')
+    expect(output).toContain('<Stack space={2} />')
+  },
+  'does not rewrite unrelated Stack from another package',
+)
+
+defineCrossFileTest(
+  transform,
+  {},
+  `
+    import {Stack} from '@sanity/ui'
+
+    export const RootStack = styled(Stack)(({theme}) => ({}))
+  `,
+  `
+    import {RootStack} from './index'
+
+    export function Component() {
+      return <RootStack space={2} />
+    }
+  `,
+  (output) => {
+    expect(output).toContain('<RootStack gap={2} />')
+  },
+  'transforms styled Stack wrappers imported through barrel re-exports',
+  {
+    extraFiles: {
+      'index.ts': `export {RootStack} from './Component.styled'`,
+    },
+  },
+)