circuit-json-to-tscircuit 0.0.3 → 0.0.5

package/README.md

@@ -2,6 +2,14 @@
 
 Convert [circuit json](https://github.com/tscircuit/circuit-json) code to [tscircuit](https://github.com/tscircuit/tscircuit) code.
 
+Circuit JSON is more of a "compiled form" of a circuit and tscircuit code can't
+necessarily be full reconstructed from it. That said, Circuit JSON is often
+a great intermediary format when converting between different industry standards
+like DSN, KiCad, and Eagle.
+
+This converter is primarily useful for creating tscircuit components from
+Circuit JSON, e.g. for a `kicad_mod` -> circuit json -> tscircuit conversion.
+
 ## Usage
 
 ```bash

package/assets/input-circuit-json.json

@@ -0,0 +1,196 @@
+[
+  {
+    "type": "source_port",
+    "source_port_id": "source_port_0",
+    "name": "pin1",
+    "pin_number": 1,
+    "port_hints": ["anode", "pos", "left", "pin1", "1"],
+    "source_component_id": "source_component_0"
+  },
+  {
+    "type": "source_port",
+    "source_port_id": "source_port_1",
+    "name": "pin2",
+    "pin_number": 2,
+    "port_hints": ["cathode", "neg", "right", "pin2", "2"],
+    "source_component_id": "source_component_0"
+  },
+  {
+    "type": "source_component",
+    "source_component_id": "source_component_0",
+    "ftype": "simple_resistor",
+    "name": "R1",
+    "supplier_part_numbers": {
+      "jlcpcb": ["C11702", "C25543", "C226166"]
+    },
+    "resistance": 1000,
+    "display_resistance": "1kΩ"
+  },
+  {
+    "type": "source_group",
+    "source_group_id": "source_group_0",
+    "is_subcircuit": true,
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "schematic_component",
+    "schematic_component_id": "schematic_component_0",
+    "center": {
+      "x": 0,
+      "y": 0
+    },
+    "rotation": 0,
+    "size": {
+      "width": 1.0583332999999997,
+      "height": 0.388910699999999
+    },
+    "source_component_id": "source_component_0",
+    "symbol_name": "boxresistor_right",
+    "symbol_display_value": "1kΩ"
+  },
+  {
+    "type": "schematic_port",
+    "schematic_port_id": "schematic_port_0",
+    "schematic_component_id": "schematic_component_0",
+    "center": {
+      "x": -0.5337907000000003,
+      "y": 0.045805199999999324
+    },
+    "source_port_id": "source_port_0",
+    "facing_direction": "left",
+    "distance_from_component_edge": 0.4,
+    "pin_number": 1,
+    "display_pin_label": "left"
+  },
+  {
+    "type": "schematic_port",
+    "schematic_port_id": "schematic_port_1",
+    "schematic_component_id": "schematic_component_0",
+    "center": {
+      "x": 0.5337907000000003,
+      "y": 0.04525870000000065
+    },
+    "source_port_id": "source_port_1",
+    "facing_direction": "right",
+    "distance_from_component_edge": 0.4,
+    "pin_number": 2,
+    "display_pin_label": "right"
+  },
+  {
+    "type": "pcb_component",
+    "pcb_component_id": "pcb_component_0",
+    "center": {
+      "x": 0,
+      "y": 0
+    },
+    "width": 1.6,
+    "height": 0.6000000000000001,
+    "layer": "top",
+    "rotation": 0,
+    "source_component_id": "source_component_0",
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "pcb_board",
+    "pcb_board_id": "pcb_board_0",
+    "center": {
+      "x": 0,
+      "y": 0
+    },
+    "thickness": 1.4,
+    "num_layers": 4,
+    "width": 5,
+    "height": 5
+  },
+  {
+    "type": "pcb_smtpad",
+    "pcb_smtpad_id": "pcb_smtpad_0",
+    "pcb_component_id": "pcb_component_0",
+    "pcb_port_id": "pcb_port_0",
+    "layer": "top",
+    "shape": "rect",
+    "width": 0.6000000000000001,
+    "height": 0.6000000000000001,
+    "port_hints": ["1", "left"],
+    "x": -0.5,
+    "y": 0,
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "pcb_solder_paste",
+    "pcb_solder_paste_id": "pcb_solder_paste_0",
+    "layer": "top",
+    "shape": "rect",
+    "width": 0.42000000000000004,
+    "height": 0.42000000000000004,
+    "x": -0.5,
+    "y": 0,
+    "pcb_component_id": "pcb_component_0",
+    "pcb_smtpad_id": "pcb_smtpad_0",
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "pcb_smtpad",
+    "pcb_smtpad_id": "pcb_smtpad_1",
+    "pcb_component_id": "pcb_component_0",
+    "pcb_port_id": "pcb_port_1",
+    "layer": "top",
+    "shape": "rect",
+    "width": 0.6000000000000001,
+    "height": 0.6000000000000001,
+    "port_hints": ["2", "right"],
+    "x": 0.5,
+    "y": 0,
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "pcb_solder_paste",
+    "pcb_solder_paste_id": "pcb_solder_paste_1",
+    "layer": "top",
+    "shape": "rect",
+    "width": 0.42000000000000004,
+    "height": 0.42000000000000004,
+    "x": 0.5,
+    "y": 0,
+    "pcb_component_id": "pcb_component_0",
+    "pcb_smtpad_id": "pcb_smtpad_1",
+    "subcircuit_id": "subcircuit_source_group_0"
+  },
+  {
+    "type": "pcb_port",
+    "pcb_port_id": "pcb_port_0",
+    "pcb_component_id": "pcb_component_0",
+    "layers": ["top"],
+    "subcircuit_id": "subcircuit_source_group_0",
+    "x": -0.5,
+    "y": 0,
+    "source_port_id": "source_port_0"
+  },
+  {
+    "type": "pcb_port",
+    "pcb_port_id": "pcb_port_1",
+    "pcb_component_id": "pcb_component_0",
+    "layers": ["top"],
+    "subcircuit_id": "subcircuit_source_group_0",
+    "x": 0.5,
+    "y": 0,
+    "source_port_id": "source_port_1"
+  },
+  {
+    "type": "cad_component",
+    "cad_component_id": "cad_component_0",
+    "position": {
+      "x": 0,
+      "y": 0,
+      "z": 0.7
+    },
+    "rotation": {
+      "x": 0,
+      "y": 0,
+      "z": 0
+    },
+    "pcb_component_id": "pcb_component_0",
+    "source_component_id": "source_component_0",
+    "footprinter_string": "0402"
+  }
+]

package/cli/main.ts

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+import { Command } from "commander"
+import { readFile, writeFile } from "node:fs/promises"
+import { convertCircuitJsonToTscircuit } from "../lib"
+import type { CircuitJson } from "circuit-json"
+import pkg from "../package.json"
+
+const program = new Command()
+
+program
+  .name("circuit-json-to-tscircuit")
+  .description("Convert circuit.json files to TSCircuit components")
+  .version(pkg.version)
+  .argument("<input>", "Input circuit.json file path")
+  .option("-o, --output <path>", "Output TSX file path")
+  .option("-n, --name <name>", "Component name")
+  .action(async (input, options) => {
+    if (!options.output) {
+      throw new Error("Output path is required. Use -o or --output option.")
+    }
+
+    console.log(`Converting ${input} to ${options.output}`)
+
+    // Read input JSON file
+    console.log("Reading input file...")
+    const jsonContent = await readFile(input, "utf-8")
+    console.log("Parsing JSON...")
+    const circuitJson = JSON.parse(jsonContent) as CircuitJson
+
+    // Convert to TSCircuit
+    if (!Array.isArray(circuitJson)) {
+      throw new Error(
+        "Invalid circuit.json: expected an array of circuit elements",
+      )
+    }
+
+    console.log("Converting to TSCircuit...")
+    const tsxContent = convertCircuitJsonToTscircuit(circuitJson, {
+      componentName: options.name || "Circuit",
+    })
+    console.log("TSX content generated")
+
+    // Write output TSX file
+    console.log("Writing output file...")
+    await writeFile(options.output, tsxContent, "utf-8")
+
+    console.log("Conversion completed successfully!")
+  })
+
+if (process.argv.length === 2) {
+  program.help()
+} else {
+  program.parse()
+}