circuit-json-to-kicad 0.0.3 → 0.0.5

package/README.md

@@ -1,6 +1,6 @@
 # circuit-json-to-kicad
 
-Convert [Circuit JSON](https://github.com/tscircuit/circuit-json) files to KiCad schematic (`.kicad_sch`) and PCB (`.kicad_pcb`) files.
+Convert [Circuit JSON](https://github.com/tscircuit/circuit-json) files to KiCad schematic (`.kicad_sch`), PCB (`.kicad_pcb`), and project (`.kicad_pro`) files.
 
 Circuit JSON is an open-source file format for describing electronic circuits. This library enables you to generate KiCad-compatible files from Circuit JSON, allowing you to use KiCad's powerful PCB design tools with circuits defined in code.
 
@@ -49,6 +49,26 @@ const kicadPcbContent = converter.getOutputString()
 Bun.write("output.kicad_pcb", kicadPcbContent)
 ```
 
+### Generating a KiCad Project
+
+```typescript
+import { CircuitJsonToKicadProConverter } from "circuit-json-to-kicad"
+
+const circuitJson = /* your circuit JSON */
+
+const converter = new CircuitJsonToKicadProConverter(circuitJson, {
+  projectName: "my_project",
+  schematicFilename: "my_project.kicad_sch",
+  pcbFilename: "my_project.kicad_pcb",
+})
+
+converter.runUntilFinished()
+
+const kicadProjectContent = converter.getOutputString()
+
+Bun.write("my_project.kicad_pro", kicadProjectContent)
+```
+
 ### Complete Example with tscircuit
 
 ```typescript
@@ -102,6 +122,7 @@ Bun.write("output.kicad_pcb", pcbConverter.getOutputString())
   - Vias
   - Board outlines and graphics
   - Net assignments
+- **Project Generation**: Produce KiCad project files (`.kicad_pro`) that reference the generated schematic and PCB outputs
 
 ## Development
 

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { CircuitJson } from 'circuit-json';
-import { CircuitJsonUtilObjects } from '@tscircuit/circuit-json-util';
+import { CircuitJsonUtilObjects, cju } from '@tscircuit/circuit-json-util';
 import { KicadSch, KicadPcb } from 'kicadts';
 import { Matrix } from 'transformation-matrix';
 
@@ -71,4 +71,76 @@ declare class CircuitJsonToKicadPcbConverter {
     getOutputString(): string;
 }
 
-export { CircuitJsonToKicadPcbConverter, CircuitJsonToKicadSchConverter };
+interface CircuitJsonToKicadProOptions {
+    projectName?: string;
+    schematicFilename?: string;
+    pcbFilename?: string;
+}
+interface KicadProProject {
+    version: number;
+    head: {
+        generator: string;
+        generator_version: string;
+        project_name: string;
+        created: string;
+        modified: string;
+    };
+    meta: {
+        version: number;
+    };
+    text_variables: Record<string, string>;
+    libraries: {
+        pinned_symbol_libs: string[];
+        pinned_footprint_libs: string[];
+    };
+    boards: string[];
+    cvpcb: {
+        meta: {
+            version: number;
+        };
+    };
+    erc: {
+        meta: {
+            version: number;
+        };
+        erc_exclusions: unknown[];
+    };
+    net_settings: {
+        meta: {
+            version: number;
+        };
+        last_net_id: number;
+        classes: unknown[];
+    };
+    pcbnew: {
+        page_layout_descr_file: string;
+        last_paths: Record<string, string>;
+    };
+    schematic: {
+        meta: {
+            version: number;
+        };
+        page_layout_descr_file: string;
+        last_opened_files: string[];
+    };
+    board: {
+        meta: {
+            version: number;
+        };
+        last_opened_board: string;
+    };
+    sheets: [string, string][];
+}
+declare class CircuitJsonToKicadProConverter {
+    ctx: {
+        db: ReturnType<typeof cju>;
+        circuitJson: CircuitJson;
+    };
+    private project;
+    constructor(circuitJson: CircuitJson, options?: CircuitJsonToKicadProOptions);
+    runUntilFinished(): void;
+    getOutput(): KicadProProject;
+    getOutputString(): string;
+}
+
+export { CircuitJsonToKicadPcbConverter, CircuitJsonToKicadProConverter, CircuitJsonToKicadSchConverter };

package/dist/index.js

@@ -769,7 +769,7 @@ var AddSchematicTracesStage = class extends ConverterStage {
       y: junction.y
     });
     const kicadJunction = new Junction({
-      at: [x, y, 0],
+      at: [x, y],
       diameter: 0
       // 0 means use default diameter
     });
@@ -1335,7 +1335,91 @@ var CircuitJsonToKicadPcbConverter = class {
     return this.ctx.kicadPcb.getString();
   }
 };
+
+// lib/project/CircuitJsonToKicadProConverter.ts
+import { cju as cju3 } from "@tscircuit/circuit-json-util";
+import { randomUUID } from "crypto";
+var CircuitJsonToKicadProConverter = class {
+  ctx;
+  project;
+  constructor(circuitJson, options = {}) {
+    const projectName = options.projectName ?? // @ts-expect-error project metadata is optional in circuit json
+    circuitJson?.project?.name ?? "circuit-json-project";
+    const schematicFilename = options.schematicFilename ?? `${projectName}.kicad_sch`;
+    const pcbFilename = options.pcbFilename ?? `${projectName}.kicad_pcb`;
+    const timestamp = (/* @__PURE__ */ new Date()).toISOString();
+    this.ctx = {
+      db: cju3(circuitJson),
+      circuitJson
+    };
+    this.project = {
+      version: 1,
+      head: {
+        generator: "circuit-json-to-kicad",
+        generator_version: "0.0.1",
+        project_name: projectName,
+        created: timestamp,
+        modified: timestamp
+      },
+      meta: {
+        version: 1
+      },
+      text_variables: {},
+      libraries: {
+        pinned_symbol_libs: [],
+        pinned_footprint_libs: []
+      },
+      boards: [],
+      cvpcb: {
+        meta: {
+          version: 0
+        }
+      },
+      erc: {
+        meta: {
+          version: 0
+        },
+        erc_exclusions: []
+      },
+      net_settings: {
+        meta: {
+          version: 1
+        },
+        last_net_id: 0,
+        classes: []
+      },
+      pcbnew: {
+        page_layout_descr_file: "",
+        last_paths: {}
+      },
+      schematic: {
+        meta: {
+          version: 1
+        },
+        page_layout_descr_file: "",
+        last_opened_files: [schematicFilename]
+      },
+      board: {
+        meta: {
+          version: 1
+        },
+        last_opened_board: pcbFilename
+      },
+      sheets: [[randomUUID(), "Root"]]
+    };
+  }
+  runUntilFinished() {
+  }
+  getOutput() {
+    return this.project;
+  }
+  getOutputString() {
+    return `${JSON.stringify(this.project, null, 2)}
+`;
+  }
+};
 export {
   CircuitJsonToKicadPcbConverter,
+  CircuitJsonToKicadProConverter,
   CircuitJsonToKicadSchConverter
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "circuit-json-to-kicad",
   "main": "dist/index.js",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "type": "module",
   "files": [
     "dist"