@planningcenter/tapestry-migration-cli 2.3.0-rc.8 → 2.3.0

package/src/components/link/transforms/toToHref.test.ts

@@ -0,0 +1,245 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./toToHref"
+
+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("toToHref transform", () => {
+  describe("basic transformations", () => {
+    it("should transform Link 'to' prop to 'href' prop", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link to="/dashboard">Dashboard</Link>
+}
+      `.trim()
+
+      const expected = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link href="/dashboard">Dashboard</Link>;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result?.trim()).toBe(expected)
+    })
+
+    it("should handle multiple Link components with 'to' props", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <div>
+      <Link to="/home">Home</Link>
+      <Link to="/about">About</Link>
+    </div>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('href="/home"')
+      expect(result).toContain('href="/about"')
+      expect(result).not.toContain('to="/home"')
+      expect(result).not.toContain('to="/about"')
+    })
+
+    it("should preserve other props while transforming 'to' to 'href'", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <Link 
+      to="/dashboard" 
+      className="nav-link" 
+      target="_blank"
+      rel="noopener"
+    >
+      Dashboard
+    </Link>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('href="/dashboard"')
+      expect(result).toContain('className="nav-link"')
+      expect(result).toContain('target="_blank"')
+      expect(result).toContain('rel="noopener"')
+      expect(result).not.toContain('to="/dashboard"')
+    })
+
+    it("should handle dynamic 'to' prop values", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test({ userId }) {
+  return <Link to={\`/user/\${userId}\`}>User Profile</Link>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain("href={`/user/${userId}`}")
+      expect(result).not.toContain("to={`/user/${userId}`}")
+    })
+  })
+
+  describe("edge cases", () => {
+    it("should not transform Links without 'to' prop", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link href="/already-href">Already has href</Link>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null) // No changes needed
+    })
+
+    it("should not transform if Link is not imported from tapestry-react", () => {
+      const input = `
+import { Link } from "react-router-dom"
+
+export default function Test() {
+  return <Link to="/dashboard">Dashboard</Link>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null) // No changes needed
+    })
+
+    it("should handle aliased Link import", () => {
+      const input = `
+import { Link as TapestryLink } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <TapestryLink to="/dashboard">Dashboard</TapestryLink>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('href="/dashboard"')
+      expect(result).not.toContain('to="/dashboard"')
+    })
+
+    it("should handle self-closing Link tags", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link to="/dashboard" />
+}
+      `.trim()
+
+      const expected = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link href="/dashboard" />;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result?.trim()).toBe(expected)
+    })
+  })
+
+  describe("mixed scenarios", () => {
+    it("should handle mixed Link elements with various props", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <nav>
+      <Link to="/home" className="home-link">Home</Link>
+      <Link to="/profile" target="_blank">Profile</Link>
+      <Link href="/already-href">Already Good</Link>
+    </nav>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain('href="/home"')
+      expect(result).toContain('href="/profile"')
+      expect(result).toContain('href="/already-href"')
+      expect(result).not.toContain('to="/home"')
+      expect(result).not.toContain('to="/profile"')
+    })
+
+    it("should handle complex JSX expressions", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test({ items }) {
+  return (
+    <div>
+      {items.map(item => (
+        <Link key={item.id} to={item.url}>{item.name}</Link>
+      ))}
+      {showConditional && <Link to="/conditional">Conditional</Link>}
+    </div>
+  )
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toContain("href={item.url}")
+      expect(result).toContain('href="/conditional"')
+      expect(result).not.toContain("to={item.url}")
+      expect(result).not.toContain('to="/conditional"')
+    })
+  })
+
+  describe("no changes scenarios", () => {
+    it("should return null when no tapestry-react Links exist", () => {
+      const input = `
+import React from "react"
+
+export default function Test() {
+  return <div>No Links here</div>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null)
+    })
+
+    it("should return null when no Links have 'to' prop", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link href="/already-good">Already Good</Link>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null)
+    })
+
+    it("should return null for empty file", () => {
+      const result = applyTransform("")
+      expect(result).toBe(null)
+    })
+  })
+})

package/src/components/link/transforms/toToHref.ts

@@ -0,0 +1,14 @@
+import { transformAttributeName } from "../../shared/actions/transformAttributeName"
+import { hasAttribute } from "../../shared/conditions/hasAttribute"
+import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
+
+const transform = attributeTransformFactory({
+  condition: hasAttribute("to"),
+  targetComponent: "Link",
+  targetPackage: "@planningcenter/tapestry-react",
+  transform: (element) => {
+    return transformAttributeName("to", "href", { element })
+  },
+})
+
+export default transform

package/src/components/shared/actions/addAttribute.test.ts

@@ -266,6 +266,94 @@ describe("addAttribute", () => {
     })
   })
 
+  describe("boolean shorthand values", () => {
+    it("should add boolean true attribute as shorthand", () => {
+      const element = createElementFromCode("<Button>Save</Button>")
+
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "external",
+        value: true,
+      })
+
+      const externalAttr = getAttributeFromElement(element, "external")
+      expect(externalAttr).not.toBeNull()
+      expect(externalAttr?.value).toBeNull() // Shorthand boolean has no value
+    })
+
+    it("should not add boolean false attribute as shorthand", () => {
+      const element = createElementFromCode("<Button>Save</Button>")
+      const initialAttrCount = (element.openingElement.attributes || []).length
+
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "external",
+        value: false,
+      })
+
+      const finalAttrCount = (element.openingElement.attributes || []).length
+      expect(finalAttrCount).toBe(initialAttrCount)
+
+      const externalAttr = getAttributeFromElement(element, "external")
+      expect(externalAttr).toBeNull()
+    })
+
+    it("should render shorthand boolean correctly in source", () => {
+      const source = j("<Button>Save</Button>")
+      const element = source.find(j.JSXElement).at(0).get().value as JSXElement
+
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "external",
+        value: true,
+      })
+
+      const result = source.toSource()
+      expect(result).toContain("external") // Should be just "external", not "external={true}"
+      expect(result).not.toContain("external={true}")
+    })
+
+    it("should handle multiple shorthand boolean attributes", () => {
+      const element = createElementFromCode("<Button>Save</Button>")
+
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "external",
+        value: true,
+      })
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "loading",
+        value: false,
+      })
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "disabled",
+        value: true,
+      })
+
+      const externalAttr = getAttributeFromElement(element, "external")
+      const loadingAttr = getAttributeFromElement(element, "loading")
+      const disabledAttr = getAttributeFromElement(element, "disabled")
+
+      expect(externalAttr).not.toBeNull()
+      expect(loadingAttr).toBeNull() // false values should not be added
+      expect(disabledAttr).not.toBeNull()
+    })
+  })
+
   describe("integration with JSCodeshift", () => {
     it("should render correctly in transformed source", () => {
       const source = j("<Button>Save</Button>")
@@ -296,5 +384,25 @@ describe("addAttribute", () => {
       expect((testIdAttr?.value as StringLiteral)?.value).toBe("save-button")
       expect((ariaAttr?.value as StringLiteral)?.value).toBe("help-text")
     })
+
+    it("should render shorthand boolean attributes correctly in source", () => {
+      const source = j("<Button>Save</Button>")
+      const element = source.find(j.JSXElement).at(0).get().value as JSXElement
+
+      addAttribute({
+        booleanAsShorthand: true,
+        element,
+        j,
+        name: "external",
+        value: true,
+      })
+      addAttribute({ element, j, name: "disabled", value: true }) // Regular boolean
+
+      const result = source.toSource()
+
+      expect(result).toContain("external") // Shorthand boolean
+      expect(result).toContain("disabled={true}") // Regular boolean
+      expect(result).not.toContain("external={true}")
+    })
   })
 })

package/src/components/shared/actions/addAttribute.ts

@@ -21,7 +21,9 @@ export function addAttribute({
   name,
   j,
   value,
+  booleanAsShorthand = false,
 }: {
+  booleanAsShorthand?: boolean
   element: JSXElement
   j: JSCodeshift
   name: string
@@ -40,6 +42,18 @@ export function addAttribute({
     return
   }
 
+  // Handle boolean shorthand
+  // booleanAsShorthand is a temporary flag to allow for boolean attributes to be added as shorthand
+  // This will be removed in a follow-up PR for button[disabled]
+  if (typeof value === "boolean" && booleanAsShorthand) {
+    if (value === true) {
+      // Add as shorthand boolean attribute (just "external")
+      attributes.push(j.jsxAttribute(j.jsxIdentifier(name), null))
+    }
+    // For false, don't add the attribute at all
+    return
+  }
+
   const formattedValue = formatValue(value, j)
   attributes.push(j.jsxAttribute(j.jsxIdentifier(name), formattedValue))
 }

package/src/components/shared/actions/removeAttribute.ts

@@ -7,6 +7,7 @@ import { getPrintableAttributeValue } from "./getPrintableAttributeValue"
 type RemoveAttributeConfig = {
   /** Function to build comment text given the prop name and formatted value */
   buildComment?: (propName: string, formattedValue: string) => string | void
+  commentScope?: string
   element: JSXElement
   j: JSCodeshift
   source: Collection
@@ -14,7 +15,7 @@ type RemoveAttributeConfig = {
 
 export function removeAttribute(
   name: string,
-  { element, buildComment, j, source }: RemoveAttributeConfig
+  { element, buildComment, j, source, commentScope }: RemoveAttributeConfig
 ): boolean {
   const attributes = element.openingElement.attributes || []
   const attribute = findAttribute(attributes, name)
@@ -28,7 +29,13 @@ export function removeAttribute(
     const commentText = buildComment(name, printableValue || "")
 
     if (commentText) {
-      addComment({ element, j, scope: name, source, text: commentText })
+      addComment({
+        element,
+        j,
+        scope: commentScope || name,
+        source,
+        text: commentText,
+      })
     }
   }
 

package/src/components/shared/actions/transformElementName.ts

@@ -1,7 +1,8 @@
-import { JSXElement } from "jscodeshift"
+import { JSXElement, jsxIdentifier } from "jscodeshift"
 
 /**
  * Transforms JSX element names (both opening and closing tags)
+ * Supports both JSXIdentifier and JSXMemberExpression
  */
 export function transformElementName({
   element,
@@ -10,15 +11,28 @@ export function transformElementName({
   element: JSXElement
   name: string
 }): boolean {
-  if (element?.openingElement?.name?.type === "JSXIdentifier") {
-    element.openingElement.name.name = name
+  const openingName = element?.openingElement?.name
+  if (!openingName) return false
 
-    if (element.closingElement) {
-      if (element.closingElement.name.type === "JSXIdentifier") {
-        element.closingElement.name.name = name
-      }
+  // Transform opening element
+  if (openingName.type === "JSXIdentifier") {
+    openingName.name = name
+  } else if (openingName.type === "JSXMemberExpression") {
+    // Transform JSXMemberExpression (e.g., Link.Inline) to JSXIdentifier (e.g., Link)
+    element.openingElement.name = jsxIdentifier(name)
+  } else {
+    return false
+  }
+
+  // Transform closing element if it exists
+  if (element.closingElement) {
+    const closingName = element.closingElement.name
+    if (closingName.type === "JSXIdentifier") {
+      closingName.name = name
+    } else if (closingName.type === "JSXMemberExpression") {
+      element.closingElement.name = jsxIdentifier(name)
     }
-    return true
   }
-  return false
+
+  return true
 }

package/src/components/shared/transformFactories/attributeTransformFactory.test.ts

@@ -85,4 +85,87 @@ describe("attributeTransformFactory", () => {
     const result = transform(fileInfo, api, {})
     expect(result).toBe(null)
   })
+
+  describe("member expression support", () => {
+    it("should transform attributes on Link.Inline elements", () => {
+      const transform = attributeTransformFactory({
+        condition: () => true,
+        targetComponent: "Link.Inline",
+        targetPackage: "@planningcenter/tapestry-react",
+        transform: (element, { j }) => {
+          const attributes = element.openingElement.attributes || []
+          const kindAttr = j.jsxAttribute(
+            j.jsxIdentifier("kind"),
+            j.stringLiteral("inline-text")
+          )
+          attributes.push(kindAttr)
+          return true
+        },
+      })
+      const fileInfo = {
+        path: "test.tsx",
+        source: `import { Link } from "@planningcenter/tapestry-react";<Link.Inline>Test</Link.Inline>`,
+      }
+      const api = { j, jscodeshift: j, report: () => {}, stats: () => {} }
+
+      const result = transform(fileInfo, api, {})
+      expect(result).toContain('kind="inline-text"')
+      expect(result).toContain("<Link.Inline")
+    })
+
+    it("should not transform other member expressions", () => {
+      const transform = attributeTransformFactory({
+        condition: () => true,
+        targetComponent: "Link.Inline",
+        targetPackage: "@planningcenter/tapestry-react",
+        transform: (element, { j }) => {
+          const attributes = element.openingElement.attributes || []
+          const kindAttr = j.jsxAttribute(
+            j.jsxIdentifier("kind"),
+            j.stringLiteral("inline-text")
+          )
+          attributes.push(kindAttr)
+          return true
+        },
+      })
+      const fileInfo = {
+        path: "test.tsx",
+        source: `import { Link } from "@planningcenter/tapestry-react";<div><Link.Inline>Inline</Link.Inline><Link.Primary>Primary</Link.Primary></div>`,
+      }
+      const api = { j, jscodeshift: j, report: () => {}, stats: () => {} }
+
+      const result = transform(fileInfo, api, {})
+      expect(result).toContain(
+        '<Link.Inline kind="inline-text">Inline</Link.Inline>'
+      )
+      expect(result).toContain("<Link.Primary>Primary</Link.Primary>")
+      expect(result).not.toContain('<Link.Primary kind="inline-text">')
+    })
+
+    it("should handle aliased imports with member expressions", () => {
+      const transform = attributeTransformFactory({
+        condition: () => true,
+        targetComponent: "Link.Inline",
+        targetPackage: "@planningcenter/tapestry-react",
+        transform: (element, { j }) => {
+          const attributes = element.openingElement.attributes || []
+          const kindAttr = j.jsxAttribute(
+            j.jsxIdentifier("kind"),
+            j.stringLiteral("inline-text")
+          )
+          attributes.push(kindAttr)
+          return true
+        },
+      })
+      const fileInfo = {
+        path: "test.tsx",
+        source: `import { Link as TapestryLink } from "@planningcenter/tapestry-react";<TapestryLink.Inline>Test</TapestryLink.Inline>`,
+      }
+      const api = { j, jscodeshift: j, report: () => {}, stats: () => {} }
+
+      const result = transform(fileInfo, api, {})
+      expect(result).toContain('kind="inline-text"')
+      expect(result).toContain("<TapestryLink.Inline")
+    })
+  })
 })

package/src/components/shared/transformFactories/attributeTransformFactory.ts

@@ -7,6 +7,7 @@ import {
 } from "jscodeshift"
 
 import { TransformCondition } from "../types"
+import { findJSXElements } from "./helpers/findJSXElements"
 import { getImportName } from "./helpers/manageImports"
 
 /**
@@ -15,7 +16,7 @@ import { getImportName } from "./helpers/manageImports"
 export function attributeTransformFactory(config: {
   /** Condition that must be met for the transform to occur */
   condition?: TransformCondition
-  /** Component to target for attribute transformation */
+  /** Component to target for attribute transformation (supports member expressions like "Link.Inline") */
   targetComponent: string
   /** Package the target component is imported from */
   targetPackage: string
@@ -30,32 +31,38 @@ export function attributeTransformFactory(config: {
     const source = j(fileInfo.source)
     let hasChanges = false
 
+    // Parse the targetComponent to handle member expressions
+    const [targetComponentName] = config.targetComponent.split(".")
+
     // Get the local name of the target component
-    const targetComponentName = getImportName(
-      config.targetComponent,
+    const targetComponentLocalName = getImportName(
+      targetComponentName,
       config.targetPackage,
       { j, source }
     )
 
     // Only proceed if target component is imported
-    if (!targetComponentName) {
+    if (!targetComponentLocalName) {
       return null
     }
 
     const { condition = () => true, transform } = config
 
     // Find and transform matching JSX elements
-    source
-      .find(j.JSXOpeningElement, { name: { name: targetComponentName } })
-      .forEach((path) => {
-        const element = path.parent.value
-
-        if (condition(element)) {
-          if (transform(element, { j, options, source })) {
-            hasChanges = true
-          }
+    findJSXElements(
+      source,
+      j,
+      config.targetComponent,
+      targetComponentLocalName
+    ).forEach((path) => {
+      const element = path.parent.value
+
+      if (condition(element)) {
+        if (transform(element, { j, options, source })) {
+          hasChanges = true
         }
-      })
+      }
+    })
 
     return hasChanges ? source.toSource() : null
   }