add support for pcb cutouts

Author: seveibar

lib/generate-footprint-tsx.tsx

@@ -11,6 +11,7 @@ export const generateFootprintTsx = (
   const silkscreenPaths = su(circuitJson).pcb_silkscreen_path.list()
   const fabricationNotePaths = su(circuitJson).pcb_fabrication_note_path.list()
   const silkscreenTexts = su(circuitJson).pcb_silkscreen_text.list()
+  const pcbCutouts = su(circuitJson).pcb_cutout.list()
 
   const elementStrings: string[] = []
 
@@ -76,6 +77,37 @@ export const generateFootprintTsx = (
     )
   }
 
+  // Add pcb_cutout elements
+  for (const cutout of pcbCutouts) {
+    if (cutout.shape === "rect") {
+      const pcbX = cutout.center.x
+      const pcbY = cutout.center.y
+      const width = mmStr(cutout.width)
+      const height = mmStr(cutout.height)
+      const rotation = cutout.rotation !== undefined ? ` pcbRotation="${mmStr(cutout.rotation)}"` : ""
+
+      elementStrings.push(
+        `<pcbcutout shape="rect" pcbX="${mmStr(pcbX)}" pcbY="${mmStr(pcbY)}" width="${width}" height="${height}"${rotation} />`,
+      )
+    } else if (cutout.shape === "circle") {
+      const pcbX = cutout.center.x
+      const pcbY = cutout.center.y
+      const radius = mmStr(cutout.radius)
+
+      elementStrings.push(
+        `<pcbcutout shape="circle" pcbX="${mmStr(pcbX)}" pcbY="${mmStr(pcbY)}" radius="${radius}" />`,
+      )
+    } else if (cutout.shape === "polygon") {
+      const pointsJson = JSON.stringify(cutout.points)
+
+      elementStrings.push(
+        `<pcbcutout shape="polygon" points={${pointsJson}} />`,
+      )
+    } else {
+      console.warn(`Unhandled pcb_cutout shape: ${(cutout as any).shape}`)
+    }
+  }
+
   return `
       <footprint>
         ${elementStrings.join("\n")}

tests/test5-pcb-cutout.test.tsx

@@ -0,0 +1,137 @@
+import { test, expect } from "bun:test"
+import { convertCircuitJsonToTscircuit } from "lib/index"
+import type { AnyCircuitElement } from "circuit-json"
+
+declare module "bun:test" {
+  interface Matchers<T = unknown> {
+    toMatchInlineSnapshot(snapshot?: string | null): Promise<MatcherResult>
+  }
+}
+
+test("test pcb_cutout conversion - all shapes", async () => {
+  const circuitJson: AnyCircuitElement[] = [
+    {
+      type: "pcb_cutout",
+      pcb_cutout_id: "cutout1",
+      shape: "rect",
+      center: { x: 0, y: 0 },
+      width: 5,
+      height: 3,
+      rotation: 45,
+    },
+    {
+      type: "pcb_cutout",
+      pcb_cutout_id: "cutout2",
+      shape: "circle",
+      center: { x: 10, y: 10 },
+      radius: 2.5,
+    },
+    {
+      type: "pcb_cutout",
+      pcb_cutout_id: "cutout3",
+      shape: "polygon",
+      points: [
+        { x: 0, y: 0 },
+        { x: 5, y: 0 },
+        { x: 5, y: 5 },
+        { x: 0, y: 5 },
+      ],
+    },
+  ]
+
+  const tscircuit = convertCircuitJsonToTscircuit(circuitJson, {
+    componentName: "ComponentWithCutouts",
+  })
+
+  expect(tscircuit).toMatchInlineSnapshot(`
+    "import { type ChipProps } from "tscircuit"
+    export const ComponentWithCutouts = (props: ChipProps) => (
+      <chip
+        footprint={<footprint>
+            <pcbcutout shape="rect" pcbX="0mm" pcbY="0mm" width="5mm" height="3mm" pcbRotation="45mm" />
+    <pcbcutout shape="circle" pcbX="10mm" pcbY="10mm" radius="2.5mm" />
+    <pcbcutout shape="polygon" points={[{"x":0,"y":0},{"x":5,"y":0},{"x":5,"y":5},{"x":0,"y":5}]} />
+          </footprint>}
+        {...props}
+      />
+    )"
+  `)
+})
+
+test("test pcb_cutout conversion - rect without rotation", async () => {
+  const circuitJson: AnyCircuitElement[] = [
+    {
+      type: "pcb_cutout",
+      pcb_cutout_id: "cutout1",
+      shape: "rect",
+      center: { x: 2, y: 3 },
+      width: 10,
+      height: 5,
+    },
+  ]
+
+  const tscircuit = convertCircuitJsonToTscircuit(circuitJson, {
+    componentName: "ComponentWithRectCutout",
+  })
+
+  expect(tscircuit).toMatchInlineSnapshot(`
+    "import { type ChipProps } from "tscircuit"
+    export const ComponentWithRectCutout = (props: ChipProps) => (
+      <chip
+        footprint={<footprint>
+            <pcbcutout shape="rect" pcbX="2mm" pcbY="3mm" width="10mm" height="5mm" />
+          </footprint>}
+        {...props}
+      />
+    )"
+  `)
+})
+
+test("test pcb_cutout conversion - mixed with other elements", async () => {
+  const circuitJson: AnyCircuitElement[] = [
+    {
+      type: "pcb_smtpad",
+      pcb_smtpad_id: "pad1",
+      shape: "rect",
+      x: 0,
+      y: 0,
+      width: 1,
+      height: 1,
+      layer: "top",
+      port_hints: ["1"],
+    },
+    {
+      type: "pcb_cutout",
+      pcb_cutout_id: "cutout1",
+      shape: "circle",
+      center: { x: 5, y: 5 },
+      radius: 1.5,
+    },
+    {
+      type: "pcb_hole",
+      pcb_hole_id: "hole1",
+      hole_shape: "circle",
+      x: 10,
+      y: 10,
+      hole_diameter: 0.5,
+    },
+  ]
+
+  const tscircuit = convertCircuitJsonToTscircuit(circuitJson, {
+    componentName: "ComponentWithMixedElements",
+  })
+
+  expect(tscircuit).toMatchInlineSnapshot(`
+    "import { type ChipProps } from "tscircuit"
+    export const ComponentWithMixedElements = (props: ChipProps) => (
+      <chip
+        footprint={<footprint>
+            <hole pcbX="10mm" pcbY="10mm" diameter="0.5mm" />
+    <smtpad portHints={["1"]} pcbX="0mm" pcbY="0mm" width="1mm" height="1mm" shape="rect" />
+    <pcbcutout shape="circle" pcbX="5mm" pcbY="5mm" radius="1.5mm" />
+          </footprint>}
+        {...props}
+      />
+    )"
+  `)
+})