@tscircuit/cli 0.0.393 → 0.1.1

package/docs/EDIT_EVENT_PIPELINE.md

@@ -1,34 +0,0 @@
-# Edit Event Pipeline
-
-Whenever someone makes a manual edit to tscircuit, a `manual-edits.ts` file is created
-or edited describing what was changed. This file can be loaded into a `<board />` component
-with `layout={layout().manualEdits(manualEdits)}`.
-
-There pipeline for edit events is kind of complicated because the event must appear
-to happen instantaneously, but must also be stored, and the circuit should be
-re-rendered to determine the new routing.
-
-If you're debugging the edit event pipeline, turn on the debug logs:
-
-```bash
-DEBUG=tscircuit:cli:edit-event-watcher
-```
-
-## How the Edit Events are Processed
-
-This these are all the steps that happen to add an edit to `manual-edits.ts`,
-then apply it to the circuit.
-
-1. The user makes a change inside the `pcb-viewer` or `schematic-viewer`
-2. An edit event is emitted via e.g. `<PCBViewer onEditEventsChanged={...} />`
-3. The edit event is added to the list of `instantEditEvents` in `MainContentView.tsx`
-   1. Instant edit events are applied on the browser side, but don't re-route the circuit
-   2. You can tell you're in the phase where the edit event is still be processed and hasn't
-      been rendered because the traces still point to the old location
-4. The edit event is sent to the api server in a post request to `/api/dev_package_examples/update`
-5. The api server adds the edit event to the database
-6. The CLI "watcher" (see `start-edit-event-watcher.ts`) polls for new edit events
-7. The CLI watcher edits the `manual-edits.ts` file and triggers the circuit to re-render
-8. The circuit re-renders and the circuit json (soup) is updated on the server via `/api/dev_package_examples/update`
-9. The browser polls for the updated soup via `/api/dev_package_examples/get_soup` and the browser
-   updates with the fully routed circuit json

package/example-project/README.md

@@ -1,18 +0,0 @@
-# seveibar/example-project-3
-
-To develop and view the examples, run `tsci dev` and open [http://127.0.0.1:3020](http://127.0.0.1:3020) in your browser.
-
-## Developing
-
-You should install an editor like [VS Code](https://code.visualstudio.com/) with a typescript extension. Many web developers already have this.
-
-Usually, you'll want to develop some named circuits inside of the `lib` directory,
-export them in the `index.ts` file, then show how to use them in the `examples` directory.
-
-Any file in `examples` will be automatically loaded and appear in the browser preview when you run `tsci dev`. It auto-reloads when you make changes, no need to reload the page or re-run the command.
-
-> [!TIP] Make sure to replace this README with some details about your project and how to use it.
-
-## Publishing
-
-After you're satisfied with your project, publish it on the [tscircuit registry](https://registry.tscircuit.com) with `tsci publish`

package/example-project/examples/basic-capacitor.tsx

@@ -1,5 +0,0 @@
-export const CapacitorExample = () => (
-  <board width="10mm" height="10mm">
-    <capacitor capacitance="10uF" name="C1" footprint="0805" />
-  </board>
-)

package/example-project/examples/basic-chip.tsx

@@ -1,26 +0,0 @@
-import "@tscircuit/core"
-import { layout } from "@tscircuit/layout"
-import manual_edits from "../src/manual-edits"
-
-export const BasicChip = () => (
-  <board pcbX={0} pcbY={0} width="20mm" height="20mm">
-    <group subcircuit>
-      <chip
-        name="U2"
-        schPortArrangement={{
-          leftSize: 8,
-          rightSize: 8,
-        }}
-        footprint="ssop16"
-        pinLabels={{
-          "1": "GND",
-          "2": "VBUS",
-          "3": "D-",
-          "4": "D+",
-        }}
-      />
-      <resistor name="R1" pcbX={4} resistance="10kohm" footprint="0805" />
-      <trace from=".U2 > .1" to=".R1 > port.1" />
-    </group>
-  </board>
-)

package/example-project/examples/basic-resistor.tsx

@@ -1,3 +0,0 @@
-import { MyCircuit } from "../src/MyCircuit"
-
-export const ExampleResistor = () => <MyCircuit />

package/example-project/examples/macrokeypad.tsx

@@ -1,59 +0,0 @@
-import { layout } from "@tscircuit/layout"
-import { ArduinoProMicroBreakout } from "example-project/src/ArduinoProMicroBreakout"
-import { Key } from "example-project/src/Key"
-import manualEdits from "example-project/src/manual-edits"
-import { KeyswitchSocket } from "example-project/src/KeyswitchSocket"
-
-export const MacroKeypad = () => {
-  const keyPositions = Array.from({ length: 9 })
-    .map((_, i) => ({
-      keyNum: i + 1,
-      col: i % 3,
-      row: Math.floor(i / 3),
-    }))
-    .map((p) => ({
-      ...p,
-      x: p.col * 19.05 - 19.05,
-      y: p.row * 19.05 - 19.05,
-    }))
-
-  const rowToMicroPin = {
-    0: "D2",
-    1: "D3",
-    2: "D4",
-  }
-  const colToMicroPin = {
-    0: "D5",
-    1: "D6",
-    2: "D7",
-  }
-
-  return (
-    <board
-      width="85mm"
-      height="60mm"
-      layout={layout().manualEdits(manualEdits)}
-    >
-      {keyPositions.map(({ keyNum, x, y }) => (
-        <Key name={`K${keyNum}`} keyNum={keyNum} pcbX={x - 12.5} pcbY={y + 2} />
-      ))}
-      <ArduinoProMicroBreakout key="u1" name="U1" pcbX={30.5} />
-      {keyPositions.map(({ keyNum, row, col }) => (
-        <trace
-          // @ts-ignore
-          key={`trace-${keyNum}-col`}
-          from={`.SW${keyNum} .pin1`}
-          to={`.U1 .${colToMicroPin[col as 0 | 1 | 2]}`}
-        />
-      ))}
-      {keyPositions.map(({ keyNum, row, col }) => (
-        <trace
-          // @ts-ignore
-          key={`trace-${keyNum}-row`}
-          from={`.D${keyNum} .pin2`}
-          to={`.U1 .${rowToMicroPin[row as 0 | 1 | 2]}`}
-        />
-      ))}
-    </board>
-  )
-}

package/example-project/index.ts

@@ -1 +0,0 @@
-export * from "./src/MyCircuit"

package/example-project/package.json

@@ -1,5 +0,0 @@
-{
-  "name": "example-project",
-  "description": "An example project for tscircuit, this package.json is required",
-  "type": "module"
-}

package/example-project/src/ArduinoProMicroBreakout.tsx

@@ -1,37 +0,0 @@
-export const ArduinoProMicroBreakout = (props: {
-  name: string
-  pcbX?: number
-  pcbY?: number
-}) => (
-  <chip
-    {...props}
-    footprint="dip24_w0.7in_h1.3in"
-    pinLabels={{
-      pin1: "TXD",
-      pin2: "RXI",
-      pin3: "GND1",
-      pin4: "GND2",
-      pin5: "D2",
-      pin6: "D3",
-      pin7: "D4",
-      pin8: "D5",
-      pin9: "D6",
-      pin10: "D7",
-      pin11: "D8",
-      pin12: "D9",
-      // right side (from bottom)
-      pin13: "D10",
-      pin14: "D16",
-      pin15: "D14",
-      pin16: "D15",
-      pin17: "A0",
-      pin18: "A1",
-      pin19: "A2",
-      pin20: "A3",
-      pin21: "VCC",
-      pin22: "RST",
-      pin23: "GND3",
-      pin24: "RAW",
-    }}
-  />
-)

package/example-project/src/Key.tsx

@@ -1,46 +0,0 @@
-import { Keyswitch } from "./Keyswitch"
-import { KeyswitchSocket } from "./KeyswitchSocket"
-
-export const Key = (props: {
-  name: string
-  keyNum: number
-  pcbX: number
-  pcbY: number
-}) => {
-  const socketName = `SW${props.keyNum}`
-  const switchHoleName = `HO${props.keyNum}`
-  const diodeName = `D${props.keyNum}`
-  return (
-    <>
-      <KeyswitchSocket
-        key="shaft1"
-        layer="bottom"
-        name={socketName}
-        pcbX={props.pcbX}
-        pcbY={props.pcbY}
-      />
-      <Keyswitch
-        key="switch"
-        name={switchHoleName}
-        pcbX={props.pcbX + 0.55}
-        pcbY={props.pcbY + -3.81}
-      />
-      <diode
-        // @ts-ignore
-        key="diode"
-        pcbRotation={-90}
-        name={diodeName}
-        footprint="0603"
-        layer="bottom"
-        pcbX={props.pcbX + 7}
-        pcbY={props.pcbY - 6}
-      />
-      <trace
-        // @ts-ignore
-        key="trace1"
-        from={`.${socketName} .pin2`}
-        to={`.${diodeName} .pin1`}
-      />
-    </>
-  )
-}

package/example-project/src/Keyswitch.tsx

@@ -1,26 +0,0 @@
-/**
- * Keyswitch (Brown)
- *
- * https://www.lcsc.com/datasheet/lcsc_datasheet_1912111437_Kailh-CPG1511F01S03_C400227.pdf
- */
-export const Keyswitch = (props: {
-  name: string
-  pcbX?: number
-  pcbY?: number
-}) => {
-  return (
-    <chip
-      {...props}
-      cadModel={{
-        objUrl:
-          "https://modelcdn.tscircuit.com/easyeda_models/download?pn=C400227",
-        rotationOffset: { x: 180, y: 0, z: -90 },
-      }}
-      footprint={
-        <footprint>
-          <hole diameter={2.5} pcbX={0} pcbY={0} />
-        </footprint>
-      }
-    />
-  )
-}

package/example-project/src/KeyswitchSocket.tsx

@@ -1,56 +0,0 @@
-import "@tscircuit/core"
-
-/**
- * A switch shaft you can use to connect a pluggable Kailh socket.
- *
- * Datasheet: https://wmsc.lcsc.com/wmsc/upload/file/pdf/v2/lcsc/2211090930_Kailh-CPG151101S11-1_C5184526.pdf
- */
-export const KeyswitchSocket = (props: {
-  name: string
-  pcbX?: number
-  pcbY?: number
-  layer?: "top" | "bottom"
-}) => (
-  <chip
-    {...props}
-    pcbRotation={0}
-    cadModel={{
-      objUrl: `https://modelcdn.tscircuit.com/easyeda_models/download?pn=C5184526`,
-    }}
-    supplierPartNumbers={{
-      jlcpcb: ["C5184526"],
-    }}
-    footprint={
-      <footprint>
-        {/* <silkscreentext text={props.name} /> */}
-        <smtpad
-          shape="rect"
-          width="2.55mm"
-          height="2.5mm"
-          portHints={["pin1"]}
-          layer="top"
-        />
-        <smtpad
-          shape="rect"
-          width="2.55mm"
-          height="2.5mm"
-          portHints={["pin2"]}
-          layer="top"
-        />
-        <hole name="H1" diameter="3mm" />
-        <hole name="H2" diameter="3mm" />
-        <constraint xDist="6.35mm" centerToCenter left=".H1" right=".H2" />
-        <constraint yDist="2.54mm" centerToCenter top=".H1" bottom=".H2" />
-        <constraint edgeToEdge xDist="11.3mm" left=".pin1" right=".pin2" />
-        <constraint sameY for={[".pin1", ".H1"]} />
-        <constraint sameY for={[".pin2", ".H2"]} />
-        <constraint
-          edgeToEdge
-          xDist={(11.3 - 6.35 - 3) / 2}
-          left=".pin1"
-          right=".H1"
-        />
-      </footprint>
-    }
-  />
-)

package/example-project/src/MyCircuit.tsx

@@ -1,38 +0,0 @@
-import "@tscircuit/react-fiber"
-import { layout } from "@tscircuit/layout"
-import manual_edits from "./manual-edits"
-
-export const MyCircuit = () => (
-  <board width="40mm" height="40mm" pcbX={0} pcbY={0}>
-    <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 > .pin1" to=".R2 > .pin2" />
-    {/* <tracehint
-      for=".R1 > .right"
-      offsets={[
-        {
-          x: 3,
-          y: 3,
-        },
-      ]}
-    /> */}
-  </board>
-)

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

@@ -1,93 +0,0 @@
-/**
- * DO NOT EDIT THIS FILE DIRECTLY!
- *
- * This file is automatically edited when running `tsci dev` and dragging things
- * around. `tsci dev` searches for a file named "*.manual-edits.ts" and edits
- * it when you e.g. move a footprint. If there are multiple files, it'll try
- * to pick one based on context or ask.
- *
- * If you're not running `tsci dev`, you can safely edit this file.
- */
-export default {
-  // Generated when this file is created, this unique identifier is used to help
-  // determine which file to edit when there are many *.manual-edits.ts files
-  manual_edit_id: "abcdef",
-
-  // Manual pcb placements, added when you drag a footprint
-  pcb_placements: [
-    {
-      _edit_event_id: "0.6668756126702717",
-      selector: ".U2",
-      center: {
-        x: -5.830346475507767,
-        y: -1.3620071684587813,
-      },
-      relative_to: "group_center",
-    },
-    {
-      _edit_event_id: "0.867524742177592",
-      selector: ".R1",
-      center: {
-        x: 3.679808841099163,
-        y: 3.6320191158900847,
-      },
-      relative_to: "group_center",
-    },
-    {
-      _edit_event_id: "0.4555106760070762",
-      selector: ".C1",
-      center: {
-        x: 0,
-        y: 2.6666666666666665,
-      },
-      relative_to: "group_center",
-    },
-    {
-      _edit_event_id: "0.6123290063979561",
-      selector: ".R2",
-      center: {
-        x: 13.457749922536511,
-        y: 5.576084911465589,
-      },
-      relative_to: "group_center",
-    },
-  ],
-  manual_trace_hints: [
-    {
-      pcb_port_selector: ".D9 > .pin2",
-      offsets: [
-        {
-          x: 17.58431693903126,
-          y: 15.875996800068524,
-          via: false,
-        },
-        {
-          x: 18.01072486303387,
-          y: 2.621817162320708,
-          via: false,
-        },
-        {
-          x: 23.127619951065203,
-          y: 2.4441471939862858,
-          via: false,
-        },
-      ],
-    },
-    {
-      pcb_port_selector: ".D4 > .pin2",
-      offsets: [
-        {
-          x: -21.94914509505002,
-          y: -3.063375950444515,
-          via: true,
-        },
-        {
-          x: -16.627383568380463,
-          y: -3.006761466118242,
-          via: true,
-        },
-      ],
-    },
-  ],
-  edit_events: [],
-}

package/frontend/README.md

@@ -1,3 +0,0 @@
-# @tscircuit/dev-server-frontend
-
-Frontend for the tscircuit dev server.

package/frontend/components/command-k.tsx

@@ -1,86 +0,0 @@
-import { useEffect, useState } from "react"
-import {
-  Command,
-  CommandDialog,
-  CommandGroup,
-  CommandInput,
-  CommandItem,
-  CommandList,
-  CommandShortcut,
-} from "./ui/command"
-import { useGlobalStore } from "frontend/hooks/use-global-store"
-import { useDevPackageExamples } from "../hooks/use-dev-package-examples"
-import { CommandSeparator } from "cmdk"
-
-export const CommandK = () => {
-  const [open, setOpen] = useState(false)
-  const store = useGlobalStore()
-  useEffect(() => {
-    const down = (e: KeyboardEvent) => {
-      if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
-        e.preventDefault()
-        setOpen((open) => !open)
-      }
-      if (e.key === "Escape") {
-        setOpen(false)
-      }
-    }
-
-    document.addEventListener("keydown", down)
-    return () => document.removeEventListener("keydown", down)
-  }, [])
-
-  const { data: examples } = useDevPackageExamples()
-
-  const close = () => {
-    setOpen(false)
-    return true
-  }
-
-  return (
-    <CommandDialog open={open} onOpenChange={(open) => setOpen(open)}>
-      <Command className="rounded-lg border shadow-md">
-        <CommandInput placeholder="Type a command or search..." />
-        <CommandList>
-          <CommandGroup heading="Viewing Options">
-            <CommandItem
-              onSelect={() => close() && store.setViewMode("schematic")}
-            >
-              View Schematic
-              <CommandShortcut></CommandShortcut>
-            </CommandItem>
-            <CommandItem onSelect={() => close() && store.setViewMode("pcb")}>
-              View PCB
-              <CommandShortcut></CommandShortcut>
-            </CommandItem>
-            <CommandItem onSelect={() => close() && store.setViewMode("split")}>
-              View in Split Mode
-              <CommandShortcut></CommandShortcut>
-            </CommandItem>
-            <CommandItem onSelect={() => close() && store.setViewMode("split")}>
-              Vertical Split
-              <CommandShortcut></CommandShortcut>
-            </CommandItem>
-          </CommandGroup>
-          <CommandSeparator />
-          <CommandGroup heading="Examples">
-            {examples?.map((ex) => (
-              <CommandItem
-                key={ex.dev_package_example_id}
-                value={ex.expath}
-                onSelect={() =>
-                  close() &&
-                  store.setActiveDevExamplePackageId(
-                    ex.dev_package_example_id.toString(),
-                  )
-                }
-              >
-                {ex.expath}
-              </CommandItem>
-            ))}
-          </CommandGroup>
-        </CommandList>
-      </Command>
-    </CommandDialog>
-  )
-}