@planningcenter/tapestry-migration-cli 3.4.1 → 3.6.0

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

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

@@ -0,0 +1,140 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./axisToDirection"
+
+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("axisToDirection transform", () => {
+  it('maps axis="horizontal" to direction="row"', () => {
+    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('direction="row"')
+    expect(result).not.toContain("axis")
+  })
+
+  it('maps axis="vertical" to direction="column"', () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="vertical">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction="column"')
+    expect(result).not.toContain("axis")
+  })
+
+  it("maps an expression-wrapped string literal", () => {
+    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('direction="row"')
+    expect(result).not.toContain("axis")
+  })
+
+  it("maps the StackView.HORIZONTAL constant", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis={StackView.HORIZONTAL}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction="row"')
+    expect(result).not.toContain("axis")
+    expect(result).not.toContain("StackView.HORIZONTAL")
+  })
+
+  it("maps the StackView.VERTICAL constant", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis={StackView.VERTICAL}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction="column"')
+    expect(result).not.toContain("StackView.VERTICAL")
+  })
+
+  it("flags a dynamic axis value and leaves it in place", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test({ orientation }) {
+  return <StackView axis={orientation}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("axis={orientation}")
+    expect(result).toContain("TODO: tapestry-migration (axis)")
+    expect(result).not.toContain('direction="')
+  })
+
+  it("maps an aliased StackView import", () => {
+    const input = `
+import { StackView as Stack } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <Stack axis="horizontal">Test</Stack>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction="row"')
+  })
+
+  it("returns null when there is no axis to map", () => {
+    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 axis="horizontal">Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+})

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

@@ -0,0 +1,51 @@
+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 CONSTANT_AXIS_MAP: Record<string, string> = {
+  HORIZONTAL: "horizontal",
+  VERTICAL: "vertical",
+}
+
+const AXIS_DIRECTION_MAP: Record<string, string> = {
+  horizontal: "row",
+  vertical: "column",
+}
+
+const transform: Transform = attributeTransformFactory({
+  condition: hasAttribute("axis"),
+  targetComponent: "StackView",
+  targetPackage: "@planningcenter/tapestry-react",
+  transform: (element, { j, source }) => {
+    const axisAttribute = getAttribute({ element, name: "axis" })
+    if (!axisAttribute) return false
+
+    const resolved = resolveConstantAttributeValue({
+      attribute: axisAttribute,
+      constantMap: CONSTANT_AXIS_MAP,
+    })
+    const direction = resolved ? AXIS_DIRECTION_MAP[resolved] : undefined
+
+    if (!direction) {
+      addComment({
+        element,
+        j,
+        scope: "axis",
+        source,
+        text: "could not migrate axis to direction automatically; convert this value to row or column manually",
+      })
+      return true
+    }
+
+    axisAttribute.name.name = "direction"
+    axisAttribute.value = j.stringLiteral(direction)
+
+    return true
+  },
+})
+
+export default transform