kicadts 0.0.1 → 0.0.2

package/lib/sexpr/parseToPrimitiveSExpr.ts

@@ -101,7 +101,12 @@ export function tokenize(input: string): Token[] {
     }
 
     // Number or symbol
-    if (isSymbolInitial(current) || current === "-" || current === "+" || current === ".") {
+    if (
+      isSymbolInitial(current) ||
+      current === "-" ||
+      current === "+" ||
+      current === "."
+    ) {
       // read a maximal token until delimiter
       let start = i
       while (i < input.length) {

package/lib/sexpr/utils/strokeFromArgs.ts

@@ -2,13 +2,12 @@ import { SxClass } from "../base-classes/SxClass"
 import type { PrimitiveSExpr } from "../parseToPrimitiveSExpr"
 import { Stroke } from "../classes/Stroke"
 
-export const strokeFromArgs = (
-  args: PrimitiveSExpr[],
-): Stroke | undefined => {
+export const strokeFromArgs = (args: PrimitiveSExpr[]): Stroke | undefined => {
   try {
-    const parsed = SxClass.parsePrimitiveSexpr(
-      ["stroke", ...args] as PrimitiveSExpr,
-    )
+    const parsed = SxClass.parsePrimitiveSexpr([
+      "stroke",
+      ...args,
+    ] as PrimitiveSExpr)
     if (parsed instanceof Stroke) {
       return parsed
     }

package/lib/sexpr/utils/toStringValue.ts

@@ -5,6 +5,7 @@ export const toStringValue = (
 ): string | undefined => {
   if (value === undefined) return undefined
   if (typeof value === "string") return value
-  if (typeof value === "number" || typeof value === "boolean") return String(value)
+  if (typeof value === "number" || typeof value === "boolean")
+    return String(value)
   return undefined
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kicadts",
   "module": "dist/index.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "type": "module",
   "repository": {
     "type": "git",
@@ -18,6 +18,7 @@
   "devDependencies": {
     "@biomejs/biome": "^2.2.4",
     "@types/bun": "latest",
+    "looks-same": "^10.0.1",
     "tsup": "^8.5.0"
   },
   "peerDependencies": {

package/scripts/download-references.ts

@@ -1,11 +1,11 @@
-import { mkdir, writeFile } from "node:fs/promises";
-import { resolve, dirname } from "node:path";
-import { fileURLToPath } from "node:url";
+import { mkdir, writeFile } from "node:fs/promises"
+import { resolve, dirname } from "node:path"
+import { fileURLToPath } from "node:url"
 
 type ReferenceSpec = {
-  readonly url: string;
-  readonly filename: string;
-};
+  readonly url: string
+  readonly filename: string
+}
 
 const references: ReferenceSpec[] = [
   {
@@ -28,39 +28,41 @@ const references: ReferenceSpec[] = [
     url: "https://gitlab.com/kicad/services/kicad-dev-docs/-/raw/master/content/file-formats/sexpr-symbol-lib/_index.en.adoc",
     filename: "SCH_SYM_SEXPR.adoc",
   },
-];
+]
 
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const repoRoot = resolve(__dirname, "..");
-const referencesDir = resolve(repoRoot, "references");
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const repoRoot = resolve(__dirname, "..")
+const referencesDir = resolve(repoRoot, "references")
 
 async function fetchReference(reference: ReferenceSpec): Promise<void> {
-  const response = await fetch(reference.url);
+  const response = await fetch(reference.url)
 
   if (!response.ok) {
-    throw new Error(`${reference.url} (${response.status} ${response.statusText})`);
+    throw new Error(
+      `${reference.url} (${response.status} ${response.statusText})`,
+    )
   }
 
-  const content = await response.text();
-  const targetPath = resolve(referencesDir, reference.filename);
+  const content = await response.text()
+  const targetPath = resolve(referencesDir, reference.filename)
 
-  await writeFile(targetPath, content, "utf8");
-  console.log(`Saved ${reference.filename}`);
+  await writeFile(targetPath, content, "utf8")
+  console.log(`Saved ${reference.filename}`)
 }
 
 async function main(): Promise<void> {
-  await mkdir(referencesDir, { recursive: true });
+  await mkdir(referencesDir, { recursive: true })
 
   await Promise.all(
     references.map(async (reference) => {
       try {
-        await fetchReference(reference);
+        await fetchReference(reference)
       } catch (error) {
-        console.error(`Failed to download ${reference.filename}:`, error);
-        process.exitCode = 1;
+        console.error(`Failed to download ${reference.filename}:`, error)
+        process.exitCode = 1
       }
     }),
-  );
+  )
 }
 
-await main();
+await main()

package/tests/fixtures/expectEqualPrimitiveSExpr.ts

@@ -100,13 +100,14 @@ export const expectEqualPrimitiveSExpr = (
   const normalizedExpected = canonicalizePrimitiveSExpr(expected)
 
   const rootPath = options.path ?? "sexpr"
-  const contextEntries = options.context
-    ? Object.entries(options.context)
-    : []
+  const contextEntries = options.context ? Object.entries(options.context) : []
 
   const formatPath = (segments: readonly string[]): string => segments.join("")
 
-  const buildPayload = (path: string, value: unknown): Record<string, unknown> => {
+  const buildPayload = (
+    path: string,
+    value: unknown,
+  ): Record<string, unknown> => {
     if (contextEntries.length === 0) {
       return { path, value }
     }
@@ -131,9 +132,7 @@ export const expectEqualPrimitiveSExpr = (
     )
   }
 
-  const getNodeToken = (
-    value: CanonicalPrimitiveSExpr,
-  ): string | undefined => {
+  const getNodeToken = (value: CanonicalPrimitiveSExpr): string | undefined => {
     if (!Array.isArray(value)) {
       return undefined
     }

package/tests/fixtures/png-matcher.ts

@@ -0,0 +1,109 @@
+import { expect, type MatcherResult } from "bun:test"
+import * as fs from "node:fs"
+import * as path from "node:path"
+import looksSame from "looks-same"
+
+/**
+ * Matcher for PNG snapshot testing.
+ *
+ * Usage:
+ *   expect(pngBuffer).toMatchPngSnapshot(import.meta.path, "optionalName");
+ */
+async function toMatchPngSnapshot(
+  // biome-ignore lint/suspicious/noExplicitAny: bun doesn't expose
+  this: any,
+  receivedMaybePromise: Buffer | Uint8Array | Promise<Buffer | Uint8Array>,
+  testPathOriginal: string,
+  pngName?: string,
+): Promise<MatcherResult> {
+  const received = await receivedMaybePromise
+  const testPath = testPathOriginal
+    .replace(/\.test\.tsx?$/, "")
+    .replace(/\.test\.ts$/, "")
+  const snapshotDir = path.join(path.dirname(testPath), "__snapshots__")
+  const snapshotName = pngName
+    ? `${pngName}.snap.png`
+    : `${path.basename(testPath)}.snap.png`
+  const filePath = path.join(snapshotDir, snapshotName)
+
+  if (!fs.existsSync(snapshotDir)) {
+    fs.mkdirSync(snapshotDir, { recursive: true })
+  }
+
+  const updateSnapshot =
+    process.argv.includes("--update-snapshots") ||
+    process.argv.includes("-u") ||
+    Boolean(process.env["BUN_UPDATE_SNAPSHOTS"])
+  const forceUpdate = Boolean(process.env["FORCE_BUN_UPDATE_SNAPSHOTS"])
+
+  const fileExists = fs.existsSync(filePath)
+
+  if (!fileExists) {
+    console.log("Writing PNG snapshot to", filePath)
+    fs.writeFileSync(filePath, received)
+    return {
+      message: () => `PNG snapshot created at ${filePath}`,
+      pass: true,
+    }
+  }
+
+  const existingSnapshot = fs.readFileSync(filePath)
+
+  const result: any = await looksSame(
+    Buffer.from(received),
+    Buffer.from(existingSnapshot),
+    {
+      strict: false,
+      tolerance: 2,
+    },
+  )
+
+  if (updateSnapshot) {
+    if (!forceUpdate && result.equal) {
+      return {
+        message: () => "PNG snapshot matches",
+        pass: true,
+      }
+    }
+    console.log("Updating PNG snapshot at", filePath)
+    fs.writeFileSync(filePath, received)
+    return {
+      message: () => `PNG snapshot updated at ${filePath}`,
+      pass: true,
+    }
+  }
+
+  if (result.equal) {
+    return {
+      message: () => "PNG snapshot matches",
+      pass: true,
+    }
+  }
+
+  const diffPath = filePath.replace(/\.snap\.png$/, ".diff.png")
+  await looksSame.createDiff({
+    reference: Buffer.from(existingSnapshot),
+    current: Buffer.from(received),
+    diff: diffPath,
+    highlightColor: "#ff00ff",
+  })
+
+  return {
+    message: () => `PNG snapshot does not match. Diff saved at ${diffPath}`,
+    pass: false,
+  }
+}
+
+// Register the matcher globally for Bun's expect
+expect.extend({
+  toMatchPngSnapshot: toMatchPngSnapshot as any,
+})
+
+declare module "bun:test" {
+  interface Matchers<T = unknown> {
+    toMatchPngSnapshot(
+      testPath: string,
+      pngName?: string,
+    ): Promise<MatcherResult>
+  }
+}

package/tests/fixtures/preload.ts

@@ -0,0 +1 @@
+import "./png-matcher"

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

@@ -1,4 +1,11 @@
-import { FootprintPad, PadLayers, PadNet, PadSize, PadDrill, SxClass } from "lib/sexpr"
+import {
+  FootprintPad,
+  PadLayers,
+  PadNet,
+  PadSize,
+  PadDrill,
+  SxClass,
+} from "lib/sexpr"
 import { expect, test } from "bun:test"
 
 test("FootprintPad", () => {

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

@@ -1,4 +1,12 @@
-import { At, Image, ImageData, ImageScale, Layer, SxClass, Uuid } from "lib/sexpr"
+import {
+  At,
+  Image,
+  ImageData,
+  ImageScale,
+  Layer,
+  SxClass,
+  Uuid,
+} from "lib/sexpr"
 import { expect, test } from "bun:test"
 
 test("Image", () => {

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

@@ -40,9 +40,7 @@ test("KicadSch parse", () => {
 
   expect(schematic.version).toBe(20240101)
   expect(schematic.generator).toBe("kicad-cli")
-  expect(schematic.uuid?.value).toBe(
-    "01234567-89ab-cdef-0123-456789abcdef",
-  )
+  expect(schematic.uuid?.value).toBe("01234567-89ab-cdef-0123-456789abcdef")
 
   expect(schematic.paper).toBeInstanceOf(Paper)
   expect(schematic.titleBlock).toBeInstanceOf(TitleBlock)

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

@@ -186,4 +186,3 @@ test("Setup", () => {
     )"
   `)
 })
-

package/bun.lock

@@ -1,48 +0,0 @@
-{
-  "lockfileVersion": 1,
-  "workspaces": {
-    "": {
-      "name": "kicadts",
-      "devDependencies": {
-        "@biomejs/biome": "^2.2.4",
-        "@types/bun": "latest",
-      },
-      "peerDependencies": {
-        "typescript": "^5",
-      },
-    },
-  },
-  "packages": {
-    "@biomejs/biome": ["@biomejs/biome@2.2.4", "", { "optionalDependencies": { "@biomejs/cli-darwin-arm64": "2.2.4", "@biomejs/cli-darwin-x64": "2.2.4", "@biomejs/cli-linux-arm64": "2.2.4", "@biomejs/cli-linux-arm64-musl": "2.2.4", "@biomejs/cli-linux-x64": "2.2.4", "@biomejs/cli-linux-x64-musl": "2.2.4", "@biomejs/cli-win32-arm64": "2.2.4", "@biomejs/cli-win32-x64": "2.2.4" }, "bin": { "biome": "bin/biome" } }, "sha512-TBHU5bUy/Ok6m8c0y3pZiuO/BZoY/OcGxoLlrfQof5s8ISVwbVBdFINPQZyFfKwil8XibYWb7JMwnT8wT4WVPg=="],
-
-    "@biomejs/cli-darwin-arm64": ["@biomejs/cli-darwin-arm64@2.2.4", "", { "os": "darwin", "cpu": "arm64" }, "sha512-RJe2uiyaloN4hne4d2+qVj3d3gFJFbmrr5PYtkkjei1O9c+BjGXgpUPVbi8Pl8syumhzJjFsSIYkcLt2VlVLMA=="],
-
-    "@biomejs/cli-darwin-x64": ["@biomejs/cli-darwin-x64@2.2.4", "", { "os": "darwin", "cpu": "x64" }, "sha512-cFsdB4ePanVWfTnPVaUX+yr8qV8ifxjBKMkZwN7gKb20qXPxd/PmwqUH8mY5wnM9+U0QwM76CxFyBRJhC9tQwg=="],
-
-    "@biomejs/cli-linux-arm64": ["@biomejs/cli-linux-arm64@2.2.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-M/Iz48p4NAzMXOuH+tsn5BvG/Jb07KOMTdSVwJpicmhN309BeEyRyQX+n1XDF0JVSlu28+hiTQ2L4rZPvu7nMw=="],
-
-    "@biomejs/cli-linux-arm64-musl": ["@biomejs/cli-linux-arm64-musl@2.2.4", "", { "os": "linux", "cpu": "arm64" }, "sha512-7TNPkMQEWfjvJDaZRSkDCPT/2r5ESFPKx+TEev+I2BXDGIjfCZk2+b88FOhnJNHtksbOZv8ZWnxrA5gyTYhSsQ=="],
-
-    "@biomejs/cli-linux-x64": ["@biomejs/cli-linux-x64@2.2.4", "", { "os": "linux", "cpu": "x64" }, "sha512-orr3nnf2Dpb2ssl6aihQtvcKtLySLta4E2UcXdp7+RTa7mfJjBgIsbS0B9GC8gVu0hjOu021aU8b3/I1tn+pVQ=="],
-
-    "@biomejs/cli-linux-x64-musl": ["@biomejs/cli-linux-x64-musl@2.2.4", "", { "os": "linux", "cpu": "x64" }, "sha512-m41nFDS0ksXK2gwXL6W6yZTYPMH0LughqbsxInSKetoH6morVj43szqKx79Iudkp8WRT5SxSh7qVb8KCUiewGg=="],
-
-    "@biomejs/cli-win32-arm64": ["@biomejs/cli-win32-arm64@2.2.4", "", { "os": "win32", "cpu": "arm64" }, "sha512-NXnfTeKHDFUWfxAefa57DiGmu9VyKi0cDqFpdI+1hJWQjGJhJutHPX0b5m+eXvTKOaf+brU+P0JrQAZMb5yYaQ=="],
-
-    "@biomejs/cli-win32-x64": ["@biomejs/cli-win32-x64@2.2.4", "", { "os": "win32", "cpu": "x64" }, "sha512-3Y4V4zVRarVh/B/eSHczR4LYoSVyv3Dfuvm3cWs5w/HScccS0+Wt/lHOcDTRYeHjQmMYVC3rIRWqyN2EI52+zg=="],
-
-    "@types/bun": ["@types/bun@1.2.22", "", { "dependencies": { "bun-types": "1.2.22" } }, "sha512-5A/KrKos2ZcN0c6ljRSOa1fYIyCKhZfIVYeuyb4snnvomnpFqC0tTsEkdqNxbAgExV384OETQ//WAjl3XbYqQA=="],
-
-    "@types/node": ["@types/node@24.5.2", "", { "dependencies": { "undici-types": "~7.12.0" } }, "sha512-FYxk1I7wPv3K2XBaoyH2cTnocQEu8AOZ60hPbsyukMPLv5/5qr7V1i8PLHdl6Zf87I+xZXFvPCXYjiTFq+YSDQ=="],
-
-    "@types/react": ["@types/react@19.1.13", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-hHkbU/eoO3EG5/MZkuFSKmYqPbSVk5byPFa3e7y/8TybHiLMACgI8seVYlicwk7H5K/rI2px9xrQp/C+AUDTiQ=="],
-
-    "bun-types": ["bun-types@1.2.22", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-hwaAu8tct/Zn6Zft4U9BsZcXkYomzpHJX28ofvx7k0Zz2HNz54n1n+tDgxoWFGB4PcFvJXJQloPhaV2eP3Q6EA=="],
-
-    "csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
-
-    "typescript": ["typescript@5.9.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A=="],
-
-    "undici-types": ["undici-types@7.12.0", "", {}, "sha512-goOacqME2GYyOZZfb5Lgtu+1IDmAlAEu5xnD3+xTzS10hT0vzpf0SPjkXwAw9Jm+4n/mQGDP3LO8CPbYROeBfQ=="],
-  }
-}