@tscircuit/checks 0.0.182 → 0.0.184

package/README.md

@@ -153,3 +153,10 @@ export const pcb_trace_error = z
 export type PCBTraceErrorInput = z.input<typeof pcb_trace_error>
 export type PCBTraceError = z.infer<typeof pcb_trace_error>
 ```
+
+
+### checkSameNameNetsAreConnected
+
+Checks whether source nets with exactly the same nonblank name belong to one electrical network, including across subcircuits. Returns one `source_confusing_net_name_warning` per ambiguous name with the affected `source_net_ids`. Connectivity follows source traces, shared ports, and both forms of internal component pin connections; a shared name or scoped connectivity key alone does not connect nets.
+
+Included in `runAllNetlistChecks` and `runAllChecks`. This checks logical source connectivity; PCB routing continuity remains a separate check.

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as circuit_json from 'circuit-json';
-import { AnyCircuitElement, PcbPortNotConnectedError, PcbTraceError, PcbPlacementError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbComponentMissingCourtyardWarning, PcbTraceTooLongWarning, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning } from 'circuit-json';
+import { AnyCircuitElement, PcbPortNotConnectedError, PcbTraceError, PcbPlacementError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbComponentMissingCourtyardWarning, PcbTraceTooLongWarning, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentMisconfiguredError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning, SourceConfusingNetNameWarning } from 'circuit-json';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 declare function checkEachPcbPortConnectedToPcbTraces(circuitJson: AnyCircuitElement[]): PcbPortNotConnectedError[];
@@ -142,6 +142,8 @@ type SourcePinMustBeConnectedError = {
  */
 declare function checkPinMustBeConnected(circuitJson: AnyCircuitElement[]): SourcePinMustBeConnectedError[];
 
+declare function checkTwoTerminalSwitchContactsOnDifferentNets(circuitJson: AnyCircuitElement[]): SourceComponentMisconfiguredError[];
+
 /**
  * Check that each component with ports has at least one pin attribute
  * specified across its ports. Returns a warning when all pins are
@@ -182,7 +184,7 @@ declare function checkSchematicComponentMissingReferenceDesignatorText(circuitJs
 declare function checkSchematicComponentPortsOutsideBody(circuitJson: AnyCircuitElement[]): SchematicComponentStylingWarning[];
 
 declare function runAllPlacementChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbComponentMissingCourtyardWarning | circuit_json.PcbPadPadClearanceError | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
-declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<{
+declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<({
     type: "source_pin_must_be_connected_error";
     source_pin_must_be_connected_error_id: string;
     error_type: "source_pin_must_be_connected_error";
@@ -190,7 +192,7 @@ declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<
     source_component_id: string;
     source_port_id: string;
     subcircuit_id?: string;
-}[]>;
+} | circuit_json.SourceComponentMisconfiguredError | circuit_json.SourceConfusingNetNameWarning)[]>;
 declare function runAllSchematicChecks(circuitJson: AnyCircuitElement[]): Promise<circuit_json.SchematicComponentStylingWarning[]>;
 declare function runAllPinSpecificationChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning)[]>;
 declare function runAllRoutingChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbTraceTooLongWarning | circuit_json.PcbPadPadClearanceError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError)[]>;
@@ -202,7 +204,7 @@ declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circui
     source_component_id: string;
     source_port_id: string;
     subcircuit_id?: string;
-} | circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning | circuit_json.SchematicComponentStylingWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
+} | circuit_json.SourceComponentMisconfiguredError | circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning | circuit_json.SchematicComponentStylingWarning | circuit_json.SourceConfusingNetNameWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
 
 declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElement[]): PcbConnectorNotInAccessibleOrientationWarning[];
 
@@ -213,4 +215,7 @@ declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElem
  */
 declare function checkTestPointAccessibility(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
 
-export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSchematicComponentMissingReferenceDesignatorText, checkSchematicComponentPortsOutsideBody, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };
+/** Warn once per name when its source nets belong to multiple electrical islands. */
+declare function checkSameNameNetsAreConnected(circuitJson: AnyCircuitElement[]): SourceConfusingNetNameWarning[];
+
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsMissingCourtyard, checkPcbComponentsOutOfBoard, checkPcbCopperOverKeepout, checkPcbTraceLengths, checkPcbTraceViaCounts, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNameNetsAreConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSchematicComponentMissingReferenceDesignatorText, checkSchematicComponentPortsOutsideBody, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkTwoTerminalSwitchContactsOnDifferentNets, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };

package/dist/index.js

@@ -3914,6 +3914,51 @@ function checkPinMustBeConnected(circuitJson) {
   return errors;
 }
 
+// lib/check-two-terminal-switch-contacts-on-different-nets.ts
+import {
+  source_component_misconfigured_error
+} from "circuit-json";
+function checkTwoTerminalSwitchContactsOnDifferentNets(circuitJson) {
+  const switchingComponents = circuitJson.filter(
+    (element) => element.type === "source_component" && (element.ftype === "simple_push_button" || element.ftype === "simple_switch")
+  );
+  const sourcePorts = circuitJson.filter(
+    (element) => element.type === "source_port"
+  );
+  const schematicPorts = circuitJson.filter(
+    (element) => element.type === "schematic_port"
+  );
+  const errors = [];
+  for (const switchingComponent of switchingComponents) {
+    const schematicContactSourcePorts = schematicPorts.flatMap(
+      (schematicPort) => {
+        const sourcePort = sourcePorts.find(
+          (sourcePort2) => sourcePort2.source_port_id === schematicPort.source_port_id && sourcePort2.source_component_id === switchingComponent.source_component_id
+        );
+        if (!sourcePort) return [];
+        return [sourcePort];
+      }
+    );
+    if (schematicContactSourcePorts.length !== 2) continue;
+    const firstContactConnectivityKey = schematicContactSourcePorts[0].subcircuit_connectivity_map_key;
+    const secondContactConnectivityKey = schematicContactSourcePorts[1].subcircuit_connectivity_map_key;
+    if (!firstContactConnectivityKey) continue;
+    if (firstContactConnectivityKey !== secondContactConnectivityKey) continue;
+    errors.push(
+      source_component_misconfigured_error.parse({
+        type: "source_component_misconfigured_error",
+        message: `Switch ${switchingComponent.name} has both schematic contacts connected to the same net. Check internallyConnectedPins and the footprint pin mapping.`,
+        source_component_ids: [switchingComponent.source_component_id],
+        source_port_ids: schematicContactSourcePorts.map(
+          (sourcePort) => sourcePort.source_port_id
+        ),
+        is_fatal: true
+      })
+    );
+  }
+  return errors;
+}
+
 // lib/check-all-pins-in-component-are-underspecified.ts
 import { cju as cju7 } from "@tscircuit/circuit-json-util";
 var PIN_ATTRIBUTE_KEYS = [
@@ -4314,6 +4359,66 @@ function checkSchematicComponentPortsOutsideBody(circuitJson) {
   return warnings;
 }
 
+// lib/check-same-name-nets-are-connected.ts
+function checkSameNameNetsAreConnected(circuitJson) {
+  const parents = /* @__PURE__ */ new Map();
+  const find = (id) => {
+    let root = id;
+    while (parents.has(root) && parents.get(root) !== root) {
+      root = parents.get(root);
+    }
+    while (parents.has(id) && parents.get(id) !== root) {
+      const next = parents.get(id);
+      parents.set(id, root);
+      id = next;
+    }
+    return root;
+  };
+  const connect = (ids) => {
+    if (ids.length < 2) return;
+    const root = find(ids[0]);
+    for (const id of ids.slice(1)) parents.set(find(id), root);
+  };
+  const netsByName = /* @__PURE__ */ new Map();
+  for (const element of circuitJson) {
+    if (element.type === "source_net" && element.name.trim()) {
+      const nets = netsByName.get(element.name) ?? [];
+      nets.push(element);
+      netsByName.set(element.name, nets);
+    }
+    if (element.type === "source_trace") {
+      connect([
+        ...element.connected_source_net_ids.map((id) => `net:${id}`),
+        ...element.connected_source_port_ids.map((id) => `port:${id}`)
+      ]);
+    }
+    if (element.type === "source_component_internal_connection") {
+      connect(element.source_port_ids.map((id) => `port:${id}`));
+    }
+    if (element.type === "source_component") {
+      for (const ids of element.internally_connected_source_port_ids ?? []) {
+        connect(ids.map((id) => `port:${id}`));
+      }
+    }
+  }
+  const warnings = [];
+  for (const [name, nets] of netsByName) {
+    const islands = new Set(nets.map((net) => find(`net:${net.source_net_id}`)));
+    if (islands.size < 2) continue;
+    const ids = nets.map((net) => net.source_net_id).sort();
+    warnings.push({
+      type: "source_confusing_net_name_warning",
+      source_confusing_net_name_warning_id: `source_confusing_net_name_warning_${ids[0]}`,
+      warning_type: "source_confusing_net_name_warning",
+      message: `Nets named "${name}" are not all connected (${islands.size} separate electrical networks). Connect them or use distinct names to avoid confusion.`,
+      source_net_ids: ids,
+      net_name: name,
+      ...nets.every((net) => net.subcircuit_id === nets[0].subcircuit_id) ? { subcircuit_id: nets[0].subcircuit_id } : {}
+    });
+  }
+  return warnings;
+}
+
 // lib/check-connector-accessible-orientation.ts
 import { getBoardBounds } from "@tscircuit/circuit-json-util";
 function getFacingDirectionFromInsertionDirection(component) {
@@ -4598,7 +4703,11 @@ async function runAllPlacementChecks(circuitJson) {
   ];
 }
 async function runAllNetlistChecks(circuitJson) {
-  return [...checkPinMustBeConnected(circuitJson)];
+  return [
+    ...checkPinMustBeConnected(circuitJson),
+    ...checkSameNameNetsAreConnected(circuitJson),
+    ...checkTwoTerminalSwitchContactsOnDifferentNets(circuitJson)
+  ];
 }
 async function runAllSchematicChecks(circuitJson) {
   return [
@@ -4660,6 +4769,7 @@ export {
   checkPcbTraceViaCounts,
   checkPcbTracesOutOfBoard,
   checkPinMustBeConnected,
+  checkSameNameNetsAreConnected,
   checkSameNetViaSpacing,
   checkSchematicComponentExcessiveVerticalPadding,
   checkSchematicComponentMissingReferenceDesignatorText,
@@ -4668,6 +4778,7 @@ export {
   checkSourceTracesMatchPcbTraceThickness,
   checkTestPointAccessibility,
   checkTracesAreContiguous,
+  checkTwoTerminalSwitchContactsOnDifferentNets,
   checkViaPadClearance,
   checkViaTraceClearance,
   checkViasInPads,