@tscircuit/checks 0.0.83 → 0.0.84
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,6 +5,18 @@ and output an array of arrays for any issues found.
|
|
|
5
5
|
|
|
6
6
|
[Getting Started Contributor Video](https://share.cleanshot.com/pk216661)
|
|
7
7
|
|
|
8
|
+
## Function Overview
|
|
9
|
+
|
|
10
|
+
| Function | Description |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| [`checkEachPcbPortConnected`](#checkeachpcbportconnectedsoup-anysoupelement--pcbtraceerror) | Verifies every `source_port` is connected to a net or its fellow source ports. |
|
|
13
|
+
| [`checkEachPcbTraceNonOverlapping`](#checkeachpcbtracenonoverlappingsoup-anysoupelement--pcbtraceerror) | Detects overlapping `pcb_trace` segments that aren't on the same net. |
|
|
14
|
+
| [`checkSameNetViaSpacing`](#checksamenetviaspacingcircuitjson-anycircuitelement--pcbviaclearanceerror) | Ensures vias sharing a net respect the minimum spacing margin. |
|
|
15
|
+
| [`checkDifferentNetViaSpacing`](#checkdifferentnetviaspacingcircuitjson-anycircuitelement--pcbviaclearanceerror) | Flags vias on different nets that violate clearance requirements. |
|
|
16
|
+
| [`checkViasOffBoard`](#checkviasoffboardcircuitjson-anycircuitelement--pcbplacementerror) | Checks for vias that extend beyond or cross the PCB boundary. |
|
|
17
|
+
| [`checkPcbComponentsOutOfBoard`](#checkpcbcomponentsoutofboardcircuitjson-anycircuitelement--pcbplacementerror) | Identifies PCB components that don't fit entirely within the board outline. |
|
|
18
|
+
| [`checkTracesAreContiguous`](#checktracesarecontiguouscircuitjson-anycircuitelement--pcbtraceerror) | Validates that traces align correctly and connect to their intended pads. |
|
|
19
|
+
|
|
8
20
|
## `checkEachPcbPortConnected(soup: AnySoupElement[]) => PCBTraceError[]`
|
|
9
21
|
|
|
10
22
|
Returns `pcb_trace_error` if any `source_port` is not connected to a net or it's other
|