@planningcenter/tapestry-migration-cli 3.5.0 → 3.6.1-qa-1035.0

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

@@ -0,0 +1,155 @@
+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("migrates a ternary axis value to a ternary direction value", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis={isNarrow ? "vertical" : "horizontal"}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction={isNarrow ? "column" : "row"}')
+    expect(result).not.toContain("axis")
+    expect(result).not.toContain("TODO")
+  })
+
+  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,77 @@
+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) {
+      const value = axisAttribute.value
+      if (value?.type === "JSXExpressionContainer") {
+        const expr = value.expression
+        if (
+          expr.type === "ConditionalExpression" &&
+          expr.consequent.type === "StringLiteral" &&
+          expr.alternate.type === "StringLiteral"
+        ) {
+          const consequentDir =
+            AXIS_DIRECTION_MAP[expr.consequent.value as string]
+          const alternateDir =
+            AXIS_DIRECTION_MAP[expr.alternate.value as string]
+          if (consequentDir && alternateDir) {
+            axisAttribute.name.name = "direction"
+            axisAttribute.value = j.jsxExpressionContainer(
+              j.conditionalExpression(
+                expr.test,
+                j.stringLiteral(consequentDir),
+                j.stringLiteral(alternateDir)
+              )
+            )
+            return true
+          }
+        }
+      }
+
+      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

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

@@ -0,0 +1,147 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./convertStyleProps"
+
+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("convertStyleProps transform", () => {
+  it("moves a margin style prop to a style object", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView marginTop={2}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toMatchInlineSnapshot(`
+      "import { StackView } from "@planningcenter/tapestry-react"
+
+      export default function Test() {
+        return (
+          <StackView style={{
+            marginTop: "16px"
+          }}>Test</StackView>
+        );
+      }"
+    `)
+  })
+
+  it("moves a padding style prop to a style object (splitStyles expands shorthand)", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView paddingTop={2}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toMatchInlineSnapshot(`
+      "import { StackView } from "@planningcenter/tapestry-react"
+
+      export default function Test() {
+        return (
+          <StackView style={{
+            paddingTop: "16px"
+          }}>Test</StackView>
+        );
+      }"
+    `)
+  })
+
+  it("migrates non-excluded style props while leaving excluded Flex props in place", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView gap={2} marginTop={2}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toMatchInlineSnapshot(`
+      "import { StackView } from "@planningcenter/tapestry-react"
+
+      export default function Test() {
+        return (
+          <StackView gap={2} style={{
+            marginTop: "16px"
+          }}>Test</StackView>
+        );
+      }"
+    `)
+  })
+
+  it("leaves Flex first-class props untouched", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView gap={2} padding={1} direction="row" wrap="wrap" alignSelf="center" columnGap={1} basis="100%" grow={1} shrink={0}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+
+  it.each(["grow", "shrink", "basis"] as const)(
+    "leaves %s untouched and emits no TODO",
+    (prop) => {
+      const value = prop === "basis" ? '"100%"' : "{1}"
+      const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView ${prop}=${value}>Test</StackView>
+}
+      `.trim()
+
+      expect(applyTransform(input)).toBe(null)
+    }
+  )
+
+  it("leaves axis/alignment/distribution/spacing for the dedicated rename transforms", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+
+export default function Test() {
+  return <StackView axis="horizontal" alignment="center" distribution="center" spacing={2}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toBe(null)
+  })
+
+  it("returns null when there are no style props 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 marginTop={2}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+})

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

@@ -0,0 +1,23 @@
+import { stylePropTransformFactory } from "../../shared/transformFactories/stylePropTransformFactory"
+
+const FLEX_PROP_NAMES = [
+  "alignItems",
+  "alignSelf",
+  "basis",
+  "columnGap",
+  "direction",
+  "flex",
+  "gap",
+  "grow",
+  "justifyContent",
+  "padding",
+  "shrink",
+  "wrap",
+]
+
+export default stylePropTransformFactory({
+  stylesToExclude: FLEX_PROP_NAMES,
+  stylesToRemove: [],
+  targetComponent: "StackView",
+  targetPackage: "@planningcenter/tapestry-react",
+})

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

@@ -0,0 +1,202 @@
+import jscodeshift from "jscodeshift"
+import { describe, expect, it } from "vitest"
+
+import transform from "./cssFlexAliasesToProps"
+
+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("cssFlexAliasesToProps transform", () => {
+  it("renames flexGrow to grow", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexGrow={1}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("grow={1}")
+    expect(result).not.toContain("flexGrow")
+  })
+
+  it("renames flexShrink to shrink", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexShrink={0}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("shrink={0}")
+    expect(result).not.toContain("flexShrink")
+  })
+
+  it("renames flexBasis to basis", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexBasis="0%">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('basis="0%"')
+    expect(result).not.toContain("flexBasis")
+  })
+
+  it("handles all three together", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexGrow={1} flexShrink={0} flexBasis="auto">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("grow={1}")
+    expect(result).toContain("shrink={0}")
+    expect(result).toContain('basis="auto"')
+    expect(result).not.toContain("flexGrow")
+    expect(result).not.toContain("flexShrink")
+    expect(result).not.toContain("flexBasis")
+  })
+
+  it("renames flexDirection to direction", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexDirection="row">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('direction="row"')
+    expect(result).not.toContain("flexDirection")
+    expect(result).not.toContain("TODO")
+  })
+
+  it("renames flexWrap to wrap", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView flexWrap="wrap">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('wrap="wrap"')
+    expect(result).not.toContain("flexWrap")
+    expect(result).not.toContain("TODO")
+  })
+
+  it("migrates justifyContent to justify with value normalization", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView justifyContent="flex-start">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('justify="start"')
+    expect(result).not.toContain("justifyContent")
+    expect(result).not.toContain("TODO")
+  })
+
+  it("migrates justifyContent center without normalization", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView justifyContent="center">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('justify="center"')
+    expect(result).not.toContain("TODO")
+  })
+
+  it("adds a TODO for an unmappable justifyContent value", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView justifyContent="stretch">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO")
+    expect(result).toContain("justifyContent")
+  })
+
+  it("adds a TODO for a dynamic justifyContent value", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView justifyContent={myVar}>Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO")
+  })
+
+  it("migrates alignItems to align with value normalization", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView alignItems="flex-end">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain('align="end"')
+    expect(result).not.toContain("alignItems")
+    expect(result).not.toContain("TODO")
+  })
+
+  it("adds a TODO for an unmappable alignItems value", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView alignItems="space-between">Test</StackView>
+}
+    `.trim()
+
+    const result = applyTransform(input)
+    expect(result).toContain("TODO")
+    expect(result).toContain("alignItems")
+  })
+
+  it("returns null when StackView has none of the CSS alias props", () => {
+    const input = `
+import { StackView } from "@planningcenter/tapestry-react"
+export default function Test() {
+  return <StackView gap={2}>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 flexGrow={1}>Test</StackView>
+}
+    `.trim()
+
+    expect(applyTransform(input)).toBe(null)
+  })
+})