@planningcenter/tapestry-migration-cli 3.5.0 → 3.6.0

package/README.md

@@ -127,11 +127,48 @@ npx @planningcenter/tapestry-migration-cli run button -p ./src/components --js-t
 npx @planningcenter/tapestry-migration-cli run button -p ./src/components --js-theme ./theme.js --report-path ./migration-report.md
 ```
 
+### Listing available migrations
+
+Use `list --json` to discover available migrations programmatically:
+
+```bash
+npx @planningcenter/tapestry-migration-cli list --json
+```
+
+**Stable JSON contract (stdout, exit 0):**
+
+```json
+{
+  "schemaVersion": 1,
+  "migrations": [
+    { "id": "button", "label": "Button" },
+    { "id": "checkbox", "label": "Checkbox" }
+  ]
+}
+```
+
+Contract guarantees:
+
+- Exit code `0` and **JSON only** on stdout — no progress text or emoji.
+- `schemaVersion` is the integer `1`. Future breaking changes increment this version.
+- Each `id` is the exact value accepted by `run <component-name>`.
+- Each `label` is nonempty display text (Spaced Title Case).
+- `id`s are unique; ordering is the CLI's recommended display order.
+- No `--path` required; no filesystem writes.
+- Diagnostics go to **stderr** with a **nonzero** exit code.
+
+Human-readable listing (non-contractual):
+
+```bash
+npx @planningcenter/tapestry-migration-cli list
+```
+
 ## Available Components
 
 - `button` - Migrate Button components
 - `checkbox` - Migrate Checkbox components
 - `date-picker` - Migrate DatePicker components
+- `dropdown` - Migrate Dropdown components
 - `input` - Migrate Input components
 - `link` - Migrate Link components
 - `radio` - Migrate Radio components

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@planningcenter/tapestry-migration-cli",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "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.5.0",
+    "@planningcenter/tapestry": "^3.6.0",
     "@planningcenter/tapestry-react": "^4.11.5",
     "@types/jscodeshift": "^17.3.0",
     "@types/node": "^20.0.0",
@@ -50,5 +50,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "958f1f269ca37d78e9a9c0ec66c208a7115331dc"
+  "gitHead": "0009d96d1c39de5978d2cdea8334ca5120974137"
 }

package/src/availableComponents.ts

@@ -3,6 +3,7 @@ export const AVAILABLE_CLI_COMPONENTS = new Set([
   "checkbox",
   "date-picker",
   "dropdown",
+  "flex",
   "input",
   "link",
   "radio",

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

@@ -84,9 +84,9 @@ export default function Test() {
 
       expect(result).toContain('<Tooltip {...{title: "Help"}}')
       expect(result).toContain("refAsInnerRef={false}")
-      expect(result).toContain(
-        '<Button variant="primary" onClick={handler} disabled>Save</Button>'
-      )
+      expect(result).toContain('variant="primary"')
+      expect(result).toContain("onClick={handler}")
+      expect(result).toContain("disabled>Save</Button>")
       expect(result).not.toContain("tooltip=")
     })
 
@@ -323,6 +323,53 @@ export default function Test({ items }) {
       expect(result).not.toContain("tooltip=")
     })
 
+    it("should add a TODO comment when the Button is disabled", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button tooltip={{ title: "Save" }} disabled>Save</Button>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+
+      expect(result).toContain("TODO: tapestry-migration (disabled):")
+      expect(result).toContain("<Tooltip")
+      expect(result).toContain("disabled>Save</Button>")
+      expect(result).not.toContain("tooltip=")
+    })
+
+    it("should add a TODO comment when disabled has an expression value", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test({ isDisabled }) {
+  return <Button tooltip={{ title: "Save" }} disabled={isDisabled}>Save</Button>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+
+      expect(result).toContain("TODO: tapestry-migration (disabled):")
+      expect(result).toContain("disabled={isDisabled}")
+    })
+
+    it("should not add a disabled TODO comment when the Button is not disabled", () => {
+      const input = `
+import { Button } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Button tooltip={{ title: "Save" }}>Save</Button>
+}
+      `.trim()
+
+      const result = applyTransform(input)
+
+      expect(result).toContain("<Tooltip")
+      expect(result).not.toContain("TODO: tapestry-migration (disabled):")
+    })
+
     it("should handle empty tooltip attribute", () => {
       const input = `
 import { Button } from "@planningcenter/tapestry-react"

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

@@ -1,5 +1,7 @@
 import { addAttribute } from "../../shared/actions/addAttribute"
+import { addCommentToAttribute } from "../../shared/actions/addCommentToAttribute"
 import { createWrapper } from "../../shared/actions/createWrapper"
+import { getAttribute } from "../../shared/actions/getAttribute"
 import { getAttributeValueAsProps } from "../../shared/actions/getAttributeValueAsProps"
 import { removeAttribute } from "../../shared/actions/removeAttribute"
 import { hasAttribute } from "../../shared/conditions/hasAttribute"
@@ -19,6 +21,11 @@ const transform = attributeTransformFactory({
 
     removeAttribute("tooltip", { element, j, source })
 
+    // Capture the original Button's `disabled` attribute before `createWrapper`
+    // replaces `element` in the AST, so the comment below clearly attaches to
+    // the original Button attribute node.
+    const disabledAttribute = getAttribute({ element, name: "disabled" })
+
     const wrapperElement = createWrapper({
       conflictAlias: "TRTooltip",
       element,
@@ -36,6 +43,17 @@ const transform = attributeTransformFactory({
       value: false,
     })
 
+    if (disabledAttribute) {
+      addCommentToAttribute({
+        attribute: disabledAttribute,
+        j,
+        text:
+          "This Button is disabled. Disabled buttons don't emit pointer or focus events, " +
+          "so the wrapping Tooltip will not appear. Keep the button interactive (e.g. handle " +
+          "the disabled state without the native `disabled` attribute) so the Tooltip can trigger.",
+      })
+    }
+
     return true
   },
 })

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

@@ -0,0 +1,140 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./index"
+
+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("flex orchestrator", () => {
+  it("applies setDefaultAxis through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('<Flex direction="column">Test</Flex>')
+    expect(result).not.toContain("axis")
+  })
+
+  it("applies axisToDirection through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('<Flex direction="row">Test</Flex>')
+    expect(result).not.toContain("axis")
+  })
+
+  it("applies alignmentToAlign through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal" alignment="center">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="center"')
+    expect(result).not.toContain("alignment")
+  })
+
+  it("applies distributionToJustify through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal" distribution="center">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('justify="center"')
+    expect(result).not.toContain("distribution")
+  })
+
+  it("applies spacingToGap through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal" spacing={2}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("gap={2}")
+    expect(result).not.toContain("spacing")
+  })
+
+  it("applies innerRefToRef through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal" innerRef={myRef}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("ref={myRef}")
+    expect(result).not.toContain("innerRef")
+  })
+
+  it("applies moveFlexImport through the chain", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('import { Flex } from "@planningcenter/tapestry"')
+    expect(result).not.toContain("StackView")
+    expect(result).not.toContain('from "@planningcenter/tapestry-react"')
+  })
+
+  it("returns null when there is nothing to transform", () => {
+    const input = `
+import { Flex } from "@planningcenter/tapestry"
+
+export default function Test() {
+  return <Flex>Test</Flex>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+
+  it("returns null for an empty file", () => {
+    expect(applyTransform("")).toBe(null)
+  })
+
+  it("does not throw for arbitrary source", () => {
+    expect(() =>
+      applyTransform(
+        `import React from "react"\nexport default function Noop() { return <div /> }`
+      )
+    ).not.toThrow()
+  })
+})

package/src/components/flex/index.ts

@@ -0,0 +1,40 @@
+import { Transform } from "jscodeshift"
+
+import alignmentToAlign from "./transforms/alignmentToAlign"
+import axisToDirection from "./transforms/axisToDirection"
+import distributionToJustify from "./transforms/distributionToJustify"
+import innerRefToRef from "./transforms/innerRefToRef"
+import moveFlexImport from "./transforms/moveFlexImport"
+import setDefaultAxis from "./transforms/setDefaultAxis"
+import spacingToGap from "./transforms/spacingToGap"
+
+const transform: Transform = (fileInfo, api, options) => {
+  let currentSource = fileInfo.source
+  let hasAnyChanges = false
+
+  const transforms = [
+    setDefaultAxis,
+    axisToDirection,
+    alignmentToAlign,
+    distributionToJustify,
+    spacingToGap,
+    innerRefToRef,
+    moveFlexImport,
+  ]
+
+  for (const individualTransform of transforms) {
+    const result = individualTransform(
+      { ...fileInfo, source: currentSource },
+      api,
+      options
+    )
+    if (result && result !== currentSource) {
+      currentSource = result as string
+      hasAnyChanges = true
+    }
+  }
+
+  return hasAnyChanges ? currentSource : null
+}
+
+export default transform

package/src/components/flex/transforms/alignmentToAlign.test.ts

@@ -0,0 +1,185 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./alignmentToAlign"
+
+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("alignmentToAlign transform", () => {
+  it("renames alignment to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment="center">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="center"')
+    expect(result).not.toContain("alignment")
+  })
+
+  it("resolves StackView.CENTER constant to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.CENTER}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="center"')
+    expect(result).not.toContain("alignment")
+    expect(result).not.toContain("StackView.CENTER")
+  })
+
+  it("resolves StackView.START constant to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.START}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="start"')
+    expect(result).not.toContain("StackView.START")
+  })
+
+  it("resolves StackView.END constant to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.END}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="end"')
+    expect(result).not.toContain("StackView.END")
+  })
+
+  it("resolves StackView.STRETCH constant to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.STRETCH}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="stretch"')
+    expect(result).not.toContain("StackView.STRETCH")
+  })
+
+  it("resolves StackView.BASELINE constant to align", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.BASELINE}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="baseline"')
+    expect(result).not.toContain("StackView.BASELINE")
+  })
+
+  it("flags alignment={StackView.FILL} with a TODO and leaves it in place", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment={StackView.FILL}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("alignment={StackView.FILL}")
+    expect(result).toContain("TODO: tapestry-migration (alignment)")
+    expect(result).not.toContain('align="')
+  })
+
+  it('flags alignment="fill" with a TODO and leaves it in place', () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView alignment="fill">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('alignment="fill"')
+    expect(result).toContain("TODO: tapestry-migration (alignment)")
+    expect(result).not.toContain('align="')
+  })
+
+  it("flags a dynamic alignment value with a TODO", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test({ alignProp }) {
+  return <StackView alignment={alignProp}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("alignment={alignProp}")
+    expect(result).toContain("TODO: tapestry-migration (alignment)")
+    expect(result).not.toContain('align="')
+  })
+
+  it("respects an aliased StackView import", () => {
+    const input = `
+import { StackView as Stack } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Stack alignment="center">Test</Stack>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="center"')
+    expect(result).not.toContain("alignment")
+  })
+
+  it("returns null when there is no alignment to migrate", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+
+  it("returns null when StackView is not imported from tapestry-react", () => {
+    const input = `
+import { StackView } from "some-other-package"
+
+export default function Test() {
+  return <StackView alignment="center">Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+})

package/src/components/flex/transforms/alignmentToAlign.ts

@@ -0,0 +1,73 @@
+import { Transform } from "jscodeshift"
+
+import { addComment } from "../../shared/actions/addComment"
+import { getAttribute } from "../../shared/actions/getAttribute"
+import { resolveConstantAttributeValue } from "../../shared/actions/resolveConstantAttributeValue"
+import { hasAttribute } from "../../shared/conditions/hasAttribute"
+import { attributeTransformFactory } from "../../shared/transformFactories/attributeTransformFactory"
+
+const VALID_ALIGN_VALUES = new Set([
+  "start",
+  "center",
+  "end",
+  "stretch",
+  "baseline",
+])
+
+const CONSTANT_ALIGN_MAP: Record<string, string> = {
+  BASELINE: "baseline",
+  CENTER: "center",
+  END: "end",
+  FILL: "fill",
+  START: "start",
+  STRETCH: "stretch",
+}
+
+const transform: Transform = attributeTransformFactory({
+  condition: hasAttribute("alignment"),
+  targetComponent: "StackView",
+  targetPackage: "@planningcenter/tapestry-react",
+  transform: (element, { j, source }) => {
+    const alignmentAttribute = getAttribute({ element, name: "alignment" })
+    if (!alignmentAttribute) return false
+
+    const resolved = resolveConstantAttributeValue({
+      attribute: alignmentAttribute,
+      constantMap: CONSTANT_ALIGN_MAP,
+    })
+    const alignValue =
+      resolved !== null &&
+      (VALID_ALIGN_VALUES.has(resolved) || resolved === "fill")
+        ? resolved
+        : null
+
+    if (alignValue === null) {
+      addComment({
+        element,
+        j,
+        scope: "alignment",
+        source,
+        text: "could not migrate alignment to align automatically; convert this value to start, center, end, stretch, or baseline manually",
+      })
+      return true
+    }
+
+    if (alignValue === "fill") {
+      addComment({
+        element,
+        j,
+        scope: "alignment",
+        source,
+        text: 'alignment="fill" has no Flex equivalent; remove this prop and use expand on the child element instead',
+      })
+      return true
+    }
+
+    alignmentAttribute.name.name = "align"
+    alignmentAttribute.value = j.stringLiteral(alignValue)
+
+    return true
+  },
+})
+
+export default transform