kicadts 0.0.1

package/tests/sexpr/classes/Setup.test.ts

@@ -0,0 +1,189 @@
+import { expect, test } from "bun:test"
+
+import { Setup, SxClass } from "lib/sexpr"
+
+test("Setup", () => {
+  const [setup] = SxClass.parse(`
+(setup
+  (stackup
+    (layer "F.SilkS"
+      (type "Top Silk Screen")
+    )
+    (layer "dielectric 1"
+      (type "core")
+      (thickness 1.51)
+      (material "FR4")
+      (epsilon_r 4.5)
+      (loss_tangent 0.02)
+    )
+    (copper_finish "None")
+    (dielectric_constraints no)
+  )
+  (pad_to_mask_clearance 0)
+  (solder_mask_min_width 0.01)
+  (pad_to_paste_clearance 0)
+  (pad_to_paste_clearance_ratio 0)
+  (last_trace_width 0.254)
+  (trace_clearance 0.254)
+  (zone_clearance 0.2)
+  (zone_45_only no)
+  (trace_min 0.254)
+  (segment_width 0.2)
+  (edge_width 0.15)
+  (via_size 0.889)
+  (via_drill 0.635)
+  (via_min_size 0.889)
+  (via_min_drill 0.508)
+  (uvia_size 0.508)
+  (uvia_drill 0.127)
+  (uvias_allowed no)
+  (uvia_min_size 0.508)
+  (uvia_min_drill 0.127)
+  (pcb_text_width 0.3)
+  (pcb_text_size 1.5 1.5)
+  (mod_edge_width 0.15)
+  (mod_text_size 1.5 1.5)
+  (mod_text_width 0.15)
+  (pad_size 0.0005 0.0005)
+  (pad_drill 0)
+  (allow_soldermask_bridges_in_footprints no)
+  (tenting front back)
+  (aux_axis_origin 10 15)
+  (grid_origin 20 25)
+  (visible_elements 7FFFFFFF)
+  (pcbplotparams
+    (layerselection 0x00000000_00000000_00000000_000000a5)
+    (plot_on_all_layers_selection 0x00000000_00000000_00000000_00000000)
+    (disableapertmacros no)
+    (usegerberextensions yes)
+    (usegerberattributes no)
+    (usegerberadvancedattributes no)
+    (creategerberjobfile no)
+    (dashed_line_dash_ratio 12)
+    (dashed_line_gap_ratio 3)
+    (svgprecision 6)
+    (plotframeref no)
+    (mode 1)
+    (useauxorigin no)
+    (hpglpennumber 1)
+    (hpglpenspeed 20)
+    (hpglpendiameter 15)
+    (pdf_front_fp_property_popups yes)
+    (pdf_back_fp_property_popups yes)
+    (pdf_metadata yes)
+    (pdf_single_document no)
+    (dxfpolygonmode yes)
+    (dxfimperialunits yes)
+    (dxfusepcbnewfont yes)
+    (psnegative no)
+    (psa4output no)
+    (plot_black_and_white yes)
+    (plotinvisibletext no)
+    (sketchpadsonfab no)
+    (plotpadnumbers no)
+    (hidednponfab no)
+    (sketchdnponfab yes)
+    (crossoutdnponfab yes)
+    (subtractmaskfromsilk no)
+    (outputformat 1)
+    (mirror no)
+    (drillshape 1)
+    (scaleselection 1)
+    (outputdirectory "")
+  )
+)
+`)
+
+  expect(setup).toBeInstanceOf(Setup)
+  expect(setup!.getString()).toMatchInlineSnapshot(`
+    "(setup
+      (stackup
+        (layer \"F.SilkS\"
+          (type \"Top Silk Screen\")
+        )
+        (layer \"dielectric 1\"
+          (type \"core\")
+          (thickness 1.51)
+          (material \"FR4\")
+          (epsilon_r 4.5)
+          (loss_tangent 0.02)
+        )
+        (copper_finish \"None\")
+        (dielectric_constraints no)
+      )
+      (pad_to_mask_clearance 0)
+      (solder_mask_min_width 0.01)
+      (pad_to_paste_clearance 0)
+      (pad_to_paste_clearance_ratio 0)
+      (last_trace_width 0.254)
+      (trace_clearance 0.254)
+      (zone_clearance 0.2)
+      (zone_45_only no)
+      (trace_min 0.254)
+      (segment_width 0.2)
+      (edge_width 0.15)
+      (via_size 0.889)
+      (via_drill 0.635)
+      (via_min_size 0.889)
+      (via_min_drill 0.508)
+      (uvia_size 0.508)
+      (uvia_drill 0.127)
+      (uvias_allowed no)
+      (uvia_min_size 0.508)
+      (uvia_min_drill 0.127)
+      (pcb_text_width 0.3)
+      (pcb_text_size 1.5 1.5)
+      (mod_edge_width 0.15)
+      (mod_text_size 1.5 1.5)
+      (mod_text_width 0.15)
+      (pad_size 0.0005 0.0005)
+      (pad_drill 0)
+      (allow_soldermask_bridges_in_footprints no)
+      (tenting front back)
+      (aux_axis_origin 10 15)
+      (grid_origin 20 25)
+      (visible_elements 7FFFFFFF)
+      (pcbplotparams
+        (layerselection 0x00000000_00000000_00000000_000000a5)
+        (plot_on_all_layers_selection 0x00000000_00000000_00000000_00000000)
+        (disableapertmacros no)
+        (usegerberextensions yes)
+        (usegerberattributes no)
+        (usegerberadvancedattributes no)
+        (creategerberjobfile no)
+        (dashed_line_dash_ratio 12)
+        (dashed_line_gap_ratio 3)
+        (svgprecision 6)
+        (plotframeref no)
+        (mode 1)
+        (useauxorigin no)
+        (hpglpennumber 1)
+        (hpglpenspeed 20)
+        (hpglpendiameter 15)
+        (pdf_front_fp_property_popups yes)
+        (pdf_back_fp_property_popups yes)
+        (pdf_metadata yes)
+        (pdf_single_document no)
+        (dxfpolygonmode yes)
+        (dxfimperialunits yes)
+        (dxfusepcbnewfont yes)
+        (psnegative no)
+        (psa4output no)
+        (plot_black_and_white yes)
+        (plotinvisibletext no)
+        (sketchpadsonfab no)
+        (plotpadnumbers no)
+        (hidednponfab no)
+        (sketchdnponfab yes)
+        (crossoutdnponfab yes)
+        (subtractmaskfromsilk no)
+        (outputformat 1)
+        (mirror no)
+        (drillshape 1)
+        (scaleselection 1)
+        (outputdirectory \"\")
+      )
+    )"
+  `)
+})
+

package/tests/sexpr/classes/Sheet.test.ts

@@ -0,0 +1,107 @@
+import { At, Sheet, SheetProperty, SheetPin, Stroke, SxClass } from "lib/sexpr"
+import { expect, test } from "bun:test"
+
+test("Sheet", () => {
+  const [sheet] = SxClass.parse(`
+    (sheet
+      (at 25.4 30.48 0)
+      (size 100 70)
+      (exclude_from_sim no)
+      (in_bom yes)
+      (on_board yes)
+      (dnp no)
+      (fields_autoplaced yes)
+      (stroke (width 0.1) (type solid) (color 0 0 0 1))
+      (fill (color 0 0 0 1))
+      (uuid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee)
+      (property "Sheet name" "Controller"
+        (id 0)
+        (at 0 0 0)
+        (effects (font (size 1.27 1.27) (thickness 0.1524)))
+      )
+      (pin "IN" input
+        (at 50.8 0 180)
+        (uuid 11111111-2222-3333-4444-555555555555)
+        (effects (font (size 1 1) (thickness 0.15)))
+      )
+      (instances
+        (project "Project"
+          (path "/0001"
+            (page "1")
+          )
+        )
+      )
+    )
+  `)
+
+  expect(sheet).toBeInstanceOf(Sheet)
+  const s = sheet as Sheet
+  expect(s.position).toBeInstanceOf(At)
+  expect(s.size).toEqual({ width: 100, height: 70 })
+  expect(s.excludeFromSim).toBe(false)
+  expect(s.inBom).toBe(true)
+  expect(s.onBoard).toBe(true)
+  expect(s.dnp).toBe(false)
+  expect(s.fieldsAutoplaced).toBe(true)
+  expect(s.stroke).toBeInstanceOf(Stroke)
+  expect(s.fill?.color).toBeDefined()
+  expect(s.uuid?.value).toBe("aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee")
+  expect(s.properties).toHaveLength(1)
+  expect(s.properties[0]).toBeInstanceOf(SheetProperty)
+  expect(s.pins).toHaveLength(1)
+  expect(s.pins[0]).toBeInstanceOf(SheetPin)
+  const pin = s.pins[0]!
+  expect(pin.name).toBe("IN")
+  expect(pin.electricalType).toBe("input")
+  expect(pin.position).toBeInstanceOf(At)
+  expect(pin.effects).toBeDefined()
+  expect(s.instances).toBeDefined()
+
+  expect(s.getString()).toMatchInlineSnapshot(`
+    "(sheet
+      (at 25.4 30.48 0)
+      (size 100 70)
+      (exclude_from_sim no)
+      (in_bom yes)
+      (on_board yes)
+      (dnp no)
+      (fields_autoplaced yes)
+      (stroke
+        (width 0.1)
+        (type solid)
+        (color 0 0 0 1)
+      )
+      (fill
+        (color 0 0 0 1)
+      )
+      (uuid aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee)
+      (property \"Sheet name\" \"Controller\"
+        (id 0)
+        (at 0 0 0)
+        (effects
+          (font
+            (size 1.27 1.27)
+            (thickness 0.1524)
+          )
+        )
+      )
+      (pin \"IN\" input
+        (at 50.8 0 180)
+        (effects
+          (font
+            (size 1 1)
+            (thickness 0.15)
+          )
+        )
+        (uuid 11111111-2222-3333-4444-555555555555)
+      )
+      (instances
+        (project \"Project\"
+          (path \"/0001\"
+            (page \"1\")
+          )
+        )
+      )
+    )"
+  `)
+})

package/tests/sexpr/classes/Stroke.test.ts

@@ -0,0 +1,15 @@
+import { Stroke, SxClass } from "lib/sexpr"
+import { test, expect } from "bun:test"
+
+test("Stroke", () => {
+  const [stroke] = SxClass.parse(
+    "(stroke (width 1) (type solid) (color 0 0 0 1))",
+  )
+  expect(stroke!.getString()).toMatchInlineSnapshot(`
+    "(stroke
+      (width 1)
+      (type solid)
+      (color 0 0 0 1)
+    )"
+  `)
+})

package/tests/sexpr/classes/Symbol.test.ts

@@ -0,0 +1,96 @@
+import {
+  At,
+  SxClass,
+  SchematicSymbol,
+  SymbolProperty,
+  SymbolPin,
+  TextEffects,
+} from "lib/sexpr"
+import { expect, test } from "bun:test"
+
+test("Symbol parse", () => {
+  const [symbol] = SxClass.parse(`
+    (symbol "Device:R"
+      (at 10 20 90)
+      (unit 2)
+      (in_bom yes)
+      (on_board no)
+      (uuid 12345678-1234-1234-1234-123456789abc)
+      (property "Reference" "R?"
+        (id 0)
+        (at 0 0 0)
+        (effects (font (size 1.27 1.27) (thickness 0.1524)))
+      )
+      (pin input line (at 0 -5.08 90) (length 2.54)
+        (name "A" (effects (font (size 1.27 1.27))))
+        (number "1" (effects (font (size 1.27 1.27))))
+      )
+      (instances (project "Project" (path "/0001" (reference "R1") (unit 1))))
+    )
+  `)
+
+  console.log(symbol)
+
+  expect(symbol).toBeInstanceOf(SchematicSymbol)
+  const sym = symbol as SchematicSymbol
+  expect(sym.libraryId).toBe("Device:R")
+  expect(sym.inBom).toBe(true)
+  expect(sym.onBoard).toBe(false)
+  expect(sym.uuid).toBe("12345678-1234-1234-1234-123456789abc")
+  expect(sym.properties).toHaveLength(1)
+  const property = sym.properties[0] as SymbolProperty
+  expect(property.key).toBe("Reference")
+  expect(property.value).toBe("R?")
+  expect(property.id).toBe(0)
+  expect(sym.pins).toHaveLength(1)
+  const pin = sym.pins[0] as SymbolPin
+  expect(pin.name).toBe("A")
+  expect(pin.numberString).toBe("1")
+  expect(sym.instances).toBeDefined()
+
+  expect(sym.getString()).toMatchInlineSnapshot(`
+    "(symbol "Device:R"
+      (at 10 20 90)
+      (unit 2)
+      (in_bom yes)
+      (on_board no)
+      (uuid 12345678-1234-1234-1234-123456789abc)
+      (property "Reference" "R?"
+        (id 0)
+        (at 0 0 0)
+        (effects
+          (font
+            (size 1.27 1.27)
+            (thickness 0.1524)
+          )
+        )
+      )
+      (pin input line
+        (at 0 -5.08 90)
+        (length 2.54)
+        (name "A"
+          (effects
+            (font
+              (size 1.27 1.27)
+            )
+          )
+        )
+        (number "1"
+          (effects
+            (font
+              (size 1.27 1.27)
+            )
+          )
+        )
+      )
+      (instances
+        (project "Project"
+          (path "/0001"
+            (reference "R1")
+            (unit 1)
+          )
+        )
+      )
+    )"
+  `)
+})

package/tests/sexpr/classes/TextEffects.test.ts

@@ -0,0 +1,56 @@
+import { SxClass, TextEffects, TextEffectsJustify } from "lib/sexpr"
+import { expect, test } from "bun:test"
+
+test("TextEffects", () => {
+  const [effects] = SxClass.parse(`
+    (effects
+      (font
+        (face "KiCad Font")
+        (size 1.5 1.2)
+        (thickness 0.3)
+        bold
+        italic
+        (line_spacing 1.1)
+      )
+      (justify left top mirror)
+      hide
+    )
+  `)
+
+  expect(effects).toBeInstanceOf(TextEffects)
+
+  const textEffects = effects as TextEffects
+  expect(textEffects.font.face).toBe("KiCad Font")
+  expect(textEffects.font.size).toEqual({ height: 1.5, width: 1.2 })
+  expect(textEffects.font.thickness).toBe(0.3)
+  expect(textEffects.font.bold).toBe(true)
+  expect(textEffects.font.italic).toBe(true)
+  expect(textEffects.font.lineSpacing).toBe(1.1)
+
+  const justify = textEffects.justify as TextEffectsJustify
+  expect(justify.horizontal).toBe("left")
+  expect(justify.vertical).toBe("top")
+  expect(justify.mirror).toBe(true)
+
+  expect(textEffects.hiddenText).toBe(true)
+
+  textEffects.hiddenText = false
+  textEffects.justify = new TextEffectsJustify({
+    horizontal: "right",
+    vertical: "bottom",
+  })
+
+  expect(textEffects.getString()).toMatchInlineSnapshot(`
+    "(effects
+      (font
+        (face \"KiCad Font\")
+        (size 1.5 1.2)
+        (thickness 0.3)
+        bold
+        italic
+        (line_spacing 1.1)
+      )
+      (justify right bottom)
+    )"
+  `)
+})

package/tests/sexpr/classes/TitleBlock.test.ts

@@ -0,0 +1,40 @@
+import { SxClass, TitleBlock } from "lib/sexpr"
+import { expect, test } from "bun:test"
+
+test("TitleBlock", () => {
+  const [titleBlock] = SxClass.parse(`
+    (title_block
+      (title "Project Title")
+      (date "2024-05-12")
+      (rev "A1")
+      (company "ACME Corp")
+      (comment 2 "Secondary comment")
+      (comment 1 "Primary comment")
+    )
+  `)
+
+  expect(titleBlock).toBeInstanceOf(TitleBlock)
+
+  const block = titleBlock as TitleBlock
+  expect(block.title).toBe("Project Title")
+  expect(block.date).toBe("2024-05-12")
+  expect(block.rev).toBe("A1")
+  expect(block.company).toBe("ACME Corp")
+  expect(block.getComment(1)).toBe("Primary comment")
+  expect(block.getComment(2)).toBe("Secondary comment")
+
+  block.setComment(3, "Additional note")
+  expect(block.getComment(3)).toBe("Additional note")
+
+  expect(block.getString()).toMatchInlineSnapshot(`
+    "(title_block
+      (title \"Project Title\")
+      (date \"2024-05-12\")
+      (rev \"A1\")
+      (company \"ACME Corp\")
+      (comment 1 \"Primary comment\")
+      (comment 2 \"Secondary comment\")
+      (comment 3 \"Additional note\")
+    )"
+  `)
+})

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    "baseUrl": ".",
+    "paths": {
+      "lib/*": ["./lib/*"],
+      "tests/*": ["./tests/*"]
+    },
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}