@tscircuit/cli 0.1.31 → 0.1.33

package/lib/shared/generate-gitignore-file.ts

@@ -0,0 +1,35 @@
+import { writeFileIfNotExists } from "./write-file-if-not-exists"
+import path from "node:path"
+
+export const generateGitIgnoreFile = (dir: string) => {
+  const gitignorePath = path.join(dir, ".gitignore")
+  const gitignoreContent = `# Dependencies
+node_modules/
+
+# Build output
+dist/
+build/
+
+# Environment variables
+.env
+.env.local
+.env.*.local
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Debug logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+`
+
+  writeFileIfNotExists(gitignorePath, gitignoreContent)
+}

package/lib/shared/generate-ts-config.ts

@@ -1,5 +1,5 @@
-import path from "path"
-import fs from "fs"
+import path from "node:path"
+import { writeFileIfNotExists } from "./write-file-if-not-exists"
 
 // Generate a React-compatible tsconfig.json
 export const generateTsConfig = (dir: string) => {
@@ -25,10 +25,5 @@ export const generateTsConfig = (dir: string) => {
     null,
     2,
   )
-  if (!fs.existsSync(tsconfigPath)) {
-    fs.writeFileSync(tsconfigPath, tsconfigContent.trimStart())
-    console.log(`Created: ${tsconfigPath}`)
-  } else {
-    console.log(`Skipped: ${tsconfigPath} already exists`)
-  }
+  writeFileIfNotExists(tsconfigPath, tsconfigContent)
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tscircuit/cli",
   "main": "dist/main.js",
   "type": "module",
-  "version": "0.1.31",
+  "version": "0.1.33",
   "bin": {
     "tsci": "./dist/main.js"
   },
@@ -34,7 +34,9 @@
     "@tscircuit/eval": "^0.0.96",
     "@tscircuit/file-server": "^0.0.13",
     "@tscircuit/runframe": "^0.0.167",
+    "bun-match-svg": "^0.0.9",
     "chokidar": "4.0.1",
+    "circuit-to-svg": "^0.0.101",
     "commander": "^12.1.0",
     "configstore": "^7.0.0",
     "cosmiconfig": "^9.0.0",

package/tests/cli/export/__snapshots__/pcb.snap.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="800" height="600"><style>
+              .boundary { fill: #000; }
+              .pcb-board { fill: none; }
+              .pcb-trace { fill: none; }
+              .pcb-hole-outer { fill: rgb(200, 52, 52); }
+              .pcb-hole-inner { fill: rgb(255, 38, 226); }
+              .pcb-pad { }
+              .pcb-boundary { fill: none; stroke: #fff; stroke-width: 0.3; }
+              .pcb-silkscreen { fill: none; }
+              .pcb-silkscreen-top { stroke: #f2eda1; }
+              .pcb-silkscreen-bottom { stroke: #f2eda1; }
+              .pcb-silkscreen-text { fill: #f2eda1; }
+            </style><rect class="boundary" x="0" y="0" width="800" height="600"/><rect class="pcb-boundary" x="150" y="50" width="500" height="500"/><path class="pcb-board" d="M 150 550 L 650 550 L 650 50 L 150 50 Z" stroke="rgba(255, 255, 255, 0.5)" stroke-width="5"/><g transform="translate(550, 300) rotate(0) scale(1, -1)"><rect class="pcb-component" x="-39.99999999999999" y="-15.000000000000002" width="79.99999999999999" height="30.000000000000004"/><rect class="pcb-component-outline" x="-39.99999999999999" y="-15.000000000000002" width="79.99999999999999" height="30.000000000000004"/></g><g transform="translate(250, 300) rotate(0) scale(1, -1)"><rect class="pcb-component" x="-39.99999999999999" y="-15.000000000000002" width="79.99999999999999" height="30.000000000000004"/><rect class="pcb-component-outline" x="-39.99999999999999" y="-15.000000000000002" width="79.99999999999999" height="30.000000000000004"/></g><rect class="pcb-pad" fill="rgb(200, 52, 52)" x="510" y="285" width="30.000000000000004" height="30.000000000000004"/><rect class="pcb-pad" fill="rgb(200, 52, 52)" x="560" y="285" width="30.000000000000004" height="30.000000000000004"/><rect class="pcb-pad" fill="rgb(200, 52, 52)" x="210" y="285" width="30.000000000000004" height="30.000000000000004"/><rect class="pcb-pad" fill="rgb(200, 52, 52)" x="260" y="285" width="30.000000000000004" height="30.000000000000004"/><path class="pcb-trace" stroke="rgb(200, 52, 52)" d="M 525 300 L 340 300" stroke-width="8" stroke-linecap="round" stroke-linejoin="round" shape-rendering="crispEdges"/><path class="pcb-trace" stroke="rgb(200, 52, 52)" d="M 340 300 L 340 235" stroke-width="8" stroke-linecap="round" stroke-linejoin="round" shape-rendering="crispEdges"/><path class="pcb-trace" stroke="rgb(200, 52, 52)" d="M 340 235 L 225 235" stroke-width="8" stroke-linecap="round" stroke-linejoin="round" shape-rendering="crispEdges"/><path class="pcb-trace" stroke="rgb(200, 52, 52)" d="M 225 235 L 225 300" stroke-width="8" stroke-linecap="round" stroke-linejoin="round" shape-rendering="crispEdges"/></svg>

package/tests/cli/export/__snapshots__/schematic.snap.svg

@@ -0,0 +1,17 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="1200" height="600" style="background-color: rgb(245, 241, 237)" data-real-to-screen-transform="matrix(144.84007242,0,0,-144.84007242,601.2614556427,338.9300573808)"><style>
+              .boundary { fill: rgb(245, 241, 237); }
+              .schematic-boundary { fill: none; stroke: #fff; }
+              .component { fill: none; stroke: rgb(132, 0, 0); }
+              .chip { fill: rgb(255, 255, 194); stroke: rgb(132, 0, 0); }
+              .component-pin { fill: none; stroke: rgb(132, 0, 0); }
+              .trace:hover {
+                filter: invert(1);
+              }
+              .trace:hover .trace-crossing-outline {
+                opacity: 0;
+              }
+              .text { font-family: sans-serif; fill: rgb(0, 150, 0); }
+              .pin-number { fill: rgb(169, 0, 0); }
+              .port-label { fill: rgb(0, 100, 100); }
+              .component-name { fill: rgb(0, 100, 100); }
+            </style><rect class="boundary" x="0" y="0" width="1200" height="600"/><g data-circuit-json-type="schematic_component" data-schematic-component-id="schematic_component_0"><rect class="component-overlay" x="961.6451659624652" y="313.0828974532263" width="153.28907181649743" height="38.32227881712976" fill="transparent"/><path d="M 961.6451659624652 332.2440368617912 L 999.9674302955876 332.2440368617912" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><path d="M 1076.611958961833 332.2440368617912 L 1114.9342377789626 332.2440368617912" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><path d="M 1038.289680144703 313.0828974532263 L 1076.6119444778255 313.0828974532263 L 1076.6119444778255 351.40517627035604 L 999.967401327573 351.40517627035604 L 999.967401327573 313.0828974532263 L 1038.2896801447027 313.0828974532263" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><text x="1035.7816729027" y="305.7221862096437" fill="rgb(15, 15, 15)" font-family="sans-serif" text-anchor="middle" dominant-baseline="auto" font-size="26.0712130356px">R1</text><text x="1035.7816729027" y="361.9991234825565" fill="rgb(15, 15, 15)" font-family="sans-serif" text-anchor="middle" dominant-baseline="hanging" font-size="26.0712130356px">1kΩ</text><circle cx="958.4673892575775" cy="332.2956288955875" r="2.8968014484px" stroke-width="2.8968014484px" fill="none" stroke="rgb(132, 0, 0)"/><circle cx="1113.0959565478224" cy="332.3747839951648" r="2.8968014484px" stroke-width="2.8968014484px" fill="none" stroke="rgb(132, 0, 0)"/></g><g data-circuit-json-type="schematic_component" data-schematic-component-id="schematic_component_1"><rect class="component-overlay" x="89.19451538935782" y="298.10451483403904" width="153.2890718164976" height="76.64452866624515" fill="transparent"/><path d="M 242.48358720585543 336.4267791671613 L 177.33573928794772 336.4267791671613" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><path d="M 154.34237779127272 336.4267791671613 L 89.19451538935782 336.4267791671613" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><path d="M 177.33573928794766 298.10451483403904 L 177.33573928794772 374.7490435002842" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><path d="M 154.34237779127272 298.10451483403904 L 154.34237779127272 374.7490435002842" stroke="rgb(132, 0, 0)" fill="none" stroke-width="2.8968014484px"/><text x="164.87794327105283" y="278.14889075777336" fill="rgb(15, 15, 15)" font-family="sans-serif" text-anchor="middle" dominant-baseline="auto" font-size="26.0712130356px">C1</text><text x="166.18353168384664" y="399.7112240038267" fill="rgb(15, 15, 15)" font-family="sans-serif" text-anchor="middle" dominant-baseline="hanging" font-size="26.0712130356px">1nF</text><circle cx="86.90404345212234" cy="336.5575407845422" r="2.8968014484px" stroke-width="2.8968014484px" fill="none" stroke="rgb(132, 0, 0)"/><circle cx="246.57843331327743" cy="336.47835671695026" r="2.8968014484px" stroke-width="2.8968014484px" fill="none" stroke="rgb(132, 0, 0)"/></g><g class="trace" data-circuit-json-type="schematic_trace" data-schematic-trace-id="schematic_trace_0"><path d="M 958.4673892575775 332.2956288955875 L 398.66050935427745 332.2956288955875 L 398.66050935427745 184.39628067595024 L 86.90404345212232 184.39628067595024 L 86.90404345212232 314.83152992154214 L 86.90404345212232 336.55754078454214" class="trace-invisible-hover-outline" stroke="rgb(0, 150, 0)" fill="none" stroke-width="23.1744115872px" stroke-linecap="round" opacity="0" stroke-linejoin="round"/><path d="M 958.4673892575775 332.2956288955875 L 398.66050935427745 332.2956288955875 L 398.66050935427745 184.39628067595024 L 86.90404345212232 184.39628067595024 L 86.90404345212232 314.83152992154214 L 86.90404345212232 336.55754078454214" stroke="rgb(0, 150, 0)" fill="none" stroke-width="2.8968014484px" stroke-linecap="round" stroke-linejoin="round"/></g></svg>

package/tests/cli/export/export.test.ts

@@ -0,0 +1,62 @@
+import { getCliTestFixture } from "../../fixtures/get-cli-test-fixture"
+import { test, expect } from "bun:test"
+import { readFile } from "node:fs/promises"
+import path from "node:path"
+import "bun-match-svg"
+
+const circuitCode = `
+export default () => (
+  <board width="10mm" height="10mm">
+    <resistor
+      resistance="1k"
+      footprint="0402"
+      name="R1"
+      schX={3}
+      pcbX={3}
+    />
+    <capacitor
+      capacitance="1000pF"
+      footprint="0402"
+      name="C1"
+      schX={-3}
+      pcbX={-3}
+    />
+    <trace from=".R1 > .pin1" to=".C1 > .pin1" />
+  </board>
+)`
+
+async function setupTestCircuit(tmpDir: string) {
+  await Bun.write(path.join(tmpDir, "test-circuit.tsx"), circuitCode)
+}
+
+test("export pcb-svg", async () => {
+  const { tmpDir, runCommand } = await getCliTestFixture()
+  await setupTestCircuit(tmpDir)
+
+  const { stdout, stderr } = await runCommand(
+    `tsci export ${path.join(tmpDir, "test-circuit.tsx")} -f pcb-svg`,
+  )
+  expect(stderr).toBe("")
+
+  const pcbSvg = await readFile(
+    path.join(tmpDir, "test-circuit-pcb.svg"),
+    "utf-8",
+  )
+  expect(pcbSvg).toMatchSvgSnapshot(import.meta.path, "pcb")
+})
+
+test("export schematic-svg", async () => {
+  const { tmpDir, runCommand } = await getCliTestFixture()
+  await setupTestCircuit(tmpDir)
+
+  const { stdout, stderr } = await runCommand(
+    `tsci export ${path.join(tmpDir, "test-circuit.tsx")} -f schematic-svg`,
+  )
+  expect(stderr).toBe("")
+
+  const schematicSvg = await readFile(
+    path.join(tmpDir, "test-circuit-schematic.svg"),
+    "utf-8",
+  )
+  expect(schematicSvg).toMatchSvgSnapshot(import.meta.path, "schematic")
+})