@planningcenter/tapestry-migration-cli 3.4.1-rc.9 → 3.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planningcenter/tapestry-migration-cli",
-  "version": "3.4.1-rc.9",
+  "version": "3.4.1",
   "description": "CLI tool for Tapestry migrations",
   "type": "module",
   "main": "dist/index.js",
@@ -30,7 +30,7 @@
   },
   "devDependencies": {
     "@emotion/react": "^11.14.0",
-    "@planningcenter/tapestry": "^3.4.1-rc.9",
+    "@planningcenter/tapestry": "^3.4.1",
     "@planningcenter/tapestry-react": "^4.11.5",
     "@types/jscodeshift": "^17.3.0",
     "@types/node": "^20.0.0",
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c98e7300610da3514ddea4ea4b2c262441c9912"
+  "gitHead": "f005d23b54d1a95f03e0823e6ab0d139af17cead"
 }

package/src/components/dropdown/index.test.ts

@@ -40,7 +40,7 @@ import { Dropdown } from "@planningcenter/tapestry-react"
 
 export default function Test() {
   return (
-    <Dropdown title="Actions">
+    <Dropdown onClose={handleClose}>
       <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
     </Dropdown>
   )
@@ -53,12 +53,185 @@ export default function Test() {
     expect(result).not.toContain("Dropdown.Item")
   })
 
-  it("returns null when there is nothing to transform", () => {
+  it("applies wrapMenu through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown onClose={handleClose}>
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("<DropdownMenu>")
+  })
+
+  it("applies placementIdToMenu through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown placement="bottom-end">
+      <DropdownMenu>
+        <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+      </DropdownMenu>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('<DropdownMenu placement="bottom end"')
+    expect(result).not.toMatch(/<Dropdown\s[^>]*placement/)
+  })
+
+  it("applies wrapTrigger through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("<DropdownTrigger>")
+    expect(result).toContain('<DropdownButton label="Actions"')
+    expect(result).not.toContain('title="Actions"')
+  })
+
+  it("applies unsupportedPropsDivider through the chain", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown><Divider axis="vertical" /></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO: tapestry-migration (axis)")
+  })
+
+  it("applies dividerToSeparator through the chain", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown><Divider /></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("<DropdownSeparator")
+    expect(result).not.toContain("<Divider")
+  })
+
+  it("applies unsupportedPropsItem through the chain", () => {
     const input = `
 import { Dropdown } from "@planningcenter/tapestry-react"
 
-export default function Test({ children }) {
-  return <Dropdown title="Actions">{children}</Dropdown>
+export default function Test() {
+  return (
+    <Dropdown title="Actions">
+      <Dropdown.Item as={Link} onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO: tapestry-migration (as)")
+  })
+
+  it("applies unsupportedPropsLink through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Actions">
+      <Dropdown.Link to="/edit" disabled>Edit</Dropdown.Link>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO: tapestry-migration (disabled)")
+  })
+
+  it("applies auditSpreadProps through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown {...props} title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO: tapestry-migration (spreadAttribute)")
+  })
+
+  it("applies unsupportedProps through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown variant="outline" onClose={fn}><Dropdown.Item onSelect={fn}>Edit</Dropdown.Item></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO: tapestry-migration (variant)")
+  })
+
+  it("applies moveDropdownImport through the chain", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown onClose={fn}>
+      <DropdownTrigger><DropdownButton label="Actions" /></DropdownTrigger>
+      <DropdownMenu><DropdownAction onAction={fn}>Edit</DropdownAction></DropdownMenu>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('from "@planningcenter/tapestry"')
+    expect(result).not.toContain('from "@planningcenter/tapestry-react"')
+  })
+
+  it("returns null when there is nothing to transform", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry"
+
+export default function Test() {
+  return (
+    <Dropdown onClose={handleClose}>
+      <DropdownTrigger><DropdownButton label="Actions" /></DropdownTrigger>
+      <DropdownMenu>
+        <DropdownAction onAction={fn}>Edit</DropdownAction>
+      </DropdownMenu>
+    </Dropdown>
+  )
 }
     `.trim()
 

package/src/components/dropdown/index.ts

@@ -1,14 +1,36 @@
 import { Transform } from "jscodeshift"
 
+import auditSpreadProps from "./transforms/auditSpreadProps"
+import dividerToSeparator from "./transforms/dividerToSeparator"
 import itemToAction from "./transforms/itemToAction"
 import linkToLink from "./transforms/linkToLink"
+import moveDropdownImport from "./transforms/moveDropdownImport"
+import placementIdToMenu from "./transforms/placementIdToMenu"
+import unsupportedProps from "./transforms/unsupportedProps"
+import unsupportedPropsDivider from "./transforms/unsupportedPropsDivider"
+import unsupportedPropsItem from "./transforms/unsupportedPropsItem"
+import unsupportedPropsLink from "./transforms/unsupportedPropsLink"
+import wrapMenu from "./transforms/wrapMenu"
+import wrapTrigger from "./transforms/wrapTrigger"
 
-// When moveDropdownImport is added, it must remain last in the chain.
 const transform: Transform = (fileInfo, api, options) => {
   let currentSource = fileInfo.source
   let hasAnyChanges = false
 
-  const transforms: Transform[] = [linkToLink, itemToAction]
+  const transforms: Transform[] = [
+    unsupportedPropsItem,
+    unsupportedPropsLink,
+    unsupportedPropsDivider,
+    itemToAction,
+    linkToLink,
+    wrapMenu,
+    placementIdToMenu,
+    wrapTrigger,
+    dividerToSeparator,
+    auditSpreadProps,
+    unsupportedProps,
+    moveDropdownImport,
+  ]
 
   for (const individualTransform of transforms) {
     const result = individualTransform(

package/src/components/dropdown/transforms/auditSpreadProps.test.ts

@@ -0,0 +1,110 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./auditSpreadProps"
+
+const j = jscodeshift.withParser("tsx")
+
+const AUDIT_COMMENT =
+  "TODO: tapestry-migration (spreadAttribute): Spread props can contain unsupported props, please explore usages and migrate as needed."
+
+function applyTransform(source: string): string | null {
+  const fileInfo = { path: "test.tsx", source }
+  return transform(
+    fileInfo,
+    { j, jscodeshift: j, report: () => {}, stats: () => {} },
+    {}
+  ) as string | null
+}
+
+describe("auditSpreadProps transform", () => {
+  it("adds a comment to Dropdown with spread props", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  const props = { onClose: handleClose }
+  return (
+    <Dropdown {...props} title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain(AUDIT_COMMENT)
+    expect(result).toContain("{...props}")
+  })
+
+  it("adds a comment for each spread", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown {...baseProps} {...extraProps} title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    const commentCount = (result?.match(/spreadAttribute/g) || []).length
+    expect(commentCount).toBe(2)
+  })
+
+  it("preserves all other attributes", () => {
+    const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Actions" placement="bottom-start" {...props}>
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('title="Actions"')
+    expect(result).toContain('placement="bottom-start"')
+    expect(result).toContain("{...props}")
+  })
+
+  describe("no changes scenarios", () => {
+    it("returns null when no spread props", () => {
+      const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+      `.trim()
+
+      expect(applyTransform(input)).toBe(null)
+    })
+
+    it("returns null when not imported from tapestry-react", () => {
+      const input = `
+import { Dropdown } from "some-other-library"
+
+export default function Test() {
+  return <Dropdown {...props} title="Actions" />
+}
+      `.trim()
+
+      expect(applyTransform(input)).toBe(null)
+    })
+
+    it("returns null for empty file", () => {
+      expect(applyTransform("")).toBe(null)
+    })
+  })
+})

package/src/components/dropdown/transforms/auditSpreadProps.ts

@@ -0,0 +1,10 @@
+import { Transform } from "jscodeshift"
+
+import { commentOnSpreadPropsFactory } from "../../shared/transformFactories/commentOnSpreadPropsFactory"
+
+const transform: Transform = commentOnSpreadPropsFactory({
+  targetComponent: "Dropdown",
+  targetPackage: "@planningcenter/tapestry-react",
+})
+
+export default transform

package/src/components/dropdown/transforms/dividerToSeparator.test.ts

@@ -0,0 +1,134 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./dividerToSeparator"
+
+const j = jscodeshift.withParser("tsx")
+
+function applyTransform(source: string): string | null {
+  const fileInfo = { path: "test.tsx", source }
+  return transform(
+    fileInfo,
+    { j, jscodeshift: j, report: () => {}, stats: () => {} },
+    {}
+  ) as string | null
+}
+
+describe("dividerToSeparator transform", () => {
+  it("renames Divider to DropdownSeparator when inside a Dropdown", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown><Divider /></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("<DropdownSeparator")
+    expect(result).not.toContain("<Divider")
+  })
+
+  it("handles non-self-closing Divider inside a Dropdown", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown><Divider></Divider></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("<DropdownSeparator>")
+    expect(result).toContain("</DropdownSeparator>")
+    expect(result).not.toContain("<Divider")
+  })
+
+  it("renames multiple Dividers inside a Dropdown", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown>
+      <Divider />
+      <Divider />
+    </Dropdown>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    const count = (result?.match(/<DropdownSeparator/g) || []).length
+    expect(count).toBe(2)
+    expect(result).not.toContain("<Divider")
+  })
+
+  it("adds DropdownSeparator import from tapestry and removes Divider import when all Dividers are inside a Dropdown", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Dropdown><Divider /></Dropdown>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('from "@planningcenter/tapestry"')
+    expect(result).toContain("DropdownSeparator")
+    expect(result).not.toContain(
+      'import { Dropdown, Divider } from "@planningcenter/tapestry-react"'
+    )
+  })
+
+  it("keeps Divider import when some Dividers are outside a Dropdown", () => {
+    const input = `
+import { Dropdown, Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <div>
+      <Divider />
+      <Dropdown><Divider /></Dropdown>
+    </div>
+  )
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("DropdownSeparator")
+    expect(result).toContain(
+      'import { Dropdown, Divider } from "@planningcenter/tapestry-react"'
+    )
+  })
+
+  describe("no changes scenarios", () => {
+    it("returns null when Divider is not inside a Dropdown", () => {
+      const input = `
+import { Divider } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Divider />
+}
+      `.trim()
+
+      expect(applyTransform(input)).toBe(null)
+    })
+
+    it("returns null when Divider is not imported from tapestry-react", () => {
+      const input = `
+import { Divider } from "some-other-library"
+
+export default function Test() {
+  return <Divider />
+}
+      `.trim()
+
+      expect(applyTransform(input)).toBe(null)
+    })
+
+    it("returns null for empty file", () => {
+      expect(applyTransform("")).toBe(null)
+    })
+  })
+})

package/src/components/dropdown/transforms/dividerToSeparator.ts

@@ -0,0 +1,67 @@
+import { Transform } from "jscodeshift"
+
+import { transformElementName } from "../../shared/actions/transformElementName"
+import { isChildOf } from "../../shared/conditions/isChildOf"
+import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
+import {
+  addImport,
+  getImportName,
+  removeImportFromDeclaration,
+} from "../../shared/transformFactories/helpers/manageImports"
+
+const transform: Transform = (fileInfo, api, options) => {
+  const j = api.jscodeshift
+  const source = j(fileInfo.source)
+
+  const dropdownLocalName = getImportName(
+    "Dropdown",
+    "@planningcenter/tapestry-react",
+    { j, source }
+  )
+  if (!dropdownLocalName) return null
+
+  const result = attributeTransformFactory({
+    condition: isChildOf(dropdownLocalName, source, j),
+    targetComponent: "Divider",
+    targetPackage: "@planningcenter/tapestry-react",
+    transform: (element) =>
+      transformElementName({ element, name: "DropdownSeparator" }),
+  })(fileInfo, api, options)
+
+  if (!result) return null
+
+  const updatedSource = j(result as string)
+
+  addImport({
+    component: "DropdownSeparator",
+    fromPackage: "@planningcenter/tapestry-react",
+    j,
+    pkg: "@planningcenter/tapestry",
+    source: updatedSource,
+  })
+
+  const dividerLocalName = getImportName(
+    "Divider",
+    "@planningcenter/tapestry-react",
+    { j, source: updatedSource }
+  )
+  if (dividerLocalName) {
+    const dividerStillUsed =
+      updatedSource.find(j.JSXOpeningElement, {
+        name: { name: dividerLocalName },
+      }).length > 0
+
+    if (!dividerStillUsed) {
+      removeImportFromDeclaration(
+        updatedSource.find(j.ImportDeclaration, {
+          source: { value: "@planningcenter/tapestry-react" },
+        }),
+        "Divider"
+      )
+    }
+  }
+
+  return updatedSource.toSource()
+}
+
+export default transform

package/src/components/dropdown/transforms/itemToAction.test.ts

@@ -205,7 +205,7 @@ export default function Test() {
       expect(result).not.toContain("Dropdown.Item")
     })
 
-    it("does not touch the import statement", () => {
+    it("does not touch the tapestry-react import statement", () => {
       const input = `
 import { Dropdown } from "@planningcenter/tapestry-react"
 
@@ -223,6 +223,24 @@ export default function Test() {
         'import { Dropdown } from "@planningcenter/tapestry-react"'
       )
     })
+
+    it("adds DropdownAction import from tapestry", () => {
+      const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Actions">
+      <Dropdown.Item onSelect={fn}>Edit</Dropdown.Item>
+    </Dropdown>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('from "@planningcenter/tapestry"')
+      expect(result).toContain("DropdownAction")
+    })
   })
 
   describe("multiple items", () => {

package/src/components/dropdown/transforms/itemToAction.ts

@@ -3,11 +3,12 @@ import { Transform } from "jscodeshift"
 import { transformAttributeName } from "../../shared/actions/transformAttributeName"
 import { transformElementName } from "../../shared/actions/transformElementName"
 import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
+import { addImport } from "../../shared/transformFactories/helpers/manageImports"
 
 const transform: Transform = attributeTransformFactory({
   targetComponent: "Dropdown.Item",
   targetPackage: "@planningcenter/tapestry-react",
-  transform: (element, { j, options }) => {
+  transform: (element, { j, options, source }) => {
     const onSelectRenamed = transformAttributeName("onSelect", "onAction", {
       element,
       j,
@@ -27,7 +28,18 @@ const transform: Transform = attributeTransformFactory({
       element,
       name: "DropdownAction",
     })
-    return onSelectRenamed || valueRenamed || textRenamed || elementRenamed
+    const changed =
+      onSelectRenamed || valueRenamed || textRenamed || elementRenamed
+    if (changed) {
+      addImport({
+        component: "DropdownAction",
+        fromPackage: "@planningcenter/tapestry-react",
+        j,
+        pkg: "@planningcenter/tapestry",
+        source,
+      })
+    }
+    return changed
   },
 })
 

package/src/components/dropdown/transforms/linkToLink.test.ts

@@ -186,7 +186,7 @@ export default function Test() {
       expect(result).toContain("<DropdownLink")
     })
 
-    it("does not touch the import statement", () => {
+    it("does not touch the tapestry-react import statement", () => {
       const input = `
 import { Dropdown } from "@planningcenter/tapestry-react"
 
@@ -204,6 +204,24 @@ export default function Test() {
         'import { Dropdown } from "@planningcenter/tapestry-react"'
       )
     })
+
+    it("adds DropdownLink import from tapestry", () => {
+      const input = `
+import { Dropdown } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Dropdown title="Nav">
+      <Dropdown.Link to="/docs">Docs</Dropdown.Link>
+    </Dropdown>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('from "@planningcenter/tapestry"')
+      expect(result).toContain("DropdownLink")
+    })
   })
 
   describe("no changes scenarios", () => {