@planningcenter/tapestry-migration-cli 2.4.0-rc.2 → 2.4.0-rc.20

package/README.md

@@ -1,12 +1,106 @@
 # tapestry-migration-cli
 
-A simple cli tool used to help to migration Tapestry React components to formats that match Planning Center specs (usually to `@planningcenter/tapestry` components).
+A CLI tool to migrate Tapestry React components to Planning Center's Tapestry format.
 
-## Quick Use
+## Installation
 
 ```bash
-# For help
-npx @planningcenter/tapestry-migration-cli
-# Run a migration with autofixing
-npx @planningcenter/tapestry-migration-cli run ComponentName -p ./path/to/files -f
+yarn add --dev @planningcenter/tapestry-migration-cli
+```
+
+## Usage
+
+### Recommended Migration Order
+
+For optimal results, migrate components in this order:
+
+1. **Button components first**: `npx @planningcenter/tapestry-migration-cli run button -p ./src/components --fix`
+2. **Link components second**: `npx @planningcenter/tapestry-migration-cli run link -p ./src/components --fix`
+
+This order ensures that Button components with navigation props are properly handled before Link components are migrated.
+
+### Basic Commands
+
+```bash
+# Run a dry-run migration (preview changes)
+npx @planningcenter/tapestry-migration-cli run button -p ./src/components
+
+# Apply the migration changes
+npx @planningcenter/tapestry-migration-cli run button -p ./src/components --fix
+
+# Run with verbose output
+npx @planningcenter/tapestry-migration-cli run button -p ./src/components --fix --verbose
+
+# Generate a migration report
+npx @planningcenter/tapestry-migration-cli run button -p ./src/components --fix --report-path ./migration-report.md
+```
+
+## Available Components
+
+- `button` - Migrate Button components
+- `link` - Migrate Link components
+
+## Required Arguments
+
+- `-p, --path <path>` - **REQUIRED**: Path to the folder or file to migrate
+
+## Optional Arguments
+
+- `-f, --fix` - Write changes to files (without this flag, it's a dry run)
+- `-v, --verbose` - Show detailed output
+- `-j, --js-theme <path>` - Path to JavaScript theme file
+- `-r, --report-path <path>` - Path for migration report (default: MIGRATION_REPORT.md)
+
+## How It Works
+
+The migration tool automatically transforms your components to match Planning Center's current Tapestry specifications. Most property and usage changes are handled automatically, including:
+
+- Converting deprecated props to their modern equivalents
+- Updating import statements and component references
+- Adjusting prop names and values to match current API
+
+### Unsupported Props
+
+For properties that cannot be automatically migrated, the tool will:
+
+1. **Keep the prop as-is** - The prop remains in your code but will not work with the new Tapestry component
+2. **Add a TODO comment** - Flagging the prop for manual migration
+
+Example of an unsupported prop comment:
+
+```tsx
+<Button
+  /* TODO: tapestry-migration (propName): 'mediaQueries' is not supported, please migrate as needed.
+   * It is recommended to use CSS media queries in a class that you apply to the component.
+   */
+  mediaQueries={{ mobile: { fontSize: 14 } }}
+>
+  Click me
+</Button>
+```
+
+The comment includes guidance on how to handle the unsupported prop. Common recommendations include:
+
+- Using CSS classes for styling instead of props
+- Moving state-based styles (hover, focus, active) to CSS selectors
+- Applying responsive styles through CSS media queries
+
+## Alternative: Local Installation
+
+If you prefer to install it locally and use a shorter command:
+
+```bash
+# Install locally
+yarn add --dev @planningcenter/tapestry-migration-cli
+
+# Add to package.json scripts
+{
+  "scripts": {
+    "migrate": "tapestry-migration-cli"
+  }
+}
+
+# Then run (following recommended order)
+yarn migrate run button -p app/javascript/components --fix
+yarn migrate run link -p app/javascript/components --fix
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planningcenter/tapestry-migration-cli",
-  "version": "2.4.0-rc.2",
+  "version": "2.4.0-rc.20",
   "description": "CLI tool for Tapestry migrations",
   "type": "module",
   "main": "dist/index.js",
@@ -51,5 +51,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0fed8f48bc9031002e1fcb5c7bd2d76237745c48"
+  "gitHead": "bcad7a2b3f0b5f30db8cf3675f6089dbc91d0148"
 }

package/src/components/button/index.ts

@@ -8,7 +8,7 @@ import convertStyleProps from "./transforms/convertStyleProps"
 import iconLeftToPrefix from "./transforms/iconLeftToPrefix"
 import iconRightToSuffix from "./transforms/iconRightToSuffix"
 import iconToIconButton from "./transforms/iconToIconButton"
-import linkToButton from "./transforms/linkToButton"
+import innerRefToRef from "./transforms/innerRefToRef"
 import moveButtonImport from "./transforms/moveButtonImport"
 import removeAsButton from "./transforms/removeAsButton"
 import removeDuplicateKeys from "./transforms/removeDuplicateKeys"
@@ -47,7 +47,6 @@ const transform: Transform = async (fileInfo, api, options) => {
   }
 
   const transforms = [
-    linkToButton,
     tooltipToWrapper,
     iconRightToSuffix,
     iconLeftToPrefix,
@@ -55,16 +54,17 @@ const transform: Transform = async (fileInfo, api, options) => {
     themeVariantToKind,
     titleToLabel,
     childrenToLabel,
+    innerRefToRef,
     removeToTransform,
     removeDuplicateKeys,
     removeAsButton,
     removeTypeButton,
     auditSpreadProps,
     reviewStyles,
+    spinnerToLoadingButton,
     convertStyleProps,
     unsupportedProps,
     iconToIconButton,
-    spinnerToLoadingButton,
     moveButtonImport,
   ]
 

package/src/components/button/transforms/childrenToLabel.test.ts

@@ -105,10 +105,10 @@ function Test() {
         "{/* TODO: tapestry-migration (children): complex children cannot be converted to label prop"
       )
       expect(result).toContain(
-        "take time to find the right text for the button"
+        "take time to find the right text for the component"
       )
       expect(result).toContain(
-        "prefix and suffix to correctly display those icons"
+        "If icons are used in the component, you can use prefix and suffix to correctly display those icons"
       )
       expect(result).toContain('<Icon name="save" />')
       expect(result).toContain("Save")
@@ -177,8 +177,9 @@ function Test() {
         "{/* TODO: tapestry-migration (label): Button has both label prop and children"
       )
       expect(result).toContain(
-        "take time to find the right text for the button"
+        "take time to find the right text for the component."
       )
+      expect(result).not.toContain("If icons are used")
       expect(result).toContain('label="Existing Label"')
       expect(result).toContain("Child Content")
     })
@@ -356,7 +357,7 @@ function Test() {
       expect(result).toMatch(/\{\s*\/\*\s*TODO: tapestry-migration/)
       expect(result).toMatch(/\*\/\s*\}/)
       expect(result).toContain(
-        "take time to find the right text for the button"
+        "take time to find the right text for the component"
       )
     })
   })

package/src/components/button/transforms/childrenToLabel.ts

@@ -1,48 +1,17 @@
-import { JSXElement } from "jscodeshift"
+import { Transform } from "jscodeshift"
 
 import { addAttribute } from "../../shared/actions/addAttribute"
 import { addComment } from "../../shared/actions/addComment"
 import { removeChildren } from "../../shared/actions/removeChildren"
 import { hasAttribute } from "../../shared/conditions/hasAttribute"
 import { hasChildren } from "../../shared/conditions/hasChildren"
+import {
+  buildComment,
+  extractTextContent,
+} from "../../shared/helpers/childrenToLabelHelpers"
 import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
 
-function extractTextContent(children: NonNullable<JSXElement["children"]>): {
-  isSimpleText: boolean
-  textContent: string
-} {
-  let textContent = ""
-
-  for (const child of children) {
-    if (child.type === "JSXText") {
-      const text = child.value.trim()
-      if (text) textContent += text
-    } else if (
-      child.type === "JSXExpressionContainer" &&
-      child.expression.type === "StringLiteral"
-    ) {
-      textContent += child.expression.value
-    } else if (
-      child.type === "JSXExpressionContainer" &&
-      child.expression.type === "TemplateLiteral" &&
-      child.expression.expressions.length === 0
-    ) {
-      // Simple template literal with no expressions like `hello`
-      textContent += child.expression.quasis[0].value.raw
-    } else {
-      // Complex content (JSX elements, expressions, etc.)
-      return { isSimpleText: false, textContent: "" }
-    }
-  }
-
-  return { isSimpleText: true, textContent }
-}
-
-function buildComment(message: string): string {
-  return `${message} - take time to find the right text for the button. If icons are used in the Button, you can use prefix and suffix to correctly display those icons.`
-}
-
-const transform = attributeTransformFactory({
+const transform: Transform = attributeTransformFactory({
   condition: hasChildren,
   targetComponent: "Button",
   targetPackage: "@planningcenter/tapestry-react",
@@ -53,7 +22,7 @@ const transform = attributeTransformFactory({
         j,
         scope: "label",
         source,
-        text: buildComment("Button has both label prop and children"),
+        text: buildComment("Button has both label prop and children", false),
       })
       return true
     }
@@ -71,7 +40,8 @@ const transform = attributeTransformFactory({
         scope: "children",
         source,
         text: buildComment(
-          "complex children cannot be converted to label prop"
+          "complex children cannot be converted to label prop",
+          true
         ),
       })
       return true

package/src/components/button/transforms/innerRefToRef.test.ts

@@ -0,0 +1,170 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./innerRefToRef"
+
+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("innerRefToRef transform", () => {
+  describe("basic transformations", () => {
+    it("should transform Button 'innerRef' prop to 'ref' prop", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button innerRef={buttonRef}>Click me</Button>
+}
+      `.trim()
+
+      const expected = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button ref={buttonRef}>Click me</Button>;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(expected)
+    })
+
+    it("should transform Button 'innerRef' prop to 'ref' prop with function", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button innerRef={(el) => setButtonRef(el)}>Click me</Button>
+}
+      `.trim()
+
+      const expected = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button ref={(el) => setButtonRef(el)}>Click me</Button>;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(expected)
+    })
+
+    it("should transform Button 'innerRef' prop to 'ref' prop with useRef", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+import { useRef } from "react"
+
+export default function Test() {
+  const buttonRef = useRef(null)
+  return <Button innerRef={buttonRef}>Click me</Button>
+}
+      `.trim()
+
+      const expected = `
+import { Button } from "@planningcenter/tapestry-react"
+import { useRef } from "react"
+
+export default function Test() {
+  const buttonRef = useRef(null)
+  return <Button ref={buttonRef}>Click me</Button>;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(expected)
+    })
+  })
+
+  describe("multiple components", () => {
+    it("should transform multiple Button components with innerRef", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <div>
+      <Button innerRef={buttonRef1}>First</Button>
+      <Button innerRef={buttonRef2}>Second</Button>
+    </div>
+  )
+}
+      `.trim()
+
+      const expected = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return (
+    <div>
+      <Button ref={buttonRef1}>First</Button>
+      <Button ref={buttonRef2}>Second</Button>
+    </div>
+  );
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(expected)
+    })
+  })
+
+  describe("edge cases", () => {
+    it("should not transform Button without innerRef", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button onClick={handleClick}>Click me</Button>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null)
+    })
+
+    it("should not transform other components with innerRef", () => {
+      const input = `
+import { Link } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Link innerRef={linkRef}>Go somewhere</Link>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(null)
+    })
+
+    it("should preserve other props when transforming innerRef", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  const buttonRef = null
+  return <Button innerRef={buttonRef} onClick={() => {}} disabled>Click me</Button>
+}
+      `.trim()
+
+      const expected = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  const buttonRef = null
+  return <Button ref={buttonRef} onClick={() => {}} disabled>Click me</Button>;
+}
+      `.trim()
+
+      const result = applyTransform(input)
+      expect(result).toBe(expected)
+    })
+  })
+})

package/src/components/button/transforms/innerRefToRef.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("innerRef"),
+  targetComponent: "Button",
+  targetPackage: "@planningcenter/tapestry-react",
+  transform: (element) => {
+    return transformAttributeName("innerRef", "ref", { element })
+  },
+})
+
+export default transform

package/src/components/button/transforms/unsupportedProps.ts

@@ -1,44 +1,21 @@
 import { JSXAttribute, Transform } from "jscodeshift"
 
-import { stylePropNames } from "../../../../dist/tapestry-react-shim.cjs"
 import { addCommentToUnsupportedProps } from "../../shared/actions/addCommentToUnsupportedProps"
+import { SUPPORTED_PROPS_BASE } from "../../shared/helpers/unsupportedPropsHelpers"
 import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
 
-const SUPPORTED_PROPS = [
-  ...stylePropNames,
-  "children",
-  "className",
+const BUTTON_SPECIFIC_PROPS = [
   "disabled",
-  "kind",
-  "label",
-  "onClick",
-  "style",
-  "type",
-  "prefix",
-  "suffix",
-  "size",
   "fullWidth",
-  "needsAttention",
-  "key",
-  "external",
-  "id",
-  "onMouseOver",
-  "onMouseOut",
-  "onMouseDown",
-  "onMouseUp",
-  "onKeyUp",
-  "icon",
-  "weight",
-  "tabIndex",
-  "onKeyDown",
-  "onFocus",
-  "onBlur",
-  "role",
+  "loading",
+  "loadingAriaLabel",
   "name",
-  "ref",
-  "spinner", // taken care of by spinnerToLoadingButton transform
+  "type",
+  "icon",
 ]
 
+const SUPPORTED_PROPS = [...SUPPORTED_PROPS_BASE, ...BUTTON_SPECIFIC_PROPS]
+
 const transform: Transform = attributeTransformFactory({
   targetComponent: "Button",
   targetPackage: "@planningcenter/tapestry-react",

package/src/components/link/index.ts

@@ -1,17 +1,37 @@
 import { Transform } from "jscodeshift"
 
-import inlineToKind from "./transforms/inlineToKind"
+import auditSpreadProps from "./transforms/auditSpreadProps"
+import childrenToLabel from "./transforms/childrenToLabel"
+import convertStyleProps from "./transforms/convertStyleProps"
+import innerRefToRef from "./transforms/innerRefToRef"
+import moveLinkImport from "./transforms/moveLinkImport"
+import removeAs from "./transforms/removeAs"
+import removeInlineMember from "./transforms/removeInlineMember"
+import removeInlineProp from "./transforms/removeInlineProp"
+import reviewStyles from "./transforms/reviewStyles"
 import targetBlankToExternal from "./transforms/targetBlankToExternal"
+import tooltipToWrapper from "./transforms/tooltipToWrapper"
 import toToHref from "./transforms/toToHref"
+import unsupportedProps from "./transforms/unsupportedProps"
 
 const transform: Transform = (fileInfo, api, options) => {
   let currentSource = fileInfo.source
   let hasAnyChanges = false
 
   const transforms: Transform[] = [
-    inlineToKind,
+    removeInlineMember,
+    removeInlineProp,
+    tooltipToWrapper,
     toToHref,
     targetBlankToExternal,
+    innerRefToRef,
+    removeAs,
+    childrenToLabel,
+    auditSpreadProps,
+    reviewStyles,
+    convertStyleProps,
+    unsupportedProps,
+    moveLinkImport,
   ]
 
   for (const individualTransform of transforms) {