copperflow 0.0.0-stage → 0.3.1
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/LICENSE +202 -0
- package/NOTICE +5 -0
- package/README.md +265 -2
- package/dist/app/THIRD_PARTY_LICENSES.txt +118 -0
- package/dist/app/assets/NewPartDialog-Qb7NwhBb.js +160 -0
- package/dist/app/assets/index-CSWIIMFE.css +1 -0
- package/dist/app/assets/index-C_TXwo-N.js +19 -0
- package/dist/app/index.html +15 -0
- package/dist/app/theme-boot.js +3 -0
- package/dist/cli-commands.d.ts +14 -0
- package/dist/cli-commands.js +285 -0
- package/dist/cli-commands.js.map +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +24 -0
- package/dist/cli.js.map +1 -0
- package/dist/core/analyze.d.ts +29 -0
- package/dist/core/analyze.js +284 -0
- package/dist/core/analyze.js.map +1 -0
- package/dist/core/annotations.d.ts +77 -0
- package/dist/core/annotations.js +138 -0
- package/dist/core/annotations.js.map +1 -0
- package/dist/core/board-edits.d.ts +8 -0
- package/dist/core/board-edits.js +56 -0
- package/dist/core/board-edits.js.map +1 -0
- package/dist/core/board-items.d.ts +40 -0
- package/dist/core/board-items.js +95 -0
- package/dist/core/board-items.js.map +1 -0
- package/dist/core/bom.d.ts +35 -0
- package/dist/core/bom.js +146 -0
- package/dist/core/bom.js.map +1 -0
- package/dist/core/check.d.ts +42 -0
- package/dist/core/check.js +91 -0
- package/dist/core/check.js.map +1 -0
- package/dist/core/checks-line.d.ts +7 -0
- package/dist/core/checks-line.js +8 -0
- package/dist/core/checks-line.js.map +1 -0
- package/dist/core/connection-names.d.ts +2 -0
- package/dist/core/connection-names.js +16 -0
- package/dist/core/connection-names.js.map +1 -0
- package/dist/core/design-source.d.ts +6 -0
- package/dist/core/design-source.js +14 -0
- package/dist/core/design-source.js.map +1 -0
- package/dist/core/drawing-edits.d.ts +19 -0
- package/dist/core/drawing-edits.js +158 -0
- package/dist/core/drawing-edits.js.map +1 -0
- package/dist/core/drawing-identity.d.ts +12 -0
- package/dist/core/drawing-identity.js +32 -0
- package/dist/core/drawing-identity.js.map +1 -0
- package/dist/core/drawing-names.d.ts +10 -0
- package/dist/core/drawing-names.js +30 -0
- package/dist/core/drawing-names.js.map +1 -0
- package/dist/core/drawing-scan.d.ts +41 -0
- package/dist/core/drawing-scan.js +82 -0
- package/dist/core/drawing-scan.js.map +1 -0
- package/dist/core/edit-error.d.ts +5 -0
- package/dist/core/edit-error.js +9 -0
- package/dist/core/edit-error.js.map +1 -0
- package/dist/core/edit-text.d.ts +28 -0
- package/dist/core/edit-text.js +89 -0
- package/dist/core/edit-text.js.map +1 -0
- package/dist/core/edit.d.ts +13 -0
- package/dist/core/edit.js +341 -0
- package/dist/core/edit.js.map +1 -0
- package/dist/core/fabrication.d.ts +39 -0
- package/dist/core/fabrication.js +94 -0
- package/dist/core/fabrication.js.map +1 -0
- package/dist/core/file-writes.d.ts +18 -0
- package/dist/core/file-writes.js +81 -0
- package/dist/core/file-writes.js.map +1 -0
- package/dist/core/fs-utils.d.ts +13 -0
- package/dist/core/fs-utils.js +51 -0
- package/dist/core/fs-utils.js.map +1 -0
- package/dist/core/history.d.ts +80 -0
- package/dist/core/history.js +161 -0
- package/dist/core/history.js.map +1 -0
- package/dist/core/index.d.ts +21 -0
- package/dist/core/index.js +22 -0
- package/dist/core/index.js.map +1 -0
- package/dist/core/instance-edits.d.ts +15 -0
- package/dist/core/instance-edits.js +69 -0
- package/dist/core/instance-edits.js.map +1 -0
- package/dist/core/instance-locks.d.ts +10 -0
- package/dist/core/instance-locks.js +16 -0
- package/dist/core/instance-locks.js.map +1 -0
- package/dist/core/instance-requests.d.ts +45 -0
- package/dist/core/instance-requests.js +93 -0
- package/dist/core/instance-requests.js.map +1 -0
- package/dist/core/layout-edits.d.ts +51 -0
- package/dist/core/layout-edits.js +82 -0
- package/dist/core/layout-edits.js.map +1 -0
- package/dist/core/layout-file.d.ts +80 -0
- package/dist/core/layout-file.js +209 -0
- package/dist/core/layout-file.js.map +1 -0
- package/dist/core/layout-locks.d.ts +38 -0
- package/dist/core/layout-locks.js +39 -0
- package/dist/core/layout-locks.js.map +1 -0
- package/dist/core/layout-records.d.ts +72 -0
- package/dist/core/layout-records.js +146 -0
- package/dist/core/layout-records.js.map +1 -0
- package/dist/core/library.d.ts +128 -0
- package/dist/core/library.js +378 -0
- package/dist/core/library.js.map +1 -0
- package/dist/core/literals.d.ts +19 -0
- package/dist/core/literals.js +106 -0
- package/dist/core/literals.js.map +1 -0
- package/dist/core/make-sheet.d.ts +44 -0
- package/dist/core/make-sheet.js +130 -0
- package/dist/core/make-sheet.js.map +1 -0
- package/dist/core/netlist.d.ts +41 -0
- package/dist/core/netlist.js +147 -0
- package/dist/core/netlist.js.map +1 -0
- package/dist/core/new-circuit-sheets.d.ts +35 -0
- package/dist/core/new-circuit-sheets.js +146 -0
- package/dist/core/new-circuit-sheets.js.map +1 -0
- package/dist/core/new-circuit.d.ts +65 -0
- package/dist/core/new-circuit.js +83 -0
- package/dist/core/new-circuit.js.map +1 -0
- package/dist/core/page-edits.d.ts +25 -0
- package/dist/core/page-edits.js +180 -0
- package/dist/core/page-edits.js.map +1 -0
- package/dist/core/pin-types.d.ts +8 -0
- package/dist/core/pin-types.js +10 -0
- package/dist/core/pin-types.js.map +1 -0
- package/dist/core/place.d.ts +30 -0
- package/dist/core/place.js +77 -0
- package/dist/core/place.js.map +1 -0
- package/dist/core/placement-write.d.ts +56 -0
- package/dist/core/placement-write.js +222 -0
- package/dist/core/placement-write.js.map +1 -0
- package/dist/core/pour-edits.d.ts +20 -0
- package/dist/core/pour-edits.js +241 -0
- package/dist/core/pour-edits.js.map +1 -0
- package/dist/core/project-text.d.ts +15 -0
- package/dist/core/project-text.js +58 -0
- package/dist/core/project-text.js.map +1 -0
- package/dist/core/project.d.ts +23 -0
- package/dist/core/project.js +63 -0
- package/dist/core/project.js.map +1 -0
- package/dist/core/rename-designators.d.ts +23 -0
- package/dist/core/rename-designators.js +83 -0
- package/dist/core/rename-designators.js.map +1 -0
- package/dist/core/rename-parts.d.ts +12 -0
- package/dist/core/rename-parts.js +129 -0
- package/dist/core/rename-parts.js.map +1 -0
- package/dist/core/rules-edit.d.ts +7 -0
- package/dist/core/rules-edit.js +56 -0
- package/dist/core/rules-edit.js.map +1 -0
- package/dist/core/selectors.d.ts +11 -0
- package/dist/core/selectors.js +33 -0
- package/dist/core/selectors.js.map +1 -0
- package/dist/core/sheet-cut-layout.d.ts +13 -0
- package/dist/core/sheet-cut-layout.js +62 -0
- package/dist/core/sheet-cut-layout.js.map +1 -0
- package/dist/core/sheet-cut-text.d.ts +23 -0
- package/dist/core/sheet-cut-text.js +129 -0
- package/dist/core/sheet-cut-text.js.map +1 -0
- package/dist/core/sheet-cut.d.ts +55 -0
- package/dist/core/sheet-cut.js +204 -0
- package/dist/core/sheet-cut.js.map +1 -0
- package/dist/core/sheet-edits.d.ts +12 -0
- package/dist/core/sheet-edits.js +107 -0
- package/dist/core/sheet-edits.js.map +1 -0
- package/dist/core/sheet-files.d.ts +31 -0
- package/dist/core/sheet-files.js +134 -0
- package/dist/core/sheet-files.js.map +1 -0
- package/dist/core/sheet-layout.d.ts +27 -0
- package/dist/core/sheet-layout.js +60 -0
- package/dist/core/sheet-layout.js.map +1 -0
- package/dist/core/summary.d.ts +10 -0
- package/dist/core/summary.js +79 -0
- package/dist/core/summary.js.map +1 -0
- package/dist/core/track-split.d.ts +22 -0
- package/dist/core/track-split.js +24 -0
- package/dist/core/track-split.js.map +1 -0
- package/dist/core/types.d.ts +309 -0
- package/dist/core/types.js +2 -0
- package/dist/core/types.js.map +1 -0
- package/dist/core/unroute.d.ts +56 -0
- package/dist/core/unroute.js +87 -0
- package/dist/core/unroute.js.map +1 -0
- package/dist/core/workspace.d.ts +94 -0
- package/dist/core/workspace.js +376 -0
- package/dist/core/workspace.js.map +1 -0
- package/dist/engine/autoplace.d.ts +18 -0
- package/dist/engine/autoplace.js +68 -0
- package/dist/engine/autoplace.js.map +1 -0
- package/dist/engine/board.d.ts +12 -0
- package/dist/engine/board.js +60 -0
- package/dist/engine/board.js.map +1 -0
- package/dist/engine/checks/copper-clearance.d.ts +7 -0
- package/dist/engine/checks/copper-clearance.js +116 -0
- package/dist/engine/checks/copper-clearance.js.map +1 -0
- package/dist/engine/checks/copper-notes.d.ts +11 -0
- package/dist/engine/checks/copper-notes.js +17 -0
- package/dist/engine/checks/copper-notes.js.map +1 -0
- package/dist/engine/checks/copper-pieces.d.ts +26 -0
- package/dist/engine/checks/copper-pieces.js +42 -0
- package/dist/engine/checks/copper-pieces.js.map +1 -0
- package/dist/engine/checks/copper-violation.d.ts +9 -0
- package/dist/engine/checks/copper-violation.js +11 -0
- package/dist/engine/checks/copper-violation.js.map +1 -0
- package/dist/engine/checks/drc-copper.d.ts +14 -0
- package/dist/engine/checks/drc-copper.js +139 -0
- package/dist/engine/checks/drc-copper.js.map +1 -0
- package/dist/engine/checks/drc-pads.d.ts +8 -0
- package/dist/engine/checks/drc-pads.js +172 -0
- package/dist/engine/checks/drc-pads.js.map +1 -0
- package/dist/engine/checks/drc-parts.d.ts +5 -0
- package/dist/engine/checks/drc-parts.js +208 -0
- package/dist/engine/checks/drc-parts.js.map +1 -0
- package/dist/engine/checks/drc-pours.d.ts +6 -0
- package/dist/engine/checks/drc-pours.js +240 -0
- package/dist/engine/checks/drc-pours.js.map +1 -0
- package/dist/engine/checks/erc.d.ts +6 -0
- package/dist/engine/checks/erc.js +94 -0
- package/dist/engine/checks/erc.js.map +1 -0
- package/dist/engine/checks/fillet-guard.d.ts +29 -0
- package/dist/engine/checks/fillet-guard.js +75 -0
- package/dist/engine/checks/fillet-guard.js.map +1 -0
- package/dist/engine/checks/geometry.d.ts +25 -0
- package/dist/engine/checks/geometry.js +182 -0
- package/dist/engine/checks/geometry.js.map +1 -0
- package/dist/engine/checks/grid-index.d.ts +24 -0
- package/dist/engine/checks/grid-index.js +57 -0
- package/dist/engine/checks/grid-index.js.map +1 -0
- package/dist/engine/checks/index.d.ts +16 -0
- package/dist/engine/checks/index.js +55 -0
- package/dist/engine/checks/index.js.map +1 -0
- package/dist/engine/checks/limits.d.ts +7 -0
- package/dist/engine/checks/limits.js +10 -0
- package/dist/engine/checks/limits.js.map +1 -0
- package/dist/engine/checks/unplaced-parts.d.ts +4 -0
- package/dist/engine/checks/unplaced-parts.js +29 -0
- package/dist/engine/checks/unplaced-parts.js.map +1 -0
- package/dist/engine/checks/violation.d.ts +14 -0
- package/dist/engine/checks/violation.js +7 -0
- package/dist/engine/checks/violation.js.map +1 -0
- package/dist/engine/component.d.ts +34 -0
- package/dist/engine/component.js +125 -0
- package/dist/engine/component.js.map +1 -0
- package/dist/engine/copper.d.ts +63 -0
- package/dist/engine/copper.js +276 -0
- package/dist/engine/copper.js.map +1 -0
- package/dist/engine/design.d.ts +21 -0
- package/dist/engine/design.js +63 -0
- package/dist/engine/design.js.map +1 -0
- package/dist/engine/diagnostics.d.ts +2 -0
- package/dist/engine/diagnostics.js +6 -0
- package/dist/engine/diagnostics.js.map +1 -0
- package/dist/engine/drawing-ids.d.ts +23 -0
- package/dist/engine/drawing-ids.js +45 -0
- package/dist/engine/drawing-ids.js.map +1 -0
- package/dist/engine/drawing-kinds.d.ts +18 -0
- package/dist/engine/drawing-kinds.js +102 -0
- package/dist/engine/drawing-kinds.js.map +1 -0
- package/dist/engine/drawing-reader.d.ts +42 -0
- package/dist/engine/drawing-reader.js +97 -0
- package/dist/engine/drawing-reader.js.map +1 -0
- package/dist/engine/drawings.d.ts +35 -0
- package/dist/engine/drawings.js +94 -0
- package/dist/engine/drawings.js.map +1 -0
- package/dist/engine/elaborate.d.ts +8 -0
- package/dist/engine/elaborate.js +490 -0
- package/dist/engine/elaborate.js.map +1 -0
- package/dist/engine/engine-worker.d.ts +1 -0
- package/dist/engine/engine-worker.js +17 -0
- package/dist/engine/engine-worker.js.map +1 -0
- package/dist/engine/engine.d.ts +41 -0
- package/dist/engine/engine.js +95 -0
- package/dist/engine/engine.js.map +1 -0
- package/dist/engine/evaluate.d.ts +10 -0
- package/dist/engine/evaluate.js +125 -0
- package/dist/engine/evaluate.js.map +1 -0
- package/dist/engine/fab/bom-csv.d.ts +5 -0
- package/dist/engine/fab/bom-csv.js +16 -0
- package/dist/engine/fab/bom-csv.js.map +1 -0
- package/dist/engine/fab/csv.d.ts +4 -0
- package/dist/engine/fab/csv.js +11 -0
- package/dist/engine/fab/csv.js.map +1 -0
- package/dist/engine/fab/designators.d.ts +42 -0
- package/dist/engine/fab/designators.js +109 -0
- package/dist/engine/fab/designators.js.map +1 -0
- package/dist/engine/fab/excellon.d.ts +23 -0
- package/dist/engine/fab/excellon.js +82 -0
- package/dist/engine/fab/excellon.js.map +1 -0
- package/dist/engine/fab/export.d.ts +33 -0
- package/dist/engine/fab/export.js +105 -0
- package/dist/engine/fab/export.js.map +1 -0
- package/dist/engine/fab/gerber.d.ts +53 -0
- package/dist/engine/fab/gerber.js +151 -0
- package/dist/engine/fab/gerber.js.map +1 -0
- package/dist/engine/fab/layers.d.ts +26 -0
- package/dist/engine/fab/layers.js +162 -0
- package/dist/engine/fab/layers.js.map +1 -0
- package/dist/engine/fab/names.d.ts +20 -0
- package/dist/engine/fab/names.js +58 -0
- package/dist/engine/fab/names.js.map +1 -0
- package/dist/engine/fab/pick-and-place.d.ts +5 -0
- package/dist/engine/fab/pick-and-place.js +36 -0
- package/dist/engine/fab/pick-and-place.js.map +1 -0
- package/dist/engine/fab/stroke-font.d.ts +8 -0
- package/dist/engine/fab/stroke-font.js +83 -0
- package/dist/engine/fab/stroke-font.js.map +1 -0
- package/dist/engine/fab/zip.d.ts +14 -0
- package/dist/engine/fab/zip.js +93 -0
- package/dist/engine/fab/zip.js.map +1 -0
- package/dist/engine/fillet-plan.d.ts +39 -0
- package/dist/engine/fillet-plan.js +87 -0
- package/dist/engine/fillet-plan.js.map +1 -0
- package/dist/engine/fillet.d.ts +54 -0
- package/dist/engine/fillet.js +175 -0
- package/dist/engine/fillet.js.map +1 -0
- package/dist/engine/footprints/bga.d.ts +14 -0
- package/dist/engine/footprints/bga.js +122 -0
- package/dist/engine/footprints/bga.js.map +1 -0
- package/dist/engine/footprints/chip.d.ts +3 -0
- package/dist/engine/footprints/chip.js +52 -0
- package/dist/engine/footprints/chip.js.map +1 -0
- package/dist/engine/footprints/crystal.d.ts +4 -0
- package/dist/engine/footprints/crystal.js +47 -0
- package/dist/engine/footprints/crystal.js.map +1 -0
- package/dist/engine/footprints/dfn.d.ts +13 -0
- package/dist/engine/footprints/dfn.js +52 -0
- package/dist/engine/footprints/dfn.js.map +1 -0
- package/dist/engine/footprints/dip.d.ts +8 -0
- package/dist/engine/footprints/dip.js +65 -0
- package/dist/engine/footprints/dip.js.map +1 -0
- package/dist/engine/footprints/dual.d.ts +14 -0
- package/dist/engine/footprints/dual.js +171 -0
- package/dist/engine/footprints/dual.js.map +1 -0
- package/dist/engine/footprints/exposed.d.ts +27 -0
- package/dist/engine/footprints/exposed.js +50 -0
- package/dist/engine/footprints/exposed.js.map +1 -0
- package/dist/engine/footprints/file.d.ts +65 -0
- package/dist/engine/footprints/file.js +141 -0
- package/dist/engine/footprints/file.js.map +1 -0
- package/dist/engine/footprints/ic.d.ts +34 -0
- package/dist/engine/footprints/ic.js +31 -0
- package/dist/engine/footprints/ic.js.map +1 -0
- package/dist/engine/footprints/index.d.ts +17 -0
- package/dist/engine/footprints/index.js +104 -0
- package/dist/engine/footprints/index.js.map +1 -0
- package/dist/engine/footprints/ipc7251.d.ts +30 -0
- package/dist/engine/footprints/ipc7251.js +44 -0
- package/dist/engine/footprints/ipc7251.js.map +1 -0
- package/dist/engine/footprints/ipc7351.d.ts +179 -0
- package/dist/engine/footprints/ipc7351.js +194 -0
- package/dist/engine/footprints/ipc7351.js.map +1 -0
- package/dist/engine/footprints/jedec.d.ts +24 -0
- package/dist/engine/footprints/jedec.js +148 -0
- package/dist/engine/footprints/jedec.js.map +1 -0
- package/dist/engine/footprints/known.d.ts +6 -0
- package/dist/engine/footprints/known.js +76 -0
- package/dist/engine/footprints/known.js.map +1 -0
- package/dist/engine/footprints/molded.d.ts +8 -0
- package/dist/engine/footprints/molded.js +76 -0
- package/dist/engine/footprints/molded.js.map +1 -0
- package/dist/engine/footprints/outline.d.ts +64 -0
- package/dist/engine/footprints/outline.js +187 -0
- package/dist/engine/footprints/outline.js.map +1 -0
- package/dist/engine/footprints/parse.d.ts +32 -0
- package/dist/engine/footprints/parse.js +68 -0
- package/dist/engine/footprints/parse.js.map +1 -0
- package/dist/engine/footprints/pinrow.d.ts +11 -0
- package/dist/engine/footprints/pinrow.js +102 -0
- package/dist/engine/footprints/pinrow.js.map +1 -0
- package/dist/engine/footprints/quad.d.ts +7 -0
- package/dist/engine/footprints/quad.js +135 -0
- package/dist/engine/footprints/quad.js.map +1 -0
- package/dist/engine/footprints/radial.d.ts +7 -0
- package/dist/engine/footprints/radial.js +62 -0
- package/dist/engine/footprints/radial.js.map +1 -0
- package/dist/engine/footprints/sod.d.ts +8 -0
- package/dist/engine/footprints/sod.js +60 -0
- package/dist/engine/footprints/sod.js.map +1 -0
- package/dist/engine/footprints/sot.d.ts +4 -0
- package/dist/engine/footprints/sot.js +72 -0
- package/dist/engine/footprints/sot.js.map +1 -0
- package/dist/engine/footprints/sotpower.d.ts +4 -0
- package/dist/engine/footprints/sotpower.js +98 -0
- package/dist/engine/footprints/sotpower.js.map +1 -0
- package/dist/engine/footprints/to220.d.ts +4 -0
- package/dist/engine/footprints/to220.js +49 -0
- package/dist/engine/footprints/to220.js.map +1 -0
- package/dist/engine/footprints/to92.d.ts +4 -0
- package/dist/engine/footprints/to92.js +43 -0
- package/dist/engine/footprints/to92.js.map +1 -0
- package/dist/engine/footprints/types.d.ts +50 -0
- package/dist/engine/footprints/types.js +3 -0
- package/dist/engine/footprints/types.js.map +1 -0
- package/dist/engine/hole.d.ts +15 -0
- package/dist/engine/hole.js +28 -0
- package/dist/engine/hole.js.map +1 -0
- package/dist/engine/index.d.ts +6 -0
- package/dist/engine/index.js +6 -0
- package/dist/engine/index.js.map +1 -0
- package/dist/engine/instance-anchor.d.ts +16 -0
- package/dist/engine/instance-anchor.js +45 -0
- package/dist/engine/instance-anchor.js.map +1 -0
- package/dist/engine/jsx-runtime.d.ts +26 -0
- package/dist/engine/jsx-runtime.js +49 -0
- package/dist/engine/jsx-runtime.js.map +1 -0
- package/dist/engine/keepout.d.ts +9 -0
- package/dist/engine/keepout.js +50 -0
- package/dist/engine/keepout.js.map +1 -0
- package/dist/engine/kinds.d.ts +34 -0
- package/dist/engine/kinds.js +134 -0
- package/dist/engine/kinds.js.map +1 -0
- package/dist/engine/model.d.ts +310 -0
- package/dist/engine/model.js +5 -0
- package/dist/engine/model.js.map +1 -0
- package/dist/engine/nets.d.ts +6 -0
- package/dist/engine/nets.js +49 -0
- package/dist/engine/nets.js.map +1 -0
- package/dist/engine/no-connect.d.ts +28 -0
- package/dist/engine/no-connect.js +36 -0
- package/dist/engine/no-connect.js.map +1 -0
- package/dist/engine/order.d.ts +7 -0
- package/dist/engine/order.js +25 -0
- package/dist/engine/order.js.map +1 -0
- package/dist/engine/pad-text.d.ts +20 -0
- package/dist/engine/pad-text.js +26 -0
- package/dist/engine/pad-text.js.map +1 -0
- package/dist/engine/part-labels.d.ts +29 -0
- package/dist/engine/part-labels.js +28 -0
- package/dist/engine/part-labels.js.map +1 -0
- package/dist/engine/pcb-place/blocks.d.ts +46 -0
- package/dist/engine/pcb-place/blocks.js +186 -0
- package/dist/engine/pcb-place/blocks.js.map +1 -0
- package/dist/engine/pcb-place/constructive.d.ts +73 -0
- package/dist/engine/pcb-place/constructive.js +515 -0
- package/dist/engine/pcb-place/constructive.js.map +1 -0
- package/dist/engine/pcb-place/edge.d.ts +7 -0
- package/dist/engine/pcb-place/edge.js +78 -0
- package/dist/engine/pcb-place/edge.js.map +1 -0
- package/dist/engine/pcb-place/fit-board.d.ts +22 -0
- package/dist/engine/pcb-place/fit-board.js +48 -0
- package/dist/engine/pcb-place/fit-board.js.map +1 -0
- package/dist/engine/pcb-place/geometry.d.ts +45 -0
- package/dist/engine/pcb-place/geometry.js +158 -0
- package/dist/engine/pcb-place/geometry.js.map +1 -0
- package/dist/engine/pcb-place/index.d.ts +81 -0
- package/dist/engine/pcb-place/index.js +98 -0
- package/dist/engine/pcb-place/index.js.map +1 -0
- package/dist/engine/pcb-place/refine.d.ts +32 -0
- package/dist/engine/pcb-place/refine.js +220 -0
- package/dist/engine/pcb-place/refine.js.map +1 -0
- package/dist/engine/pcb-place/roles.d.ts +37 -0
- package/dist/engine/pcb-place/roles.js +127 -0
- package/dist/engine/pcb-place/roles.js.map +1 -0
- package/dist/engine/pcb-place/scope.d.ts +80 -0
- package/dist/engine/pcb-place/scope.js +107 -0
- package/dist/engine/pcb-place/scope.js.map +1 -0
- package/dist/engine/pcb-place/score.d.ts +40 -0
- package/dist/engine/pcb-place/score.js +140 -0
- package/dist/engine/pcb-place/score.js.map +1 -0
- package/dist/engine/pcb.d.ts +72 -0
- package/dist/engine/pcb.js +153 -0
- package/dist/engine/pcb.js.map +1 -0
- package/dist/engine/pour/build.d.ts +32 -0
- package/dist/engine/pour/build.js +108 -0
- package/dist/engine/pour/build.js.map +1 -0
- package/dist/engine/pour/cache.d.ts +8 -0
- package/dist/engine/pour/cache.js +55 -0
- package/dist/engine/pour/cache.js.map +1 -0
- package/dist/engine/pour/clip.d.ts +50 -0
- package/dist/engine/pour/clip.js +72 -0
- package/dist/engine/pour/clip.js.map +1 -0
- package/dist/engine/pour/fill.d.ts +22 -0
- package/dist/engine/pour/fill.js +112 -0
- package/dist/engine/pour/fill.js.map +1 -0
- package/dist/engine/pour/islands.d.ts +8 -0
- package/dist/engine/pour/islands.js +19 -0
- package/dist/engine/pour/islands.js.map +1 -0
- package/dist/engine/pour/joins.d.ts +18 -0
- package/dist/engine/pour/joins.js +74 -0
- package/dist/engine/pour/joins.js.map +1 -0
- package/dist/engine/pour/obstacles.d.ts +45 -0
- package/dist/engine/pour/obstacles.js +85 -0
- package/dist/engine/pour/obstacles.js.map +1 -0
- package/dist/engine/pour/resolve.d.ts +21 -0
- package/dist/engine/pour/resolve.js +19 -0
- package/dist/engine/pour/resolve.js.map +1 -0
- package/dist/engine/pour/shapes.d.ts +9 -0
- package/dist/engine/pour/shapes.js +62 -0
- package/dist/engine/pour/shapes.js.map +1 -0
- package/dist/engine/pour/thermal.d.ts +16 -0
- package/dist/engine/pour/thermal.js +38 -0
- package/dist/engine/pour/thermal.js.map +1 -0
- package/dist/engine/project-files.d.ts +18 -0
- package/dist/engine/project-files.js +58 -0
- package/dist/engine/project-files.js.map +1 -0
- package/dist/engine/ratsnest.d.ts +16 -0
- package/dist/engine/ratsnest.js +69 -0
- package/dist/engine/ratsnest.js.map +1 -0
- package/dist/engine/read-props.d.ts +22 -0
- package/dist/engine/read-props.js +74 -0
- package/dist/engine/read-props.js.map +1 -0
- package/dist/engine/router/astar.d.ts +74 -0
- package/dist/engine/router/astar.js +231 -0
- package/dist/engine/router/astar.js.map +1 -0
- package/dist/engine/router/blockers.d.ts +4 -0
- package/dist/engine/router/blockers.js +69 -0
- package/dist/engine/router/blockers.js.map +1 -0
- package/dist/engine/router/cleanup.d.ts +21 -0
- package/dist/engine/router/cleanup.js +157 -0
- package/dist/engine/router/cleanup.js.map +1 -0
- package/dist/engine/router/clear.d.ts +18 -0
- package/dist/engine/router/clear.js +39 -0
- package/dist/engine/router/clear.js.map +1 -0
- package/dist/engine/router/congestion.d.ts +79 -0
- package/dist/engine/router/congestion.js +212 -0
- package/dist/engine/router/congestion.js.map +1 -0
- package/dist/engine/router/connect.d.ts +79 -0
- package/dist/engine/router/connect.js +174 -0
- package/dist/engine/router/connect.js.map +1 -0
- package/dist/engine/router/ends.d.ts +25 -0
- package/dist/engine/router/ends.js +135 -0
- package/dist/engine/router/ends.js.map +1 -0
- package/dist/engine/router/grid.d.ts +131 -0
- package/dist/engine/router/grid.js +297 -0
- package/dist/engine/router/grid.js.map +1 -0
- package/dist/engine/router/keep-clear.d.ts +10 -0
- package/dist/engine/router/keep-clear.js +60 -0
- package/dist/engine/router/keep-clear.js.map +1 -0
- package/dist/engine/router/obstacles.d.ts +18 -0
- package/dist/engine/router/obstacles.js +66 -0
- package/dist/engine/router/obstacles.js.map +1 -0
- package/dist/engine/router/path.d.ts +34 -0
- package/dist/engine/router/path.js +41 -0
- package/dist/engine/router/path.js.map +1 -0
- package/dist/engine/router/pour-rounds.d.ts +17 -0
- package/dist/engine/router/pour-rounds.js +124 -0
- package/dist/engine/router/pour-rounds.js.map +1 -0
- package/dist/engine/router/replicate.d.ts +32 -0
- package/dist/engine/router/replicate.js +143 -0
- package/dist/engine/router/replicate.js.map +1 -0
- package/dist/engine/router/rip-up.d.ts +5 -0
- package/dist/engine/router/rip-up.js +95 -0
- package/dist/engine/router/rip-up.js.map +1 -0
- package/dist/engine/router/route-board.d.ts +109 -0
- package/dist/engine/router/route-board.js +223 -0
- package/dist/engine/router/route-board.js.map +1 -0
- package/dist/engine/rules/classes.d.ts +14 -0
- package/dist/engine/rules/classes.js +50 -0
- package/dist/engine/rules/classes.js.map +1 -0
- package/dist/engine/rules/load.d.ts +14 -0
- package/dist/engine/rules/load.js +146 -0
- package/dist/engine/rules/load.js.map +1 -0
- package/dist/engine/rules/profiles.d.ts +5 -0
- package/dist/engine/rules/profiles.js +53 -0
- package/dist/engine/rules/profiles.js.map +1 -0
- package/dist/engine/rules/rotations.d.ts +31 -0
- package/dist/engine/rules/rotations.js +124 -0
- package/dist/engine/rules/rotations.js.map +1 -0
- package/dist/engine/rules/schema.d.ts +82 -0
- package/dist/engine/rules/schema.js +59 -0
- package/dist/engine/rules/schema.js.map +1 -0
- package/dist/engine/rules/track-defaults.d.ts +23 -0
- package/dist/engine/rules/track-defaults.js +26 -0
- package/dist/engine/rules/track-defaults.js.map +1 -0
- package/dist/engine/schematic-astar.d.ts +37 -0
- package/dist/engine/schematic-astar.js +202 -0
- package/dist/engine/schematic-astar.js.map +1 -0
- package/dist/engine/schematic-geometry.d.ts +23 -0
- package/dist/engine/schematic-geometry.js +49 -0
- package/dist/engine/schematic-geometry.js.map +1 -0
- package/dist/engine/schematic-grid.d.ts +60 -0
- package/dist/engine/schematic-grid.js +150 -0
- package/dist/engine/schematic-grid.js.map +1 -0
- package/dist/engine/schematic-nets.d.ts +38 -0
- package/dist/engine/schematic-nets.js +157 -0
- package/dist/engine/schematic-nets.js.map +1 -0
- package/dist/engine/schematic-pages.d.ts +9 -0
- package/dist/engine/schematic-pages.js +52 -0
- package/dist/engine/schematic-pages.js.map +1 -0
- package/dist/engine/schematic-place-chains.d.ts +22 -0
- package/dist/engine/schematic-place-chains.js +111 -0
- package/dist/engine/schematic-place-chains.js.map +1 -0
- package/dist/engine/schematic-place-plan.d.ts +43 -0
- package/dist/engine/schematic-place-plan.js +155 -0
- package/dist/engine/schematic-place-plan.js.map +1 -0
- package/dist/engine/schematic-place-units.d.ts +38 -0
- package/dist/engine/schematic-place-units.js +101 -0
- package/dist/engine/schematic-place-units.js.map +1 -0
- package/dist/engine/schematic-place.d.ts +5 -0
- package/dist/engine/schematic-place.js +268 -0
- package/dist/engine/schematic-place.js.map +1 -0
- package/dist/engine/schematic-route.d.ts +37 -0
- package/dist/engine/schematic-route.js +288 -0
- package/dist/engine/schematic-route.js.map +1 -0
- package/dist/engine/schematic-sheets.d.ts +22 -0
- package/dist/engine/schematic-sheets.js +104 -0
- package/dist/engine/schematic-sheets.js.map +1 -0
- package/dist/engine/schematic.d.ts +64 -0
- package/dist/engine/schematic.js +200 -0
- package/dist/engine/schematic.js.map +1 -0
- package/dist/engine/selectors.d.ts +25 -0
- package/dist/engine/selectors.js +28 -0
- package/dist/engine/selectors.js.map +1 -0
- package/dist/engine/sheet-ports.d.ts +44 -0
- package/dist/engine/sheet-ports.js +126 -0
- package/dist/engine/sheet-ports.js.map +1 -0
- package/dist/engine/sheet-symbol.d.ts +52 -0
- package/dist/engine/sheet-symbol.js +92 -0
- package/dist/engine/sheet-symbol.js.map +1 -0
- package/dist/engine/sheets.d.ts +79 -0
- package/dist/engine/sheets.js +159 -0
- package/dist/engine/sheets.js.map +1 -0
- package/dist/engine/symbols/box.d.ts +8 -0
- package/dist/engine/symbols/box.js +83 -0
- package/dist/engine/symbols/box.js.map +1 -0
- package/dist/engine/symbols/index.d.ts +8 -0
- package/dist/engine/symbols/index.js +58 -0
- package/dist/engine/symbols/index.js.map +1 -0
- package/dist/engine/symbols/passives.d.ts +16 -0
- package/dist/engine/symbols/passives.js +58 -0
- package/dist/engine/symbols/passives.js.map +1 -0
- package/dist/engine/symbols/power.d.ts +5 -0
- package/dist/engine/symbols/power.js +10 -0
- package/dist/engine/symbols/power.js.map +1 -0
- package/dist/engine/symbols/semis.d.ts +10 -0
- package/dist/engine/symbols/semis.js +62 -0
- package/dist/engine/symbols/semis.js.map +1 -0
- package/dist/engine/symbols/types.d.ts +83 -0
- package/dist/engine/symbols/types.js +61 -0
- package/dist/engine/symbols/types.js.map +1 -0
- package/dist/engine/traces.d.ts +29 -0
- package/dist/engine/traces.js +102 -0
- package/dist/engine/traces.js.map +1 -0
- package/dist/engine/units.d.ts +4 -0
- package/dist/engine/units.js +31 -0
- package/dist/engine/units.js.map +1 -0
- package/dist/engine/worker-env.d.ts +9 -0
- package/dist/engine/worker-env.js +12 -0
- package/dist/engine/worker-env.js.map +1 -0
- package/dist/library/attach-datasheet.d.ts +20 -0
- package/dist/library/attach-datasheet.js +61 -0
- package/dist/library/attach-datasheet.js.map +1 -0
- package/dist/library/easyeda-footprint.d.ts +41 -0
- package/dist/library/easyeda-footprint.js +255 -0
- package/dist/library/easyeda-footprint.js.map +1 -0
- package/dist/library/easyeda-path.d.ts +13 -0
- package/dist/library/easyeda-path.js +133 -0
- package/dist/library/easyeda-path.js.map +1 -0
- package/dist/library/easyeda-symbol.d.ts +20 -0
- package/dist/library/easyeda-symbol.js +53 -0
- package/dist/library/easyeda-symbol.js.map +1 -0
- package/dist/library/import-lcsc.d.ts +30 -0
- package/dist/library/import-lcsc.js +155 -0
- package/dist/library/import-lcsc.js.map +1 -0
- package/dist/library/lcsc-part.d.ts +40 -0
- package/dist/library/lcsc-part.js +153 -0
- package/dist/library/lcsc-part.js.map +1 -0
- package/dist/library/new-part.d.ts +50 -0
- package/dist/library/new-part.js +160 -0
- package/dist/library/new-part.js.map +1 -0
- package/dist/library/pin-table.d.ts +23 -0
- package/dist/library/pin-table.js +92 -0
- package/dist/library/pin-table.js.map +1 -0
- package/dist/mcp/batch.d.ts +111 -0
- package/dist/mcp/batch.js +241 -0
- package/dist/mcp/batch.js.map +1 -0
- package/dist/mcp/board-summary.d.ts +19 -0
- package/dist/mcp/board-summary.js +144 -0
- package/dist/mcp/board-summary.js.map +1 -0
- package/dist/mcp/compact-sheets.d.ts +31 -0
- package/dist/mcp/compact-sheets.js +63 -0
- package/dist/mcp/compact-sheets.js.map +1 -0
- package/dist/mcp/compact-tool-list.d.ts +8 -0
- package/dist/mcp/compact-tool-list.js +42 -0
- package/dist/mcp/compact-tool-list.js.map +1 -0
- package/dist/mcp/compact.d.ts +33 -0
- package/dist/mcp/compact.js +189 -0
- package/dist/mcp/compact.js.map +1 -0
- package/dist/mcp/copper-summary.d.ts +26 -0
- package/dist/mcp/copper-summary.js +122 -0
- package/dist/mcp/copper-summary.js.map +1 -0
- package/dist/mcp/copper-tools.d.ts +93 -0
- package/dist/mcp/copper-tools.js +228 -0
- package/dist/mcp/copper-tools.js.map +1 -0
- package/dist/mcp/copper-under.d.ts +16 -0
- package/dist/mcp/copper-under.js +46 -0
- package/dist/mcp/copper-under.js.map +1 -0
- package/dist/mcp/create-part.d.ts +71 -0
- package/dist/mcp/create-part.js +31 -0
- package/dist/mcp/create-part.js.map +1 -0
- package/dist/mcp/datasheet-tools.d.ts +14 -0
- package/dist/mcp/datasheet-tools.js +15 -0
- package/dist/mcp/datasheet-tools.js.map +1 -0
- package/dist/mcp/fillet-tools.d.ts +24 -0
- package/dist/mcp/fillet-tools.js +52 -0
- package/dist/mcp/fillet-tools.js.map +1 -0
- package/dist/mcp/guide.d.ts +37 -0
- package/dist/mcp/guide.js +78 -0
- package/dist/mcp/guide.js.map +1 -0
- package/dist/mcp/import-part.d.ts +13 -0
- package/dist/mcp/import-part.js +20 -0
- package/dist/mcp/import-part.js.map +1 -0
- package/dist/mcp/make-sheet.d.ts +18 -0
- package/dist/mcp/make-sheet.js +29 -0
- package/dist/mcp/make-sheet.js.map +1 -0
- package/dist/mcp/new-circuit.d.ts +77 -0
- package/dist/mcp/new-circuit.js +114 -0
- package/dist/mcp/new-circuit.js.map +1 -0
- package/dist/mcp/place-tools.d.ts +46 -0
- package/dist/mcp/place-tools.js +121 -0
- package/dist/mcp/place-tools.js.map +1 -0
- package/dist/mcp/pour-tools.d.ts +126 -0
- package/dist/mcp/pour-tools.js +105 -0
- package/dist/mcp/pour-tools.js.map +1 -0
- package/dist/mcp/project-tools.d.ts +36 -0
- package/dist/mcp/project-tools.js +115 -0
- package/dist/mcp/project-tools.js.map +1 -0
- package/dist/mcp/route-by-ref.d.ts +20 -0
- package/dist/mcp/route-by-ref.js +70 -0
- package/dist/mcp/route-by-ref.js.map +1 -0
- package/dist/mcp/route-tools.d.ts +54 -0
- package/dist/mcp/route-tools.js +173 -0
- package/dist/mcp/route-tools.js.map +1 -0
- package/dist/mcp/server.d.ts +9 -0
- package/dist/mcp/server.js +290 -0
- package/dist/mcp/server.js.map +1 -0
- package/dist/skill-install.d.ts +13 -0
- package/dist/skill-install.js +28 -0
- package/dist/skill-install.js.map +1 -0
- package/dist/studio/fit-board.d.ts +11 -0
- package/dist/studio/fit-board.js +15 -0
- package/dist/studio/fit-board.js.map +1 -0
- package/dist/studio/layout-schema.d.ts +157 -0
- package/dist/studio/layout-schema.js +32 -0
- package/dist/studio/layout-schema.js.map +1 -0
- package/dist/studio/live.d.ts +79 -0
- package/dist/studio/live.js +187 -0
- package/dist/studio/live.js.map +1 -0
- package/dist/studio/place-events.d.ts +60 -0
- package/dist/studio/place-events.js +42 -0
- package/dist/studio/place-events.js.map +1 -0
- package/dist/studio/place-runner.d.ts +62 -0
- package/dist/studio/place-runner.js +205 -0
- package/dist/studio/place-runner.js.map +1 -0
- package/dist/studio/place-worker.d.ts +1 -0
- package/dist/studio/place-worker.js +23 -0
- package/dist/studio/place-worker.js.map +1 -0
- package/dist/studio/route-events.d.ts +64 -0
- package/dist/studio/route-events.js +61 -0
- package/dist/studio/route-events.js.map +1 -0
- package/dist/studio/route-runner.d.ts +90 -0
- package/dist/studio/route-runner.js +272 -0
- package/dist/studio/route-runner.js.map +1 -0
- package/dist/studio/router-worker.d.ts +1 -0
- package/dist/studio/router-worker.js +17 -0
- package/dist/studio/router-worker.js.map +1 -0
- package/dist/studio/server.d.ts +32 -0
- package/dist/studio/server.js +610 -0
- package/dist/studio/server.js.map +1 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +2 -0
- package/dist/version.js.map +1 -0
- package/package.json +64 -4
- package/skills/copperflow/SKILL.md +199 -0
- package/skills/copperflow/references/copper.md +82 -0
- package/skills/copperflow/references/design-rules.md +163 -0
- package/skills/copperflow/references/design-workflow.md +199 -0
- package/skills/copperflow/references/editable-subset.md +83 -0
- package/skills/copperflow/references/parts-library.md +83 -0
- package/skills/copperflow/references/writing-circuits.md +62 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import type { JSXElement } from "@babel/types";
|
|
2
|
+
import { readPointList } from "./literals.js";
|
|
3
|
+
import type { BoardItemInfo, BoardItemTag, Point, PropInfo } from "./types.js";
|
|
4
|
+
export declare const BOARD_ITEM_TAGS: readonly BoardItemTag[];
|
|
5
|
+
/** The copper layers a pour can name. */
|
|
6
|
+
export declare const POUR_LAYERS: readonly ["top", "bottom", "inner1", "inner2"];
|
|
7
|
+
export declare const UNSURE_BOARD_ID = "its id depends on an earlier one the engine may make any number of times; edit it in the code";
|
|
8
|
+
export declare const NOT_AT_TOP = "it is inside a <group>, whose offset moves it; edit it in the code";
|
|
9
|
+
/** A board item's tag as the scan meets it, in source order. */
|
|
10
|
+
export interface BoardItemTagFacts {
|
|
11
|
+
tag: BoardItemTag;
|
|
12
|
+
node: JSXElement;
|
|
13
|
+
props: Record<string, PropInfo>;
|
|
14
|
+
outlineValue: Parameters<typeof readPointList>[0];
|
|
15
|
+
line: number;
|
|
16
|
+
start: number;
|
|
17
|
+
end: number;
|
|
18
|
+
readonlyReason?: string;
|
|
19
|
+
parent?: string;
|
|
20
|
+
uncounted?: string;
|
|
21
|
+
}
|
|
22
|
+
/** The sub-sheet instance a pour's or hole's id names ("PS1" of "PS1/hole:1"); undefined for one of the file itself. */
|
|
23
|
+
export declare function boardItemInstance(id: string): string | undefined;
|
|
24
|
+
/** Whether the id is a hole's, the file's own or an instance's. */
|
|
25
|
+
export declare const isHoleId: (id: string) => boolean;
|
|
26
|
+
/** Why a pour or hole of a sub-sheet instance is not edited here: it is written in its sheet file. */
|
|
27
|
+
export declare function instanceItemRefusal(id: string, instance: string, sheetFile: string | undefined): string;
|
|
28
|
+
export declare const isBoardItemTag: (tag: string) => tag is BoardItemTag;
|
|
29
|
+
/**
|
|
30
|
+
* What is wrong with a pour's outline as a polygon, or undefined when it is a simple one: two corners in a row at one
|
|
31
|
+
* place (the last and the first count as a row), no area (every corner on one line), or two edges that cross.
|
|
32
|
+
*/
|
|
33
|
+
export declare function outlineProblem(points: readonly Point[]): string | undefined;
|
|
34
|
+
/** The id a new pour or hole gets: every tag of its kind is counted, and addPour and addHole put a new one after them all. */
|
|
35
|
+
export declare function newBoardItemId(items: readonly Pick<BoardItemInfo, "tag">[], tag: BoardItemTag): string;
|
|
36
|
+
/** The file's pours and holes with their ids, and the AST node of each by id. */
|
|
37
|
+
export declare function scanBoardItems(tags: readonly BoardItemTagFacts[]): {
|
|
38
|
+
items: BoardItemInfo[];
|
|
39
|
+
nodes: Map<string, JSXElement>;
|
|
40
|
+
};
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
import { readPointList } from "./literals.js";
|
|
2
|
+
export const BOARD_ITEM_TAGS = ["copperpour", "hole"];
|
|
3
|
+
/** The copper layers a pour can name. */
|
|
4
|
+
export const POUR_LAYERS = ["top", "bottom", "inner1", "inner2"];
|
|
5
|
+
export const UNSURE_BOARD_ID = "its id depends on an earlier one the engine may make any number of times; edit it in the code";
|
|
6
|
+
export const NOT_AT_TOP = "it is inside a <group>, whose offset moves it; edit it in the code";
|
|
7
|
+
/** The sub-sheet instance a pour's or hole's id names ("PS1" of "PS1/hole:1"); undefined for one of the file itself. */
|
|
8
|
+
export function boardItemInstance(id) {
|
|
9
|
+
const slash = id.lastIndexOf("/");
|
|
10
|
+
return slash > 0 ? id.slice(0, slash) : undefined;
|
|
11
|
+
}
|
|
12
|
+
/** Whether the id is a hole's, the file's own or an instance's. */
|
|
13
|
+
export const isHoleId = (id) => /(^|\/)hole:\d+$/.test(id);
|
|
14
|
+
/** Why a pour or hole of a sub-sheet instance is not edited here: it is written in its sheet file. */
|
|
15
|
+
export function instanceItemRefusal(id, instance, sheetFile) {
|
|
16
|
+
const word = isHoleId(id) ? "hole" : "copper pour";
|
|
17
|
+
return `${id} is a ${word} inside the sub-sheet instance ${instance}; edit ${sheetFile ?? "its sheet file"} instead`;
|
|
18
|
+
}
|
|
19
|
+
export const isBoardItemTag = (tag) => BOARD_ITEM_TAGS.includes(tag);
|
|
20
|
+
function info(facts, id, outline, reason) {
|
|
21
|
+
const props = { ...facts.props };
|
|
22
|
+
if (outline && props["outline"])
|
|
23
|
+
props["outline"] = { ...props["outline"], editable: true };
|
|
24
|
+
return {
|
|
25
|
+
id,
|
|
26
|
+
tag: facts.tag,
|
|
27
|
+
props,
|
|
28
|
+
...(outline ? { outline } : {}),
|
|
29
|
+
...(facts.parent === undefined ? {} : { parent: facts.parent }),
|
|
30
|
+
line: facts.line,
|
|
31
|
+
editable: reason === undefined,
|
|
32
|
+
...(reason ? { readonlyReason: reason } : {}),
|
|
33
|
+
start: facts.start,
|
|
34
|
+
end: facts.end,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
const same = (a, b) => a.x === b.x && a.y === b.y;
|
|
38
|
+
/** Which side of the line a→b the point c lies on: positive left, negative right, zero on it. */
|
|
39
|
+
const side = (a, b, c) => (b.x - a.x) * (c.y - a.y) - (b.y - a.y) * (c.x - a.x);
|
|
40
|
+
/** Whether the segments a–b and c–d cross or touch (collinear overlaps included). */
|
|
41
|
+
function segmentsMeet(a, b, c, d) {
|
|
42
|
+
const [d1, d2, d3, d4] = [side(c, d, a), side(c, d, b), side(a, b, c), side(a, b, d)];
|
|
43
|
+
if (((d1 > 0 && d2 < 0) || (d1 < 0 && d2 > 0)) && ((d3 > 0 && d4 < 0) || (d3 < 0 && d4 > 0)))
|
|
44
|
+
return true;
|
|
45
|
+
const within = (p, q, r) => Math.min(p.x, q.x) <= r.x && r.x <= Math.max(p.x, q.x) && Math.min(p.y, q.y) <= r.y && r.y <= Math.max(p.y, q.y);
|
|
46
|
+
return (d1 === 0 && within(c, d, a)) || (d2 === 0 && within(c, d, b)) || (d3 === 0 && within(a, b, c)) || (d4 === 0 && within(a, b, d));
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* What is wrong with a pour's outline as a polygon, or undefined when it is a simple one: two corners in a row at one
|
|
50
|
+
* place (the last and the first count as a row), no area (every corner on one line), or two edges that cross.
|
|
51
|
+
*/
|
|
52
|
+
export function outlineProblem(points) {
|
|
53
|
+
const n = points.length;
|
|
54
|
+
if (n < 3)
|
|
55
|
+
return "an outline needs at least 3 corners";
|
|
56
|
+
if (points.some((p, i) => same(p, points[(i + 1) % n])))
|
|
57
|
+
return "two corners in a row are at the same place";
|
|
58
|
+
for (let i = 0; i < n; i++) {
|
|
59
|
+
for (let j = i + 1; j < n; j++) {
|
|
60
|
+
// Edges that share a corner always meet there; only the others may not meet at all.
|
|
61
|
+
if (j === i + 1 || (i === 0 && j === n - 1))
|
|
62
|
+
continue;
|
|
63
|
+
const [a, b, c, d] = [points[i], points[(i + 1) % n], points[j], points[(j + 1) % n]];
|
|
64
|
+
if (segmentsMeet(a, b, c, d))
|
|
65
|
+
return "two of its edges cross";
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
const area = points.reduce((sum, a, i) => sum + side({ x: 0, y: 0 }, a, points[(i + 1) % n]), 0);
|
|
69
|
+
return Math.abs(area) < 1e-9 ? "its corners are all on one line, so it has no area" : undefined;
|
|
70
|
+
}
|
|
71
|
+
/** The id a new pour or hole gets: every tag of its kind is counted, and addPour and addHole put a new one after them all. */
|
|
72
|
+
export function newBoardItemId(items, tag) {
|
|
73
|
+
return `${tag}:${items.filter((item) => item.tag === tag).length + 1}`;
|
|
74
|
+
}
|
|
75
|
+
/** The file's pours and holes with their ids, and the AST node of each by id. */
|
|
76
|
+
export function scanBoardItems(tags) {
|
|
77
|
+
const counts = new Map();
|
|
78
|
+
const unsure = new Set();
|
|
79
|
+
const items = [];
|
|
80
|
+
const nodes = new Map();
|
|
81
|
+
for (const facts of tags) {
|
|
82
|
+
const outline = facts.tag === "copperpour" ? readPointList(facts.outlineValue) : undefined;
|
|
83
|
+
const index = (counts.get(facts.tag) ?? 0) + 1;
|
|
84
|
+
counts.set(facts.tag, index);
|
|
85
|
+
const id = `${facts.tag}:${index}`;
|
|
86
|
+
const atTop = facts.parent === "board" || facts.parent === "sheet";
|
|
87
|
+
const reason = facts.readonlyReason ?? facts.uncounted ?? (unsure.has(facts.tag) ? UNSURE_BOARD_ID : atTop ? undefined : NOT_AT_TOP);
|
|
88
|
+
if (facts.uncounted)
|
|
89
|
+
unsure.add(facts.tag);
|
|
90
|
+
items.push(info(facts, id, outline, reason));
|
|
91
|
+
nodes.set(id, facts.node);
|
|
92
|
+
}
|
|
93
|
+
return { items, nodes };
|
|
94
|
+
}
|
|
95
|
+
//# sourceMappingURL=board-items.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"board-items.js","sourceRoot":"","sources":["../../src/core/board-items.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAG7C,MAAM,CAAC,MAAM,eAAe,GAA4B,CAAC,YAAY,EAAE,MAAM,CAAC,CAAA;AAE9E,yCAAyC;AACzC,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAA;AAEzE,MAAM,CAAC,MAAM,eAAe,GAAG,+FAA+F,CAAA;AAC9H,MAAM,CAAC,MAAM,UAAU,GAAG,oEAAoE,CAAA;AAgB9F,wHAAwH;AACxH,MAAM,UAAU,iBAAiB,CAAC,EAAU;IAC1C,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;IACjC,OAAO,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AACnD,CAAC;AAED,mEAAmE;AACnE,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,EAAU,EAAW,EAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAE3E,sGAAsG;AACtG,MAAM,UAAU,mBAAmB,CAAC,EAAU,EAAE,QAAgB,EAAE,SAA6B;IAC7F,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAA;IAClD,OAAO,GAAG,EAAE,SAAS,IAAI,kCAAkC,QAAQ,UAAU,SAAS,IAAI,gBAAgB,UAAU,CAAA;AACtH,CAAC;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,GAAW,EAAuB,EAAE,CAAE,eAAqC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;AAExH,SAAS,IAAI,CAAC,KAAwB,EAAE,EAAU,EAAE,OAA4B,EAAE,MAA0B;IAC1G,MAAM,KAAK,GAAG,EAAE,GAAG,KAAK,CAAC,KAAK,EAAE,CAAA;IAChC,IAAI,OAAO,IAAI,KAAK,CAAC,SAAS,CAAC;QAAE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;IAC3F,OAAO;QACL,EAAE;QACF,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,KAAK;QACL,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/B,GAAG,CAAC,KAAK,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC;QAC/D,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,QAAQ,EAAE,MAAM,KAAK,SAAS;QAC9B,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,GAAG,EAAE,KAAK,CAAC,GAAG;KACf,CAAA;AACH,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,CAAQ,EAAE,CAAQ,EAAW,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;AAExE,iGAAiG;AACjG,MAAM,IAAI,GAAG,CAAC,CAAQ,EAAE,CAAQ,EAAE,CAAQ,EAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;AAE5G,qFAAqF;AACrF,SAAS,YAAY,CAAC,CAAQ,EAAE,CAAQ,EAAE,CAAQ,EAAE,CAAQ;IAC1D,MAAM,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IACrF,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;QAAE,OAAO,IAAI,CAAA;IACzG,MAAM,MAAM,GAAG,CAAC,CAAQ,EAAE,CAAQ,EAAE,CAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;IACjK,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;AACzI,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,MAAwB;IACrD,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAAA;IACvB,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,qCAAqC,CAAA;IACvD,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAU,CAAC,CAAC;QAAE,OAAO,4CAA4C,CAAA;IACrH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,oFAAoF;YACpF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAAE,SAAQ;YACrD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAY,CAAA;YAChG,IAAI,YAAY,CAAC,CAAU,EAAE,CAAU,EAAE,CAAU,EAAE,CAAU,CAAC;gBAAE,OAAO,wBAAwB,CAAA;QACnG,CAAC;IACH,CAAC;IACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAU,CAAC,EAAE,CAAC,CAAC,CAAA;IACzG,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,oDAAoD,CAAC,CAAC,CAAC,SAAS,CAAA;AACjG,CAAC;AAED,8HAA8H;AAC9H,MAAM,UAAU,cAAc,CAAC,KAA4C,EAAE,GAAiB;IAC5F,OAAO,GAAG,GAAG,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAA;AACxE,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,cAAc,CAAC,IAAkC;IAC/D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAwB,CAAA;IAC9C,MAAM,MAAM,GAAG,IAAI,GAAG,EAAgB,CAAA;IACtC,MAAM,KAAK,GAAoB,EAAE,CAAA;IACjC,MAAM,KAAK,GAAG,IAAI,GAAG,EAAsB,CAAA;IAC3C,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,KAAK,CAAC,GAAG,KAAK,YAAY,CAAC,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC1F,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAA;QAC9C,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC5B,MAAM,EAAE,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,KAAK,EAAE,CAAA;QAClC,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,OAAO,IAAI,KAAK,CAAC,MAAM,KAAK,OAAO,CAAA;QAClE,MAAM,MAAM,GAAG,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,SAAS,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAA;QACpI,IAAI,KAAK,CAAC,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAC1C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAA;QAC5C,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAA;AACzB,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { Design } from "../engine/design.js";
|
|
2
|
+
import { type DesignSource } from "./design-source.js";
|
|
3
|
+
export interface BomLine {
|
|
4
|
+
designators: string[];
|
|
5
|
+
quantity: number;
|
|
6
|
+
kind: string;
|
|
7
|
+
value: string;
|
|
8
|
+
footprint: string;
|
|
9
|
+
manufacturer: string;
|
|
10
|
+
mpn: string;
|
|
11
|
+
/** e.g. "jlcpcb C25905" */
|
|
12
|
+
supplier: string;
|
|
13
|
+
datasheet: string;
|
|
14
|
+
libraryPart?: string;
|
|
15
|
+
/** True when a person verified the library part and this instance keeps its footprint, MPN and supplier numbers. */
|
|
16
|
+
verified?: boolean;
|
|
17
|
+
}
|
|
18
|
+
export type { DesignSource } from "./design-source.js";
|
|
19
|
+
export interface BomOptions {
|
|
20
|
+
/** A design that is already built; no engine is used. */
|
|
21
|
+
design?: Design;
|
|
22
|
+
/** Builds the design when none is given. Without one, a new engine is started and stopped afterwards. */
|
|
23
|
+
engine?: DesignSource;
|
|
24
|
+
}
|
|
25
|
+
/** Builds a BOM from the design of a circuit file and the parts library. */
|
|
26
|
+
export declare function buildBom(root: string, file: string, options?: BomOptions): Promise<BomLine[]>;
|
|
27
|
+
export declare function formatBomCsv(lines: BomLine[]): string;
|
|
28
|
+
export declare function formatBomMarkdown(lines: BomLine[]): string;
|
|
29
|
+
/** Writes BOM.csv, BOM.md, README.md and copies of local datasheets into a folder in the project. */
|
|
30
|
+
export declare function exportPackage(root: string, file: string, options?: BomOptions & {
|
|
31
|
+
outDir?: string;
|
|
32
|
+
}): Promise<{
|
|
33
|
+
outDir: string;
|
|
34
|
+
files: string[];
|
|
35
|
+
}>;
|
package/dist/core/bom.js
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { copyFile, mkdir, rm, stat, writeFile } from "node:fs/promises";
|
|
2
|
+
import { join } from "node:path";
|
|
3
|
+
import { csvCell } from "../engine/fab/csv.js";
|
|
4
|
+
import { buildWith } from "./design-source.js";
|
|
5
|
+
import { isPartVerified, libraryValues, PARTS_DIR, readPart } from "./library.js";
|
|
6
|
+
import { resolveCircuit, resolveInRoot } from "./workspace.js";
|
|
7
|
+
const VALUE_PROPS = ["resistance", "capacitance", "inductance", "frequency", "color", "voltage", "maxResistance", "standard"];
|
|
8
|
+
const COLUMNS = ["Designators", "Quantity", "Kind", "Value", "Footprint", "Manufacturer", "MPN", "Supplier part", "Datasheet"];
|
|
9
|
+
/** Props that name or place a part, or hold its children; they never keep two parts on separate lines. */
|
|
10
|
+
const NON_IDENTITY_PROPS = new Set(["name", "key", "children"]);
|
|
11
|
+
/** The given design, or one built by the given engine, or by a new engine that is stopped afterwards. */
|
|
12
|
+
async function designFor(root, file, options) {
|
|
13
|
+
return options.design ?? buildWith(root, file, options.engine);
|
|
14
|
+
}
|
|
15
|
+
/** Builds a BOM from the design of a circuit file and the parts library. */
|
|
16
|
+
export async function buildBom(root, file, options = {}) {
|
|
17
|
+
const { file: circuitFile } = await resolveCircuit(root, file);
|
|
18
|
+
return bomFromDesign(root, await designFor(root, circuitFile, options));
|
|
19
|
+
}
|
|
20
|
+
async function bomFromDesign(root, design) {
|
|
21
|
+
const library = await readLibraryParts(root, design);
|
|
22
|
+
const groups = new Map();
|
|
23
|
+
for (const component of design.circuit.components) {
|
|
24
|
+
const entry = component.library ? library.get(component.library) : undefined;
|
|
25
|
+
const line = componentLine(component, entry);
|
|
26
|
+
const key = JSON.stringify([component.kind, component.library ?? "", line.value, line.footprint, line.mpn, line.supplier, line.verified ?? "", identityProps(component)]);
|
|
27
|
+
const existing = groups.get(key);
|
|
28
|
+
groups.set(key, existing ? { ...existing, designators: [...existing.designators, component.id], quantity: existing.quantity + 1 } : line);
|
|
29
|
+
}
|
|
30
|
+
const natural = (a, b) => a.localeCompare(b, "en", { numeric: true });
|
|
31
|
+
return [...groups.values()]
|
|
32
|
+
.map((line) => ({ ...line, designators: [...line.designators].sort(natural) }))
|
|
33
|
+
.sort((a, b) => natural(a.designators[0] ?? "", b.designators[0] ?? ""));
|
|
34
|
+
}
|
|
35
|
+
async function readLibraryParts(root, design) {
|
|
36
|
+
const entries = new Map();
|
|
37
|
+
for (const id of new Set(design.circuit.components.flatMap((c) => (c.library ? [c.library] : [])))) {
|
|
38
|
+
const part = await readPart(root, id);
|
|
39
|
+
entries.set(id, { part, verified: await isPartVerified(root, id, part) });
|
|
40
|
+
}
|
|
41
|
+
return entries;
|
|
42
|
+
}
|
|
43
|
+
/** Every prop except names, positions and children, as JSON with sorted keys, so ratings and tolerances keep lines apart. */
|
|
44
|
+
function identityProps(component) {
|
|
45
|
+
const entries = Object.entries(component.props)
|
|
46
|
+
.filter(([key]) => !NON_IDENTITY_PROPS.has(key) && !key.startsWith("pcb") && !key.startsWith("sch"))
|
|
47
|
+
.sort(([a], [b]) => (a < b ? -1 : 1));
|
|
48
|
+
return JSON.stringify(entries);
|
|
49
|
+
}
|
|
50
|
+
function componentLine(component, entry) {
|
|
51
|
+
const part = entry?.part;
|
|
52
|
+
const [supplier, numbers] = Object.entries(component.supplierPartNumbers).find(([, list]) => list.length > 0) ?? [];
|
|
53
|
+
const [libSupplier, libNumber] = Object.entries(part?.suppliers ?? {})[0] ?? [];
|
|
54
|
+
return {
|
|
55
|
+
designators: [component.id],
|
|
56
|
+
quantity: 1,
|
|
57
|
+
kind: component.kind,
|
|
58
|
+
value: part?.title ?? component.value ?? propValue(component),
|
|
59
|
+
footprint: component.footprint ?? part?.footprint ?? "",
|
|
60
|
+
manufacturer: part?.manufacturer ?? "",
|
|
61
|
+
mpn: component.mpn ?? part?.mpn ?? "",
|
|
62
|
+
supplier: supplier && numbers?.[0] ? `${supplier} ${numbers[0]}` : libSupplier ? `${libSupplier} ${libNumber}` : "",
|
|
63
|
+
datasheet: part?.datasheet?.url ?? part?.datasheet?.file ?? "",
|
|
64
|
+
...(component.library && entry ? { libraryPart: component.library, verified: entry.verified && keepsLibraryValues(component, component.library, entry.part) } : {}),
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Whether an instance builds with the footprint, MPN and supplier numbers its library part sets. A
|
|
69
|
+
* circuit can override them on the instance; the part a person verified is then not what is built.
|
|
70
|
+
*/
|
|
71
|
+
function keepsLibraryValues(component, id, part) {
|
|
72
|
+
const expected = libraryValues(id, part);
|
|
73
|
+
const sorted = (numbers) => JSON.stringify(Object.entries(numbers).sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0)));
|
|
74
|
+
return (component.footprint === expected.footprint &&
|
|
75
|
+
component.mpn === expected.mpn &&
|
|
76
|
+
sorted(component.supplierPartNumbers) === sorted(expected.supplierPartNumbers));
|
|
77
|
+
}
|
|
78
|
+
/** The first of the props that give a part its value, e.g. an LED's color. */
|
|
79
|
+
function propValue(component) {
|
|
80
|
+
for (const key of VALUE_PROPS) {
|
|
81
|
+
const value = component.props[key];
|
|
82
|
+
if (typeof value === "string" || typeof value === "number")
|
|
83
|
+
return String(value);
|
|
84
|
+
}
|
|
85
|
+
return "";
|
|
86
|
+
}
|
|
87
|
+
export function formatBomCsv(lines) {
|
|
88
|
+
const rows = lines.map((l) => [l.designators.join(" "), l.quantity, l.kind, l.value, l.footprint, l.manufacturer, l.mpn, l.supplier, l.datasheet]);
|
|
89
|
+
return [COLUMNS, ...rows].map((row) => row.map(csvCell).join(",")).join("\n") + "\n";
|
|
90
|
+
}
|
|
91
|
+
export function formatBomMarkdown(lines) {
|
|
92
|
+
const cell = (value) => String(value).replace(/\|/g, "\\|").replace(/\s*\n\s*/g, " ");
|
|
93
|
+
const rows = lines.map((l) => [l.designators.join(" "), l.quantity, l.kind, l.value, l.footprint, l.manufacturer, l.mpn, l.supplier, l.datasheet]);
|
|
94
|
+
return [
|
|
95
|
+
`| ${COLUMNS.join(" | ")} |`,
|
|
96
|
+
`| ${COLUMNS.map(() => "---").join(" | ")} |`,
|
|
97
|
+
...rows.map((row) => `| ${row.map(cell).join(" | ")} |`),
|
|
98
|
+
"",
|
|
99
|
+
].join("\n");
|
|
100
|
+
}
|
|
101
|
+
/** Percent-encodes characters that would end a Markdown link or table cell, or start HTML. */
|
|
102
|
+
function markdownUrl(url) {
|
|
103
|
+
return url.replace(/[()[\]|<>\s]/g, (c) => `%${c.charCodeAt(0).toString(16).toUpperCase().padStart(2, "0")}`);
|
|
104
|
+
}
|
|
105
|
+
/** Writes BOM.csv, BOM.md, README.md and copies of local datasheets into a folder in the project. */
|
|
106
|
+
export async function exportPackage(root, file, options = {}) {
|
|
107
|
+
const { file: circuitFile } = await resolveCircuit(root, file);
|
|
108
|
+
// The circuit's own path, so boards/a/main and boards/b/main do not share a folder.
|
|
109
|
+
const outDir = (options.outDir ?? `exports/${circuitFile.replace(/\.circuit\.tsx$/, "")}`).split("\\").join("/");
|
|
110
|
+
const outPath = resolveInRoot(root, outDir);
|
|
111
|
+
const lines = await bomFromDesign(root, await designFor(root, circuitFile, options));
|
|
112
|
+
await rm(join(outPath, "datasheets"), { recursive: true, force: true });
|
|
113
|
+
await mkdir(join(outPath, "datasheets"), { recursive: true });
|
|
114
|
+
const files = [];
|
|
115
|
+
const write = async (name, text) => {
|
|
116
|
+
await writeFile(join(outPath, name), text);
|
|
117
|
+
files.push(`${outDir}/${name}`);
|
|
118
|
+
};
|
|
119
|
+
await write("BOM.csv", formatBomCsv(lines));
|
|
120
|
+
await write("BOM.md", formatBomMarkdown(lines));
|
|
121
|
+
const rows = [];
|
|
122
|
+
for (const line of lines.filter((l) => l.libraryPart)) {
|
|
123
|
+
const id = line.libraryPart;
|
|
124
|
+
const library = await readPart(root, id);
|
|
125
|
+
let link = library.datasheet?.url ? `[datasheet](${markdownUrl(library.datasheet.url)})` : "none";
|
|
126
|
+
const local = library.datasheet?.file ? join(root, PARTS_DIR, id, library.datasheet.file) : undefined;
|
|
127
|
+
if (local && (await stat(local).catch(() => undefined))?.isFile()) {
|
|
128
|
+
await copyFile(local, join(outPath, "datasheets", `${id}.pdf`));
|
|
129
|
+
files.push(`${outDir}/datasheets/${id}.pdf`);
|
|
130
|
+
link = `[datasheet](datasheets/${id}.pdf)`;
|
|
131
|
+
}
|
|
132
|
+
rows.push(`| ${line.designators.join(" ")} | ${library.title.replace(/\|/g, "\\|")} | ${line.verified ? "verified" : "not verified"} | ${link} |`);
|
|
133
|
+
}
|
|
134
|
+
await write("README.md", [
|
|
135
|
+
`# ${circuitFile}`,
|
|
136
|
+
"",
|
|
137
|
+
"Library parts, their verification status and datasheets. Every part is in BOM.csv.",
|
|
138
|
+
"",
|
|
139
|
+
"| Designators | Part | Status | Datasheet |",
|
|
140
|
+
"| --- | --- | --- | --- |",
|
|
141
|
+
...rows,
|
|
142
|
+
"",
|
|
143
|
+
].join("\n"));
|
|
144
|
+
return { outDir, files };
|
|
145
|
+
}
|
|
146
|
+
//# sourceMappingURL=bom.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"bom.js","sourceRoot":"","sources":["../../src/core/bom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AACvE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AAE9C,OAAO,EAAE,SAAS,EAAqB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,QAAQ,EAAa,MAAM,cAAc,CAAA;AAC5F,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAkB9D,MAAM,WAAW,GAAG,CAAC,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,UAAU,CAAC,CAAA;AAC7H,MAAM,OAAO,GAAG,CAAC,aAAa,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,KAAK,EAAE,eAAe,EAAE,WAAW,CAAC,CAAA;AAC9H,0GAA0G;AAC1G,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAA;AAW/D,yGAAyG;AACzG,KAAK,UAAU,SAAS,CAAC,IAAY,EAAE,IAAY,EAAE,OAAmB;IACtE,OAAO,OAAO,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;AAChE,CAAC;AAED,4EAA4E;AAC5E,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY,EAAE,IAAY,EAAE,OAAO,GAAe,EAAE;IACjF,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC9D,OAAO,aAAa,CAAC,IAAI,EAAE,MAAM,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;AACzE,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,MAAc;IACvD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IACpD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAmB,CAAA;IACzC,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5E,MAAM,IAAI,GAAG,aAAa,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QAC5C,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,IAAI,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAA;QACzK,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAChC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,WAAW,EAAE,CAAC,GAAG,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;IAC3I,CAAC;IACD,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IACrF,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;SACxB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAC9E,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAC5E,CAAC;AAOD,KAAK,UAAU,gBAAgB,CAAC,IAAY,EAAE,MAAc;IAC1D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAwB,CAAA;IAC/C,KAAK,MAAM,EAAE,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnG,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACrC,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC3E,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,6HAA6H;AAC7H,SAAS,aAAa,CAAC,SAAoB;IACzC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC;SAC5C,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SACnG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACvC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;AAChC,CAAC;AAED,SAAS,aAAa,CAAC,SAAoB,EAAE,KAA+B;IAC1E,MAAM,IAAI,GAAG,KAAK,EAAE,IAAI,CAAA;IACxB,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;IACnH,MAAM,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC/E,OAAO;QACL,WAAW,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3B,QAAQ,EAAE,CAAC;QACX,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,KAAK,EAAE,IAAI,EAAE,KAAK,IAAI,SAAS,CAAC,KAAK,IAAI,SAAS,CAAC,SAAS,CAAC;QAC7D,SAAS,EAAE,SAAS,CAAC,SAAS,IAAI,IAAI,EAAE,SAAS,IAAI,EAAE;QACvD,YAAY,EAAE,IAAI,EAAE,YAAY,IAAI,EAAE;QACtC,GAAG,EAAE,SAAS,CAAC,GAAG,IAAI,IAAI,EAAE,GAAG,IAAI,EAAE;QACrC,QAAQ,EAAE,QAAQ,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,SAAS,EAAE,CAAC,CAAC,CAAC,EAAE;QACnH,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,IAAI,IAAI,EAAE,SAAS,EAAE,IAAI,IAAI,EAAE;QAC9D,GAAG,CAAC,SAAS,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,IAAI,kBAAkB,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACpK,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CAAC,SAAoB,EAAE,EAAU,EAAE,IAAU;IACtE,MAAM,QAAQ,GAAG,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;IACxC,MAAM,MAAM,GAAG,CAAC,OAAiC,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAC9I,OAAO,CACL,SAAS,CAAC,SAAS,KAAK,QAAQ,CAAC,SAAS;QAC1C,SAAS,CAAC,GAAG,KAAK,QAAQ,CAAC,GAAG;QAC9B,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,KAAK,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAC/E,CAAA;AACH,CAAC;AAED,8EAA8E;AAC9E,SAAS,SAAS,CAAC,SAAoB;IACrC,KAAK,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QAC9B,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,KAAK,CAAC,CAAA;IAClF,CAAC;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAgB;IAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;IAClJ,OAAO,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;AACtF,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAgB;IAChD,MAAM,IAAI,GAAG,CAAC,KAAsB,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAA;IACtG,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,CAAC,YAAY,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;IAClJ,OAAO;QACL,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;QAC5B,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;QAC7C,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QACxD,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACd,CAAC;AAED,8FAA8F;AAC9F,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAA;AAC/G,CAAC;AAED,qGAAqG;AACrG,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,IAAY,EACZ,IAAY,EACZ,OAAO,GAAqC,EAAE;IAE9C,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC9D,oFAAoF;IACpF,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,WAAW,WAAW,CAAC,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAChH,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC3C,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,IAAI,EAAE,MAAM,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;IACpF,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACvE,MAAM,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC7D,MAAM,KAAK,GAAa,EAAE,CAAA;IAC1B,MAAM,KAAK,GAAG,KAAK,EAAE,IAAY,EAAE,IAAY,EAAE,EAAE;QACjD,MAAM,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,CAAA;QAC1C,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,IAAI,IAAI,EAAE,CAAC,CAAA;IACjC,CAAC,CAAA;IACD,MAAM,KAAK,CAAC,SAAS,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAA;IAC3C,MAAM,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAA;IAE/C,MAAM,IAAI,GAAa,EAAE,CAAA;IACzB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;QACtD,MAAM,EAAE,GAAG,IAAI,CAAC,WAAqB,CAAA;QACrC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;QACxC,IAAI,IAAI,GAAG,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,eAAe,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAA;QACjG,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACrG,IAAI,KAAK,IAAI,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;YAClE,MAAM,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA;YAC/D,KAAK,CAAC,IAAI,CAAC,GAAG,MAAM,eAAe,EAAE,MAAM,CAAC,CAAA;YAC5C,IAAI,GAAG,0BAA0B,EAAE,OAAO,CAAA;QAC5C,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,cAAc,MAAM,IAAI,IAAI,CAAC,CAAA;IACpJ,CAAC;IACD,MAAM,KAAK,CACT,WAAW,EACX;QACE,KAAK,WAAW,EAAE;QAClB,EAAE;QACF,oFAAoF;QACpF,EAAE;QACF,6CAA6C;QAC7C,2BAA2B;QAC3B,GAAG,IAAI;QACP,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAA;IACD,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AAC1B,CAAC"}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { Design } from "../engine/design.js";
|
|
2
|
+
import type { Diagnostic, SheetInstance } from "../engine/model.js";
|
|
3
|
+
import type { Violation } from "../engine/index.js";
|
|
4
|
+
import { type DesignSource } from "./design-source.js";
|
|
5
|
+
export interface IssueGroup {
|
|
6
|
+
type: string;
|
|
7
|
+
count: number;
|
|
8
|
+
/** The first few messages of this type, each with its position. */
|
|
9
|
+
messages: string[];
|
|
10
|
+
}
|
|
11
|
+
export interface CheckResult {
|
|
12
|
+
ok: boolean;
|
|
13
|
+
errors: IssueGroup[];
|
|
14
|
+
warnings: IssueGroup[];
|
|
15
|
+
violations: Violation[];
|
|
16
|
+
diagnostics: Diagnostic[];
|
|
17
|
+
/** The circuit's sub-sheet instances, so findings can be told by instance. */
|
|
18
|
+
instances?: SheetInstance[];
|
|
19
|
+
/** The flattened designators and net names, so a filter that names none of them can be refused. */
|
|
20
|
+
names?: string[];
|
|
21
|
+
/** Each connection not routed yet, with its pads' positions: "C3.pin2 (12.30, 4.50 top) to U2.pin2 (15.10, 6.00 top)". */
|
|
22
|
+
unrouted?: string[];
|
|
23
|
+
}
|
|
24
|
+
export interface CheckOptions {
|
|
25
|
+
/** Builds the design whose findings the check reports; without one, a new engine is started and stopped. */
|
|
26
|
+
engine?: DesignSource;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Checks a circuit with copperflow's own rules. The engine builds the design the Studio, the BOM and
|
|
30
|
+
* the package use; its rule violations (ERC and placement DRC) and its diagnostics about the code and
|
|
31
|
+
* the model are grouped by code. Any error fails the check. Circuit code the engine cannot run is
|
|
32
|
+
* thrown as file:line:column.
|
|
33
|
+
*/
|
|
34
|
+
export declare function checkCircuit(root: string, file: string, options?: CheckOptions): Promise<CheckResult>;
|
|
35
|
+
/** The check of a design that is already built, as checkCircuit reports it. */
|
|
36
|
+
export declare function checkDesign(design: Design): CheckResult;
|
|
37
|
+
/** How many errors and warnings a check found, each group's findings added up. */
|
|
38
|
+
export declare function checkCounts(result: Pick<CheckResult, "errors" | "warnings">): {
|
|
39
|
+
errors: number;
|
|
40
|
+
warnings: number;
|
|
41
|
+
};
|
|
42
|
+
export declare function formatCheck(file: string, result: CheckResult): string;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { unroutedPlaces } from "../engine/pad-text.js";
|
|
2
|
+
import { buildWith } from "./design-source.js";
|
|
3
|
+
import { oneLine } from "./summary.js";
|
|
4
|
+
import { resolveCircuit } from "./workspace.js";
|
|
5
|
+
const MESSAGES_PER_GROUP = 3;
|
|
6
|
+
const MAX_TEXT = 300;
|
|
7
|
+
/**
|
|
8
|
+
* Checks a circuit with copperflow's own rules. The engine builds the design the Studio, the BOM and
|
|
9
|
+
* the package use; its rule violations (ERC and placement DRC) and its diagnostics about the code and
|
|
10
|
+
* the model are grouped by code. Any error fails the check. Circuit code the engine cannot run is
|
|
11
|
+
* thrown as file:line:column.
|
|
12
|
+
*/
|
|
13
|
+
export async function checkCircuit(root, file, options = {}) {
|
|
14
|
+
const circuit = await resolveCircuit(root, file);
|
|
15
|
+
return checkDesign(await buildWith(root, circuit.file, options.engine));
|
|
16
|
+
}
|
|
17
|
+
/** The check of a design that is already built, as checkCircuit reports it. */
|
|
18
|
+
export function checkDesign(design) {
|
|
19
|
+
const issues = [...design.violations.map(fromViolation), ...design.diagnostics.map(fromDiagnostic)];
|
|
20
|
+
const errors = groupIssues(issues, "error");
|
|
21
|
+
return {
|
|
22
|
+
ok: errors.length === 0,
|
|
23
|
+
errors,
|
|
24
|
+
warnings: groupIssues(issues, "warning"),
|
|
25
|
+
violations: [...design.violations],
|
|
26
|
+
diagnostics: [...design.diagnostics],
|
|
27
|
+
instances: [...(design.circuit?.instances ?? [])],
|
|
28
|
+
names: [...(design.circuit?.components ?? []).map((c) => c.id), ...(design.circuit?.nets ?? []).flatMap((n) => n.names)],
|
|
29
|
+
unrouted: design.pcb === undefined ? [] : unroutedPlaces(design.pcb),
|
|
30
|
+
};
|
|
31
|
+
}
|
|
32
|
+
/** How many errors and warnings a check found, each group's findings added up. */
|
|
33
|
+
export function checkCounts(result) {
|
|
34
|
+
const total = (groups) => groups.reduce((sum, g) => sum + g.count, 0);
|
|
35
|
+
return { errors: total(result.errors), warnings: total(result.warnings) };
|
|
36
|
+
}
|
|
37
|
+
export function formatCheck(file, result) {
|
|
38
|
+
const total = (groups) => groups.reduce((sum, g) => sum + g.count, 0);
|
|
39
|
+
const plural = (n, word) => `${n} ${word}${n === 1 ? "" : "s"}`;
|
|
40
|
+
const lines = [
|
|
41
|
+
`${file}: check ${result.ok ? "passed" : "failed"}, ${plural(total(result.errors), "error")}, ${plural(total(result.warnings), "warning")}`,
|
|
42
|
+
];
|
|
43
|
+
for (const [title, groups] of [
|
|
44
|
+
["Errors:", result.errors],
|
|
45
|
+
["Warnings:", result.warnings],
|
|
46
|
+
]) {
|
|
47
|
+
if (groups.length === 0)
|
|
48
|
+
continue;
|
|
49
|
+
lines.push(title);
|
|
50
|
+
for (const group of groups)
|
|
51
|
+
lines.push(...formatGroup(group));
|
|
52
|
+
}
|
|
53
|
+
return lines.join("\n");
|
|
54
|
+
}
|
|
55
|
+
function formatGroup(group) {
|
|
56
|
+
const hidden = group.count - group.messages.length;
|
|
57
|
+
return [
|
|
58
|
+
` ${group.type}${group.count > 1 ? ` (${group.count})` : ""}:`,
|
|
59
|
+
...group.messages.map((message) => ` ${message}`),
|
|
60
|
+
...(hidden > 0 ? [` … and ${hidden} more`] : []),
|
|
61
|
+
];
|
|
62
|
+
}
|
|
63
|
+
/** The message is clipped, then its position added, so a long message never loses where it is. */
|
|
64
|
+
function fromViolation(v) {
|
|
65
|
+
return { severity: v.severity, code: v.code, text: `${clip(v.message)}${violationPlace(v)}` };
|
|
66
|
+
}
|
|
67
|
+
function violationPlace(v) {
|
|
68
|
+
if (v.view === "schematic")
|
|
69
|
+
return " at the schematic";
|
|
70
|
+
return v.at ? ` at ${v.at.x.toFixed(2)}, ${v.at.y.toFixed(2)} mm` : "";
|
|
71
|
+
}
|
|
72
|
+
function fromDiagnostic(d) {
|
|
73
|
+
const place = d.source ? ` at ${d.source.file}:${d.source.line}:${d.source.column}` : "";
|
|
74
|
+
return { severity: d.severity, code: d.code, text: `${clip(d.message)}${oneLine(place)}` };
|
|
75
|
+
}
|
|
76
|
+
/** Issues of one severity grouped by code in the order codes first appear, each with a count and its first few messages. */
|
|
77
|
+
function groupIssues(issues, severity) {
|
|
78
|
+
const groups = new Map();
|
|
79
|
+
for (const issue of issues.filter((i) => i.severity === severity)) {
|
|
80
|
+
const type = clip(issue.code);
|
|
81
|
+
const previous = groups.get(type) ?? { type, count: 0, messages: [] };
|
|
82
|
+
const messages = previous.messages.length < MESSAGES_PER_GROUP ? [...previous.messages, issue.text] : previous.messages;
|
|
83
|
+
groups.set(type, { type, count: previous.count + 1, messages });
|
|
84
|
+
}
|
|
85
|
+
return [...groups.values()];
|
|
86
|
+
}
|
|
87
|
+
function clip(text) {
|
|
88
|
+
const flat = oneLine(text);
|
|
89
|
+
return flat.length > MAX_TEXT ? `${flat.slice(0, MAX_TEXT)}…` : flat;
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=check.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"check.js","sourceRoot":"","sources":["../../src/core/check.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AACtD,OAAO,EAAE,SAAS,EAAqB,MAAM,oBAAoB,CAAA;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AA4B/C,MAAM,kBAAkB,GAAG,CAAC,CAAA;AAC5B,MAAM,QAAQ,GAAG,GAAG,CAAA;AAQpB;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,IAAY,EAAE,IAAY,EAAE,OAAO,GAAiB,EAAE;IACvF,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAChD,OAAO,WAAW,CAAC,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAA;AACzE,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAA;IACnG,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC3C,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QACvB,MAAM;QACN,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,CAAC;QACxC,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC;QAClC,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;QACpC,SAAS,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,IAAI,EAAE,CAAC,CAAC;QACjD,KAAK,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACxH,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC;KACrE,CAAA;AACH,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,WAAW,CAAC,MAAgD;IAC1E,MAAM,KAAK,GAAG,CAAC,MAA6B,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IAC5F,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAA;AAC3E,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,MAAmB;IAC3D,MAAM,KAAK,GAAG,CAAC,MAAoB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;IACnF,MAAM,MAAM,GAAG,CAAC,CAAS,EAAE,IAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;IAC/E,MAAM,KAAK,GAAG;QACZ,GAAG,IAAI,WAAW,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,EAAE;KAC5I,CAAA;IACD,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI;QAC5B,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC;QAC1B,CAAC,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC;KACtB,EAAE,CAAC;QACX,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,SAAQ;QACjC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjB,KAAK,MAAM,KAAK,IAAI,MAAM;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAA;IAC/D,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACzB,CAAC;AAED,SAAS,WAAW,CAAC,KAAiB;IACpC,MAAM,MAAM,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAA;IAClD,OAAO;QACL,KAAK,KAAK,CAAC,IAAI,GAAG,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG;QAC/D,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,OAAO,EAAE,CAAC;QACpD,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACpD,CAAA;AACH,CAAC;AAED,kGAAkG;AAClG,SAAS,aAAa,CAAC,CAAY;IACjC,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;AAC/F,CAAC;AAED,SAAS,cAAc,CAAC,CAAY;IAClC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW;QAAE,OAAO,mBAAmB,CAAA;IACtD,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;AACxE,CAAC;AAED,SAAS,cAAc,CAAC,CAAa;IACnC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;IACxF,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,CAAA;AAC5F,CAAC;AAED,4HAA4H;AAC5H,SAAS,WAAW,CAAC,MAAwB,EAAE,QAAkB;IAC/D,MAAM,MAAM,GAAG,IAAI,GAAG,EAAsB,CAAA;IAC5C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC7B,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;QACrE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAA;QACvH,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAA;IACjE,CAAC;IACD,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;AAC7B,CAAC;AAED,SAAS,IAAI,CAAC,IAAY;IACxB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC1B,OAAO,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAA;AACtE,CAAC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/** The error and warning counts of the circuit's rule checks, the ones check_circuit reports. */
|
|
2
|
+
export interface CheckCounts {
|
|
3
|
+
errors: number;
|
|
4
|
+
warnings: number;
|
|
5
|
+
}
|
|
6
|
+
/** The checks' counts in one line; with errors, what to do before the board is ordered. The export is not refused. */
|
|
7
|
+
export declare function checksLine(checks: CheckCounts): string;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
// The line an export adds about the circuit's rule checks; for the CLI, the MCP tool and the Studio's note. Pure.
|
|
2
|
+
const counted = (n, word) => `${n} ${word}${n === 1 ? "" : "s"}`;
|
|
3
|
+
/** The checks' counts in one line; with errors, what to do before the board is ordered. The export is not refused. */
|
|
4
|
+
export function checksLine(checks) {
|
|
5
|
+
const counts = `Checks: ${counted(checks.errors, "error")}, ${counted(checks.warnings, "warning")}.`;
|
|
6
|
+
return checks.errors > 0 ? `${counts} Run check_circuit (or copperflow check <file>) and fix the errors before anyone orders this board.` : counts;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=checks-line.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"checks-line.js","sourceRoot":"","sources":["../../src/core/checks-line.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAQlH,MAAM,OAAO,GAAG,CAAC,CAAS,EAAE,IAAY,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAA;AAEhF,sHAAsH;AACtH,MAAM,UAAU,UAAU,CAAC,MAAmB;IAC5C,MAAM,MAAM,GAAG,WAAW,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAA;IACpG,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM,qGAAqG,CAAC,CAAC,CAAC,MAAM,CAAA;AACpJ,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// What a sub-sheet instance's connection may name: a net port a net of the parent ("VBUS"), a bus port a bus of the
|
|
2
|
+
// parent ("D[0:7]"); a net local to an instance ("net.PS1/FB") never. Pure, so the Studio checks with it too.
|
|
3
|
+
import { busMembers } from "../engine/drawing-kinds.js";
|
|
4
|
+
import { localNet, localNetRefusal } from "../engine/selectors.js";
|
|
5
|
+
const NET_NAME = /^[A-Za-z_][\w-]*$/;
|
|
6
|
+
/** Why `target` cannot be what port `port` of `sheet` connects to, or undefined when it can. */
|
|
7
|
+
export function connectionRefusal(sheet, port, target, bus) {
|
|
8
|
+
const local = localNet(target);
|
|
9
|
+
if (local)
|
|
10
|
+
return localNetRefusal(local, undefined);
|
|
11
|
+
const name = target.replace(/^net\./, "");
|
|
12
|
+
if (bus)
|
|
13
|
+
return busMembers(name) === undefined ? `${sheet} port ${port} is a bus port and takes a bus name such as "D[0:7]", not "${target}"` : undefined;
|
|
14
|
+
return NET_NAME.test(name) ? undefined : `${sheet} port ${port} is a net port and takes a net name such as "VBUS", not "${target}"`;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=connection-names.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"connection-names.js","sourceRoot":"","sources":["../../src/core/connection-names.ts"],"names":[],"mappings":"AAAA,oHAAoH;AACpH,8GAA8G;AAC9G,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AAElE,MAAM,QAAQ,GAAG,mBAAmB,CAAA;AAEpC,gGAAgG;AAChG,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,IAAY,EAAE,MAAc,EAAE,GAAY;IACzF,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAA;IAC9B,IAAI,KAAK;QAAE,OAAO,eAAe,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAA;IACzC,IAAI,GAAG;QAAE,OAAO,UAAU,CAAC,IAAI,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,8DAA8D,MAAM,GAAG,CAAC,CAAC,CAAC,SAAS,CAAA;IACzJ,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,SAAS,IAAI,4DAA4D,MAAM,GAAG,CAAA;AACrI,CAAC"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { Design } from "../engine/design.js";
|
|
2
|
+
import { Engine } from "../engine/engine.js";
|
|
3
|
+
/** What the BOM and the check need from an engine: it builds one circuit file into a design. */
|
|
4
|
+
export type DesignSource = Pick<Engine, "build"> & Partial<Pick<Engine, "buildFiles">>;
|
|
5
|
+
/** Builds `file` with the given engine, or with a new engine that is stopped afterwards. */
|
|
6
|
+
export declare function buildWith(root: string, file: string, engine?: DesignSource): Promise<Design>;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Engine } from "../engine/engine.js";
|
|
2
|
+
/** Builds `file` with the given engine, or with a new engine that is stopped afterwards. */
|
|
3
|
+
export async function buildWith(root, file, engine) {
|
|
4
|
+
if (engine)
|
|
5
|
+
return engine.build(root, file);
|
|
6
|
+
const own = new Engine();
|
|
7
|
+
try {
|
|
8
|
+
return await own.build(root, file);
|
|
9
|
+
}
|
|
10
|
+
finally {
|
|
11
|
+
await own.stop();
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=design-source.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"design-source.js","sourceRoot":"","sources":["../../src/core/design-source.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAK5C,4FAA4F;AAC5F,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,IAAY,EAAE,IAAY,EAAE,MAAqB;IAC/E,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IAC3C,MAAM,GAAG,GAAG,IAAI,MAAM,EAAE,CAAA;IACxB,IAAI,CAAC;QACH,OAAO,MAAM,GAAG,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACpC,CAAC;YAAS,CAAC;QACT,MAAM,GAAG,CAAC,IAAI,EAAE,CAAA;IAClB,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { type Scan } from "./analyze.js";
|
|
2
|
+
import type { Edit } from "./types.js";
|
|
3
|
+
/**
|
|
4
|
+
* Adds a drawing (see drawingInsertion for where). One that would still change the id of a drawing already in
|
|
5
|
+
* the file, such as a later one of its kind inside a group, is refused.
|
|
6
|
+
*/
|
|
7
|
+
export declare function addDrawing(source: string, scan: Scan, edit: Extract<Edit, {
|
|
8
|
+
kind: "addDrawing";
|
|
9
|
+
}>): string;
|
|
10
|
+
export declare function removeDrawing(source: string, scan: Scan, id: string, locked: ReadonlySet<string>): string;
|
|
11
|
+
/** Sets literal props of a drawing (moving it is setting x and y, or points); a `name` renames it. */
|
|
12
|
+
export declare function setDrawingProps(source: string, scan: Scan, edit: Extract<Edit, {
|
|
13
|
+
kind: "setDrawingProps";
|
|
14
|
+
}>, locked: ReadonlySet<string>): string;
|
|
15
|
+
/**
|
|
16
|
+
* Refuses an edit that would change, remove or renumber a locked drawing, even one it does not name: removing
|
|
17
|
+
* an earlier unnamed drawing of the same kind, for example, would hand its id to the next one.
|
|
18
|
+
*/
|
|
19
|
+
export declare function keepLockedDrawings(source: string, scan: Scan, next: string, after: Scan, locked: ReadonlySet<string>): void;
|