@tscircuit/footprinter 0.0.3 → 0.0.5

package/README.md

@@ -43,3 +43,20 @@ should always confirm these footprints against the datasheet.
 
 - Pins are CCW starting at the top left
 - Y is upward-positive, X is rightward-positive
+
+## Slop
+
+Slop is a "sloppy" definition, it really doesn't have enough
+information to draw a footprint, i.e. it's missing critical dimensions.
+
+footprinter is extremely tolerant to Slop, because it's useful
+when you're iterating incrementally towards a fully constrained
+design, or when you're using footprinter strings as an output format
+for an AI.
+
+Generally when footprinter is interpreting a sloppy definition, it will use
+industry best practices or otherwise "reasonable" defaults. In theory, upgrading
+footprinter could cause the defaults to change, which is why sloppy definitions
+are generally not desirable.
+
+Currently it's not possible to see if a given definition is sloppy.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tscircuit/footprinter",
   "type": "module",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "",
   "main": "dist/index.cjs",
   "scripts": {
@@ -12,7 +12,10 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@tscircuit/log-soup": "^1.0.1",
     "@tscircuit/soup": "^0.0.17",
+    "@tscircuit/soup-util": "^0.0.11",
+    "@types/node": "^20.12.13",
     "ava": "^6.1.3",
     "esbuild": "^0.21.4",
     "esbuild-register": "^3.5.0",

package/src/fn/dip.ts

@@ -1,5 +1,16 @@
 import type { AnySoupElement } from "@tscircuit/soup"
 import { platedhole } from "../helpers/platedhole"
+import { z } from "zod"
+import { length } from "@tscircuit/soup"
+
+const dip_def = z.object({
+  dip: z.literal(true),
+  num_pins: z.number(),
+  w: length,
+  p: length.optional(),
+  id: length.optional(),
+  od: length.optional(),
+})
 
 export const getCcwDipCoords = (
   pinCount: number,
@@ -40,6 +51,7 @@ export const dip = (params: {
   id?: string | number
   od?: string | number
 }): AnySoupElement[] => {
+  params = dip_def.parse(params)
   const platedHoles: AnySoupElement[] = []
   for (let i = 0; i < params.num_pins; i++) {
     const { x, y } = getCcwDipCoords(

package/src/footprinter.ts

@@ -47,7 +47,7 @@ export const string = (def: string): Footprinter => {
   let fp = footprinter()
 
   const def_parts = def.split("_").map((s) => {
-    const m = s.match(/([a-z]+)([\(\d\+].*)?/)
+    const m = s.match(/([a-z]+)([\(\d\.\+].*)?/)
     const [_, fn, v] = m ?? []
     return { fn: m?.[1]!, v: m?.[2]! }
   })

package/tests/dip.test.ts

@@ -1,6 +1,6 @@
 import test from "ava"
 import { fp } from "../src/footprinter"
-import { AnySoupElement } from "@tscircuit/soup"
+import type { AnySoupElement } from "@tscircuit/soup"
 import { toPinPositionString } from "./fixtures"
 
 test("dip params", (t) => {
@@ -26,8 +26,8 @@ test("dip footprint", (t) => {
   )
 })
 
-test("dip4_w3", (t) => {
-  const soup = fp.string("dip4_w3").soup()
+test("dip4_w3.00mm", (t) => {
+  const soup = fp.string("dip4_w3.00mm").soup()
   const ps = toPinPositionString(soup)
 
   t.is(

package/tests/fixtures/get-test-fixture.ts

@@ -0,0 +1,14 @@
+import type { ExecutionContext } from "ava"
+import { fp } from "../../src"
+import { logSoup } from "@tscircuit/log-soup"
+import type { AnySoupElement } from "@tscircuit/soup"
+
+export const getTestFixture = async (t: ExecutionContext) => {
+  return {
+    fp,
+    logSoup: (soup: AnySoupElement[]) => {
+      if (process.env.CI) return
+      return logSoup(`footprinter: ${t.title}`, soup)
+    },
+  }
+}

package/tests/fixtures/index.ts

@@ -1,5 +1,7 @@
 import type { AnySoupElement } from "@tscircuit/soup"
 
+export { getTestFixture } from "./get-test-fixture"
+
 export const toPinPositionString = (soup: AnySoupElement[]) => {
   return soup
     .map((e: AnySoupElement) => {

package/tests/slop/slop1.test.ts

@@ -0,0 +1,18 @@
+import test from "ava"
+import { getTestFixture } from "../fixtures"
+import type { AnySoupElement } from "@tscircuit/soup"
+
+export const SLOP_LIST = ["dip3"]
+
+test("slop1", async (t) => {
+  const { fp, logSoup } = await getTestFixture(t)
+
+  const soups: AnySoupElement[][] = []
+
+  for (const slop of SLOP_LIST) {
+    const soup = fp.string(slop).soup()
+    soups.push(soup)
+  }
+
+  await logSoup(soups[0]!)
+})