@tscircuit/cli 0.0.96 → 0.0.97

package/lib/cmd-fns/dev/start-edit-event-watcher.ts

@@ -6,17 +6,11 @@ import fg from "fast-glob"
 import fs from "fs"
 import { Project, ts } from "ts-morph"
 import * as Path from "path"
-import { ManualPcbPosition } from "@tscircuit/builder"
+import type { ManualPcbPosition } from "@tscircuit/builder"
 import { deriveSelectorFromPcbComponentId } from "./derive-selector-from-pcb-component-id"
-
-// TODO import from builder when builder exports it
-type EditEvent = {
-  edit_event_id: string
-  pcb_edit_event_type: "edit_component_location"
-  pcb_component_id: string
-  original_center: { x: number; y: number }
-  new_center: { x: number; y: number }
-}
+import type { EditEvent } from "@tscircuit/manual-edit-events"
+import { getManualTraceHintFromEvent, ManualTraceHint } from "@tscircuit/layout"
+import JSON5 from "json5"
 
 export const startEditEventWatcher = async (
   {
@@ -142,11 +136,34 @@ export const startEditEventWatcher = async (
             const pcb_placements_ts =
               object_literal.getPropertyOrThrow("pcb_placements")
 
+            if (object_literal.getProperty("edit_events") === undefined) {
+              object_literal.addPropertyAssignment({
+                name: "edit_events",
+                initializer: "[]",
+              })
+            }
+
+            const edit_events_ts =
+              object_literal.getPropertyOrThrow("edit_events")
+
+            if (
+              object_literal.getProperty("manual_trace_hints") === undefined
+            ) {
+              object_literal.addPropertyAssignment({
+                name: "manual_trace_hints",
+                initializer: "[]",
+              })
+            }
+            const manual_trace_hints_ts =
+              object_literal.getPropertyOrThrow("manual_trace_hints")
+
             let pcb_placements: (ManualPcbPosition & {
               _edit_event_id?: string
             })[]
+            let in_file_edit_events: EditEvent[]
+            let manual_trace_hints: ManualTraceHint[]
             try {
-              pcb_placements = JSON.parse(
+              pcb_placements = JSON5.parse(
                 pcb_placements_ts.getText().replace(/pcb_placements:\s/, "")
               )
             } catch (e: any) {
@@ -157,60 +174,149 @@ export const startEditEventWatcher = async (
               )
               continue
             }
+            try {
+              in_file_edit_events = JSON5.parse(
+                edit_events_ts.getText().replace(/edit_events:\s/, "")
+              )
+            } catch (e: any) {
+              console.log(
+                kleur.red(
+                  `Error parsing edit_events from manual edits file: ${edit_events_ts.getText()} ${e.toString()}`
+                )
+              )
+              continue
+            }
+            try {
+              manual_trace_hints = JSON5.parse(
+                manual_trace_hints_ts
+                  .getText()
+                  .replace(/manual_trace_hints:\s/, "")
+              )
+            } catch (e: any) {
+              console.log(
+                kleur.red(
+                  `Error parsing manual_trace_hints from manual edits file: ${pcb_placements_ts.getText()} ${e.toString()}`
+                )
+              )
+              continue
+            }
 
             const handled_edit_events = new Set<string>(
               pcb_placements
                 .map((p) => (p as any)._edit_event_id)
-                .filter(Boolean)
+                .concat(in_file_edit_events.map((a) => a.edit_event_id))
             )
 
             // Add PCB placements from edit events
-            for (const edit_event of edit_events) {
-              if (handled_edit_events.has(edit_event.edit_event_id)) continue
+            for (const incoming_edit_event of edit_events) {
+              if (handled_edit_events.has(incoming_edit_event.edit_event_id))
+                continue
+
+              if (
+                incoming_edit_event.pcb_edit_event_type ===
+                "edit_component_location"
+              ) {
+                // TODO Figure out a good selector for this pcb_component
+                let pcb_component_selector: string | null = null
+                if (incoming_edit_event.pcb_component_id) {
+                  pcb_component_selector = deriveSelectorFromPcbComponentId({
+                    soup: dev_package_example_full.tscircuit_soup,
+                    pcb_component_id: incoming_edit_event.pcb_component_id,
+                  })
+                }
+
+                // TODO we'll need to work past this for edit_event_type=edit_trace
+                if (!pcb_component_selector) continue
+
+                const existing_placement_for_selector = pcb_placements.find(
+                  (pp) => pp.selector === pcb_component_selector
+                )
 
-              // TODO Figure out a good selector for this pcb_component
-              const selector = deriveSelectorFromPcbComponentId({
-                soup: dev_package_example_full.tscircuit_soup,
-                pcb_component_id: edit_event.pcb_component_id,
-              })
+                if (!existing_placement_for_selector) {
+                  console.log(
+                    kleur.gray(
+                      `  adding PCB placement from edit event for "${pcb_component_selector}"`
+                    )
+                  )
 
-              const existing_placement_for_selector = pcb_placements.find(
-                (pp) => pp.selector === selector
-              )
+                  pcb_placements.push({
+                    _edit_event_id: incoming_edit_event.edit_event_id,
+                    selector: pcb_component_selector,
+                    center: incoming_edit_event.new_center,
+                    relative_to: "group_center",
+                  })
+                } else {
+                  existing_placement_for_selector.center =
+                    incoming_edit_event.new_center
+                }
+
+                // Edit the pcb placements object
+                pcb_placements_ts.replaceWithText(
+                  `pcb_placements: ${JSON.stringify(
+                    pcb_placements,
+                    null,
+                    "  "
+                  )}`
+                )
 
-              if (!existing_placement_for_selector) {
-                console.log(
-                  kleur.gray(
-                    `  adding PCB placement from edit event for "${selector}"`
-                  )
+                // Save the file
+                fs.writeFileSync(
+                  Path.join(ctx.cwd, manual_edit_file),
+                  ts_manual_edits_file.getFullText()
+                )
+                await devServerAxios.post("/api/dev_package_examples/update", {
+                  dev_package_example_id,
+                  edit_events_last_applied_at:
+                    dev_package_example.edit_events_last_updated_at,
+                })
+              } else if (
+                incoming_edit_event.pcb_edit_event_type === "edit_trace_hint"
+              ) {
+                const new_trace_hint = getManualTraceHintFromEvent(
+                  dev_package_example_full.tscircuit_soup,
+                  incoming_edit_event
+                )
+
+                manual_trace_hints_ts.replaceWithText(
+                  `manual_trace_hints: ${JSON.stringify(
+                    manual_trace_hints
+                      .filter(
+                        (th) =>
+                          th.pcb_port_selector !==
+                          new_trace_hint.pcb_port_selector
+                      )
+                      .concat([new_trace_hint]),
+                    null,
+                    "  "
+                  )}`
                 )
 
-                pcb_placements.push({
-                  _edit_event_id: edit_event.edit_event_id,
-                  selector,
-                  center: edit_event.new_center,
-                  relative_to: "group_center",
+                fs.writeFileSync(
+                  Path.join(ctx.cwd, manual_edit_file),
+                  ts_manual_edits_file.getFullText()
+                )
+                await devServerAxios.post("/api/dev_package_examples/update", {
+                  dev_package_example_id,
+                  edit_events_last_applied_at:
+                    dev_package_example.edit_events_last_updated_at,
                 })
               } else {
-                existing_placement_for_selector.center = edit_event.new_center
+                // All other events just go to the manual-edits.ts file with
+                // in the "edit_events" property
+                edit_events_ts.replaceWithText(
+                  `edit_events: ${JSON.stringify(edit_events, null, "  ")}`
+                )
+                console.log(edit_events_ts.getFullText())
+                fs.writeFileSync(
+                  Path.join(ctx.cwd, manual_edit_file),
+                  ts_manual_edits_file.getFullText()
+                )
+                await devServerAxios.post("/api/dev_package_examples/update", {
+                  dev_package_example_id,
+                  edit_events_last_applied_at:
+                    dev_package_example.edit_events_last_updated_at,
+                })
               }
-
-              // Edit the pcb placements object
-              pcb_placements_ts.replaceWithText(
-                `pcb_placements: ${JSON.stringify(pcb_placements, null, "  ")}`
-              )
-
-              // Save the file
-
-              fs.writeFileSync(
-                Path.join(ctx.cwd, manual_edit_file),
-                ts_manual_edits_file.getFullText()
-              )
-              await devServerAxios.post("/api/dev_package_examples/update", {
-                dev_package_example_id,
-                edit_events_last_applied_at:
-                  dev_package_example.edit_events_last_updated_at,
-              })
             }
           }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tscircuit/cli",
-  "version": "0.0.96",
+  "version": "0.0.97",
   "private": false,
   "type": "module",
   "description": "Command line tool for developing, publishing and installing tscircuit circuits",
@@ -35,7 +35,8 @@
   "dependencies": {
     "@edge-runtime/primitives": "^4.1.0",
     "@hono/node-server": "^1.8.2",
-    "@tscircuit/builder": "^1.5.116",
+    "@tscircuit/builder": "^1.5.118",
+    "@tscircuit/layout": "^0.0.20",
     "@tscircuit/react-fiber": "^1.1.27",
     "@tscircuit/soup-util": "^0.0.1",
     "archiver": "^7.0.1",
@@ -70,6 +71,7 @@
     "zod": "latest"
   },
   "devDependencies": {
+    "@tscircuit/manual-edit-events": "^0.0.4",
     "@types/archiver": "^6.0.2",
     "@types/bun": "^1.0.8",
     "@types/chokidar": "^2.1.3",
@@ -84,6 +86,7 @@
     "@types/semver": "^7.5.8",
     "ava": "^6.1.1",
     "concurrently": "^8.2.2",
+    "json5": "^2.2.3",
     "tsx": "^4.7.1",
     "typescript": "^5.3.3"
   }

package/tests/assets/example-project/examples/basic-bug.tsx

@@ -9,13 +9,12 @@ export const BasicBug = () => (
   >
     <bug
       name="U2"
-      port_arrangement={{
-        left_size: 4,
-        right_size: 4,
+      schPortArrangement={{
+        leftSize: 4,
+        rightSize: 4,
       }}
-      footprint="sparkfun:ssop16"
-      center={[-10, 0]}
-      port_labels={{
+      footprint="ssop16"
+      pinLabels={{
         "1": "GND",
         "2": "VBUS",
         "3": "D-",

package/tests/assets/example-project/package.json

@@ -4,8 +4,8 @@
   "type": "module",
   "main": "dist/index.js",
   "dependencies": {
-    "@tscircuit/builder": "^1.5.116",
-    "@tscircuit/layout": "^0.0.17",
+    "@tscircuit/builder": "^1.5.118",
+    "@tscircuit/layout": "0.0.21",
     "@tscircuit/react-fiber": "^1.1.27"
   }
 }

package/tests/assets/example-project/src/MyCircuit.tsx

@@ -13,10 +13,32 @@ export const MyCircuit = () => (
     <resistor
       name="R1"
       resistance="20kohm"
+      pcbX={0}
+      pcbY={0}
       footprint="0805"
       supplierPartNumbers={{
         jlcpcb: ["C2759650"],
       }}
     />
+    <resistor
+      name="R2"
+      pcbX={5}
+      pcbY={0}
+      resistance="20kohm"
+      footprint="0805"
+      supplierPartNumbers={{
+        jlcpcb: ["C2759650"],
+      }}
+    />
+    <trace from=".R1 > .right" to=".R2 > .left" />
+    {/* <tracehint
+      for=".R1 > .right"
+      offsets={[
+        {
+          x: 3,
+          y: 3,
+        },
+      ]}
+    /> */}
   </board>
 )

package/tests/assets/example-project/src/manual-edits.ts

@@ -14,24 +14,7 @@ export default {
   manual_edit_id: "abcdef",
 
   // Manual pcb placements, added when you drag a footprint
-  pcb_placements: [
-      {
-        "_edit_event_id": "0.6467684918884489",
-        "selector": ".U2",
-        "center": {
-          "x": 13.777148607991913,
-          "y": -10.354434189987284
-        },
-        "relative_to": "group_center"
-      },
-      {
-        "_edit_event_id": "0.37279140805799216",
-        "selector": ".R1",
-        "center": {
-          "x": 5.433378371344073,
-          "y": -6.95083299460385
-        },
-        "relative_to": "group_center"
-      }
-    ],
+  pcb_placements: [],
+  manual_trace_hints: [],
+  edit_events: [],
 }