@tscircuit/checks 0.0.160 → 0.0.161

package/README.md

@@ -14,6 +14,7 @@ and output an array of arrays for any issues found.
 | [`checkAllPinsInComponentAreUnderspecified`](./lib/check-all-pins-in-component-are-underspecified.ts) | Returns `source_component_pins_underspecified_warning` when every pin on a chip lacks pin attributes. |
 | [`checkNoPowerPinDefined`](./lib/check-no-power-pin-defined.ts) | Returns `source_no_power_pin_defined_warning` when a chip has no pin with `requires_power=true`. |
 | [`checkNoGroundPinDefined`](./lib/check-no-ground-pin-defined.ts) | Returns `source_no_ground_pin_defined_warning` when a chip has no pin with `requires_ground=true`. |
+| [`checkSchematicComponentExcessiveVerticalPadding`](./lib/check-schematic-component-excessive-vertical-padding.ts) | Returns a `schematic_component_styling_warning` with `styling_issue_type: "excessive_top_padding"` or `"excessive_bottom_padding"` when a box-style component has more than three pin spacings of empty space above or below its left/right pins. |
 | [`checkDifferentNetViaSpacing`](./lib/check-different-net-via-spacing.ts) | Returns `pcb_via_clearance_error` if vias on different nets are too close together. |
 | [`checkEachPcbPortConnectedToPcbTraces`](./lib/check-each-pcb-port-connected-to-pcb-trace.ts) | Returns `pcb_trace_error` if any `source_port` is not connected to its corresponding PCB traces. |
 | [`checkEachPcbTraceNonOverlapping`](./lib/check-each-pcb-trace-non-overlapping/check-each-pcb-trace-non-overlapping.ts) | Returns `pcb_trace_error` when `pcb_trace` segments physically overlap incompatible geometry on the same layer. Pad/via near-misses are reported by the typed clearance checks instead. |
@@ -36,8 +37,9 @@ and output an array of arrays for any issues found.
 | [`runAllPlacementChecks`](./lib/run-all-checks.ts) | Runs placement checks (`checkCopperToBoardEdgeClearance`, `checkPcbComponentsOutOfBoard`, `checkPcbComponentOverlap`, `checkPadPadClearance`, `checkCourtyardOverlap`, `checkConnectorAccessibleOrientation`, and `checkTestPointAccessibility`). |
 | [`runAllNetlistChecks`](./lib/run-all-checks.ts) | Runs netlist connectivity checks (currently `checkPinMustBeConnected`). |
 | [`runAllPinSpecificationChecks`](./lib/run-all-checks.ts) | Runs pin specification checks (e.g. `checkAllPinsInComponentAreUnderspecified`, `checkNoPowerPinDefined`, and `checkNoGroundPinDefined`). |
+| [`runAllSchematicChecks`](./lib/run-all-checks.ts) | Runs schematic-layout checks (currently `checkSchematicComponentExcessiveVerticalPadding`). |
 | [`runAllRoutingChecks`](./lib/run-all-checks.ts) | Runs all routing checks currently enabled (`checkEachPcbPortConnectedToPcbTraces`, `checkSourceTracesHavePcbTraces`, `checkEachPcbTraceNonOverlapping`, `checkPadTraceClearance`, `checkViaTraceClearance`, same/different net via spacing, and `checkPcbTracesOutOfBoard`). Trace-obstacle pairs are classified before aggregation, so each pair produces one overlap or clearance diagnostic, never both. |
-| [`runAllChecks`](./lib/run-all-checks.ts) | Runs placement, netlist, pin specification, and routing checks and returns a combined list of issues. |
+| [`runAllChecks`](./lib/run-all-checks.ts) | Runs placement, schematic, netlist, pin specification, and routing checks and returns a combined list of issues. |
 
 ## Implementation Details
 

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, PcbTraceTooLongWarning, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, PcbConnectorNotInAccessibleOrientationWarning } from 'circuit-json';
+import { AnyCircuitElement, PcbPortNotConnectedError, PcbTraceError, PcbPlacementError, PcbComponentOutsideBoardError, PcbViaClearanceError, PcbTraceWarning, PcbTraceMissingError, PcbFootprintOverlapError, PcbTraceTooLongWarning, PcbPadPadClearanceError, PcbPadTraceClearanceError, PcbViaTraceClearanceError, SourceComponentPinsUnderspecifiedWarning, SourceNoPowerPinDefinedWarning, SourceNoGroundPinDefinedWarning, SchematicComponentStylingWarning, PcbConnectorNotInAccessibleOrientationWarning } from 'circuit-json';
 import { ConnectivityMap } from 'circuit-json-to-connectivity-map';
 
 declare function checkEachPcbPortConnectedToPcbTraces(circuitJson: AnyCircuitElement[]): PcbPortNotConnectedError[];
@@ -152,6 +152,13 @@ declare function checkNoPowerPinDefined(circuitJson: AnyCircuitElement[]): Sourc
  */
 declare function checkNoGroundPinDefined(circuitJson: AnyCircuitElement[]): SourceNoGroundPinDefinedWarning[];
 
+/**
+ * Warns when the left/right pins of a box-style schematic component leave
+ * excessive empty space above or below their vertical span. This commonly
+ * happens when an unnecessarily large schematic height is set on a component.
+ */
+declare function checkSchematicComponentExcessiveVerticalPadding(circuitJson: AnyCircuitElement[]): SchematicComponentStylingWarning[];
+
 declare function runAllPlacementChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbPadPadClearanceError | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
 declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<{
     type: "source_pin_must_be_connected_error";
@@ -162,6 +169,7 @@ declare function runAllNetlistChecks(circuitJson: AnyCircuitElement[]): Promise<
     source_port_id: string;
     subcircuit_id?: string;
 }[]>;
+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)[]>;
 declare function runAllChecks(circuitJson: AnyCircuitElement[]): Promise<(circuit_json.PcbPortNotConnectedError | circuit_json.PcbTraceError | circuit_json.PcbPlacementError | circuit_json.PcbComponentOutsideBoardError | circuit_json.PcbViaClearanceError | circuit_json.PcbTraceMissingError | circuit_json.PcbFootprintOverlapError | circuit_json.PcbTraceTooLongWarning | circuit_json.PcbPadPadClearanceError | circuit_json.PcbPadTraceClearanceError | circuit_json.PcbViaTraceClearanceError | {
@@ -172,7 +180,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.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
+} | circuit_json.SourceComponentPinsUnderspecifiedWarning | circuit_json.SourceNoPowerPinDefinedWarning | circuit_json.SourceNoGroundPinDefinedWarning | circuit_json.SchematicComponentStylingWarning | circuit_json.PcbConnectorNotInAccessibleOrientationWarning | circuit_json.PcbCourtyardOverlapError)[]>;
 
 declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElement[]): PcbConnectorNotInAccessibleOrientationWarning[];
 
@@ -183,4 +191,4 @@ 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, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkCopperToBoardEdgeClearance, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSchematicComponentExcessiveVerticalPadding, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks, runAllSchematicChecks };

package/dist/index.js

@@ -3557,6 +3557,77 @@ function checkNoGroundPinDefined(circuitJson) {
   return warnings;
 }
 
+// lib/check-schematic-component-excessive-vertical-padding.ts
+var DEFAULT_PIN_SPACING = 0.2;
+var MAX_VERTICAL_PADDING_IN_PIN_SPACINGS = 3;
+var FLOATING_POINT_TOLERANCE = 1e-9;
+function checkSchematicComponentExcessiveVerticalPadding(circuitJson) {
+  const schematicComponents = circuitJson.filter(
+    (element) => element.type === "schematic_component"
+  );
+  const schematicPorts = circuitJson.filter(
+    (element) => element.type === "schematic_port"
+  );
+  const sourceComponents = circuitJson.filter(
+    (element) => element.type === "source_component"
+  );
+  const sourceComponentById = new Map(
+    sourceComponents.map((component) => [
+      component.source_component_id,
+      component
+    ])
+  );
+  const portsByComponentId = /* @__PURE__ */ new Map();
+  for (const port of schematicPorts) {
+    if (!port.schematic_component_id) continue;
+    const componentPorts = portsByComponentId.get(port.schematic_component_id) ?? [];
+    componentPorts.push(port);
+    portsByComponentId.set(port.schematic_component_id, componentPorts);
+  }
+  const warnings = [];
+  for (const component of schematicComponents) {
+    if (!component.is_box_with_pins || component.size.height <= 0) continue;
+    const sidePorts = (portsByComponentId.get(component.schematic_component_id) ?? []).filter(
+      (port) => port.side_of_component === "left" || port.side_of_component === "right"
+    );
+    if (sidePorts.length < 2) continue;
+    const pinYs = sidePorts.map((port) => port.center.y);
+    const highestPinY = Math.max(...pinYs);
+    const lowestPinY = Math.min(...pinYs);
+    const componentTopY = component.center.y + component.size.height / 2;
+    const componentBottomY = component.center.y - component.size.height / 2;
+    const pinSpacing = component.pin_spacing ?? DEFAULT_PIN_SPACING;
+    const maximumPadding = pinSpacing * MAX_VERTICAL_PADDING_IN_PIN_SPACINGS;
+    const paddingBySide = {
+      top: componentTopY - highestPinY,
+      bottom: lowestPinY - componentBottomY
+    };
+    const sourceComponent = component.source_component_id ? sourceComponentById.get(component.source_component_id) : void 0;
+    const componentName = sourceComponent?.name ?? component.schematic_component_id;
+    for (const side of ["top", "bottom"]) {
+      const padding = paddingBySide[side];
+      if (padding <= maximumPadding + FLOATING_POINT_TOLERANCE || padding <= 0) {
+        continue;
+      }
+      const relativePosition = side === "top" ? "above" : "below";
+      const stylingIssueType = `excessive_${side}_padding`;
+      warnings.push({
+        type: "schematic_component_styling_warning",
+        schematic_component_styling_warning_id: `schematic_component_styling_warning_${component.schematic_component_id}_${stylingIssueType}`,
+        warning_type: "schematic_component_styling_warning",
+        message: `${componentName} has excessive empty space ${relativePosition} its pins (${padding.toFixed(2)}mm, more than ${MAX_VERTICAL_PADDING_IN_PIN_SPACINGS} pin spacings)`,
+        schematic_component_id: component.schematic_component_id,
+        styling_issue_type: stylingIssueType,
+        schematic_port_ids: sidePorts.map((port) => port.schematic_port_id),
+        source_component_id: component.source_component_id,
+        schematic_sheet_id: component.schematic_sheet_id,
+        subcircuit_id: component.subcircuit_id
+      });
+    }
+  }
+  return warnings;
+}
+
 // lib/check-connector-accessible-orientation.ts
 import { getBoardBounds } from "@tscircuit/circuit-json-util";
 function getFacingDirectionFromInsertionDirection(component) {
@@ -3841,6 +3912,9 @@ async function runAllPlacementChecks(circuitJson) {
 async function runAllNetlistChecks(circuitJson) {
   return [...checkPinMustBeConnected(circuitJson)];
 }
+async function runAllSchematicChecks(circuitJson) {
+  return checkSchematicComponentExcessiveVerticalPadding(circuitJson);
+}
 async function runAllPinSpecificationChecks(circuitJson) {
   return [
     ...checkAllPinsInComponentAreUnderspecified(circuitJson),
@@ -3866,6 +3940,7 @@ async function runAllRoutingChecks(circuitJson) {
 async function runAllChecks(circuitJson) {
   return [
     ...await runAllPlacementChecks(circuitJson),
+    ...await runAllSchematicChecks(circuitJson),
     ...await runAllNetlistChecks(circuitJson),
     ...await runAllPinSpecificationChecks(circuitJson),
     ...await runAllRoutingChecks(circuitJson)
@@ -3890,6 +3965,7 @@ export {
   checkPcbTracesOutOfBoard,
   checkPinMustBeConnected,
   checkSameNetViaSpacing,
+  checkSchematicComponentExcessiveVerticalPadding,
   checkSourceTracesHavePcbTraces,
   checkSourceTracesMatchPcbTraceThickness,
   checkTestPointAccessibility,
@@ -3903,6 +3979,7 @@ export {
   runAllNetlistChecks,
   runAllPinSpecificationChecks,
   runAllPlacementChecks,
-  runAllRoutingChecks
+  runAllRoutingChecks,
+  runAllSchematicChecks
 };
 //# sourceMappingURL=index.js.map