Support top and bottom courtyard layers in footprint generation (#30)

Author: techmannih

lib/generate-footprint-tsx.tsx

@@ -243,50 +243,25 @@ export const generateFootprintTsx = (
   }
 
   for (const courtyardOutline of courtyardOutlines) {
-    const courtyardOutlineAny = courtyardOutline as any
     const attrs = [
       `outline={${JSON.stringify(courtyardOutline.outline ?? [])}}`,
     ]
-
-    if (courtyardOutlineAny.stroke_width !== undefined) {
-      attrs.push(`strokeWidth={${courtyardOutlineAny.stroke_width}}`)
-    }
-    if (courtyardOutlineAny.is_closed !== undefined) {
-      attrs.push(`isClosed={${courtyardOutlineAny.is_closed}}`)
-    }
-    if (courtyardOutlineAny.is_stroke_dashed !== undefined) {
-      attrs.push(`isStrokeDashed={${courtyardOutlineAny.is_stroke_dashed}}`)
-    }
-    if (courtyardOutlineAny.color !== undefined) {
-      attrs.push(`color="${courtyardOutlineAny.color}"`)
+    if (courtyardOutline.layer !== undefined) {
+      attrs.push(`layer="${courtyardOutline.layer}"`)
     }
 
     elementStrings.push(`<courtyardoutline ${attrs.join(" ")} />`)
   }
 
   for (const courtyardRect of courtyardRects) {
-    const courtyardRectAny = courtyardRect as any
     const attrs = [
       `pcbX={${courtyardRect.center?.x ?? 0}}`,
       `pcbY={${courtyardRect.center?.y ?? 0}}`,
       `width={${courtyardRect.width ?? 0}}`,
       `height={${courtyardRect.height ?? 0}}`,
     ]
-
-    if (courtyardRectAny.stroke_width !== undefined) {
-      attrs.push(`strokeWidth={${courtyardRectAny.stroke_width}}`)
-    }
-    if (courtyardRectAny.is_filled !== undefined) {
-      attrs.push(`isFilled={${courtyardRectAny.is_filled}}`)
-    }
-    if (courtyardRectAny.has_stroke !== undefined) {
-      attrs.push(`hasStroke={${courtyardRectAny.has_stroke}}`)
-    }
-    if (courtyardRectAny.is_stroke_dashed !== undefined) {
-      attrs.push(`isStrokeDashed={${courtyardRectAny.is_stroke_dashed}}`)
-    }
-    if (courtyardRectAny.color !== undefined) {
-      attrs.push(`color="${courtyardRectAny.color}"`)
+    if (courtyardRect.layer !== undefined) {
+      attrs.push(`layer="${courtyardRect.layer}"`)
     }
 
     elementStrings.push(`<courtyardrect ${attrs.join(" ")} />`)

tests/test8-support-courtyard.test.tsx

@@ -1,5 +1,4 @@
 import { expect, test } from "bun:test"
-import { convertCircuitJsonToPcbSvg } from "circuit-to-svg"
 import { convertCircuitJsonToTscircuit } from "lib"
 import { runTscircuitCode } from "tscircuit"
 
@@ -13,17 +12,18 @@ test("test8 support courtyard elements", async () => {
     export const Test8Component = (props: ChipProps) => (
       <chip
         footprint={<footprint>
-            <smtpad portHints={[\"1\"]} pcbX=\"-0.5mm\" pcbY=\"0mm\" width=\"0.6mm\" height=\"0.9mm\" shape=\"rect\" />
-    <courtyardoutline outline={[{\"x\":-1.8,\"y\":-1.4},{\"x\":1.8,\"y\":-1.4},{\"x\":1.8,\"y\":1.4},{\"x\":-1.8,\"y\":1.4}]} strokeWidth={0.12} isClosed={true} isStrokeDashed={true} color=\"#ff00ff\" />
-    <courtyardrect pcbX={0} pcbY={0} width={4} height={3} strokeWidth={0.1} isFilled={false} hasStroke={true} isStrokeDashed={true} color=\"#00ffff\" />
+            <smtpad portHints={["1"]} pcbX="-0.5mm" pcbY="0mm" width="0.6mm" height="0.9mm" shape="rect" />
+    <courtyardoutline outline={[{"x":-1.8,"y":-1.4},{"x":1.8,"y":-1.4},{"x":1.8,"y":1.4},{"x":-1.8,"y":1.4}]} layer="top" />
+    <courtyardrect pcbX={0} pcbY={0} width={4} height={3} layer="top" />
+    <courtyardrect pcbX={0.2} pcbY={0.2} width={4.6} height={3.6} layer="bottom" />
           </footprint>}
         {...props}
       />
     )"
   `)
 })
 
-test("test8 pcb svg snapshot includes courtyard geometry", async () => {
+test("test8 renders courtyard as courtyard circuit json", async () => {
   const tscircuit = convertCircuitJsonToTscircuit(circuitJson, {
     componentName: "Test8Component",
   })
@@ -32,7 +32,7 @@ test("test8 pcb svg snapshot includes courtyard geometry", async () => {
 ${tscircuit}
 
 circuit.add(
-  <board width=\"20mm\" height=\"20mm\">
+  <board width="20mm" height="20mm">
     <Test8Component />
   </board>,
 )
@@ -42,62 +42,15 @@ circuit.add(
     ["pcb_courtyard_outline", "pcb_courtyard_rect"].includes(elm.type),
   )
 
-  expect(courtyardElements.length).toBeGreaterThan(0)
-
-  const pcbSvg = convertCircuitJsonToPcbSvg([
-    ...renderedCircuitJson,
-    ...projectCourtyardToFabricationNotes(courtyardElements),
-  ])
-
-  await expect(pcbSvg).toMatchSvgSnapshot(import.meta.path, "courtyard-pcb")
+  expect(courtyardElements).toHaveLength(6)
+  expect(
+    courtyardElements.filter((elm) => elm.type === "pcb_courtyard_outline"),
+  ).toHaveLength(2)
+  expect(
+    courtyardElements.filter((elm) => elm.type === "pcb_courtyard_rect"),
+  ).toHaveLength(4)
 })
 
-const projectCourtyardToFabricationNotes = (courtyardElements: any[]) => {
-  const projected: any[] = []
-
-  for (const elm of courtyardElements) {
-    if (elm.type === "pcb_courtyard_outline") {
-      const route = [...(elm.outline ?? [])]
-      if (elm.is_closed && route.length > 1) {
-        const firstPoint = route[0]
-        const lastPoint = route[route.length - 1]
-        if (firstPoint.x !== lastPoint.x || firstPoint.y !== lastPoint.y) {
-          route.push(firstPoint)
-        }
-      }
-
-      projected.push({
-        type: "pcb_fabrication_note_path",
-        pcb_fabrication_note_path_id: `projected_fnp_${elm.pcb_courtyard_outline_id}`,
-        pcb_component_id: elm.pcb_component_id,
-        layer: elm.layer,
-        route,
-        stroke_width: elm.stroke_width ?? 0.1,
-        color: elm.color,
-      })
-    }
-
-    if (elm.type === "pcb_courtyard_rect") {
-      projected.push({
-        type: "pcb_fabrication_note_rect",
-        pcb_fabrication_note_rect_id: `projected_fnr_${elm.pcb_courtyard_rect_id}`,
-        pcb_component_id: elm.pcb_component_id,
-        layer: elm.layer,
-        center: elm.center,
-        width: elm.width,
-        height: elm.height,
-        stroke_width: elm.stroke_width ?? 0.1,
-        is_filled: elm.is_filled ?? false,
-        has_stroke: elm.has_stroke ?? true,
-        is_stroke_dashed: elm.is_stroke_dashed,
-        color: elm.color,
-      })
-    }
-  }
-
-  return projected
-}
-
 const circuitJson: any = [
   {
     type: "source_component",
@@ -154,10 +107,6 @@ const circuitJson: any = [
       { x: 1.8, y: 1.4 },
       { x: -1.8, y: 1.4 },
     ],
-    stroke_width: 0.12,
-    is_closed: true,
-    is_stroke_dashed: true,
-    color: "#ff00ff",
   },
   {
     type: "pcb_courtyard_rect",
@@ -167,10 +116,14 @@ const circuitJson: any = [
     width: 4,
     height: 3,
     layer: "top",
-    stroke_width: 0.1,
-    is_filled: false,
-    has_stroke: true,
-    is_stroke_dashed: true,
-    color: "#00ffff",
+  },
+  {
+    type: "pcb_courtyard_rect",
+    pcb_courtyard_rect_id: "pcb_courtyard_rect_1",
+    pcb_component_id: "pcb_generic_component_0",
+    center: { x: 0.2, y: 0.2 },
+    width: 4.6,
+    height: 3.6,
+    layer: "bottom",
   },
 ]