fix: tsci snapshot failed to load the async footprint being fetched from parts-eninge in tscircuit.config.ts

cli/snapshot/worker-snapshot-handlers.ts

@@ -3,6 +3,8 @@ import type { CameraPreset } from "lib/shared/camera-presets"
 import type { PcbSnapshotSettings } from "lib/project-config/project-config-schema"
 import { processSnapshotFile } from "lib/shared/process-snapshot-file"
 import { registerStaticAssetLoaders } from "lib/shared/register-static-asset-loaders"
+import { loadRuntimeProjectConfig } from "lib/project-config"
+import { mergePlatformConfigs } from "lib/shared/platform-config-utils"
 import type { SnapshotCompletedMessage } from "./worker-types"
 
 type SnapshotWorkerOptions = {
@@ -25,6 +27,11 @@ export const handleSnapshotFile = async (
 ): Promise<SnapshotCompletedMessage> => {
   process.chdir(projectDir)
   await registerStaticAssetLoaders()
+  const projectConfig = await loadRuntimeProjectConfig(projectDir)
+  const platformConfig = mergePlatformConfigs(
+    projectConfig?.platformConfig,
+    options.platformConfig,
+  )
 
   const result = await processSnapshotFile({
     file: filePath,
@@ -35,7 +42,7 @@ export const handleSnapshotFile = async (
     pcbOnly: options.pcbOnly,
     schematicOnly: options.schematicOnly,
     forceUpdate: options.forceUpdate,
-    platformConfig: options.platformConfig,
+    platformConfig,
     pcbSnapshotSettings: options.pcbSnapshotSettings,
     createDiff: options.createDiff,
     cameraPreset: options.cameraPreset,

lib/shared/snapshot-project.ts

@@ -6,11 +6,12 @@ import kleur from "kleur"
 import {
   getBoardFilePatterns,
   getSnapshotsDir,
-  loadProjectConfig,
+  loadRuntimeProjectConfig,
 } from "lib/project-config"
 import type { PcbSnapshotSettings } from "lib/project-config/project-config-schema"
 import type { CameraPreset } from "lib/shared/camera-presets"
-import { findBoardFiles } from "lib/shared/find-board-files"
+import { findBoardFilesAsync } from "lib/shared/find-board-files"
+import { mergePlatformConfigs } from "lib/shared/platform-config-utils"
 import { processSnapshotFile } from "lib/shared/process-snapshot-file"
 import {
   DEFAULT_IGNORED_PATTERNS,
@@ -45,8 +46,9 @@ type SnapshotOptions = {
   onSuccess?: (message: string) => void
 }
 
-const hasConfiguredIncludeBoardFiles = (projectDir: string): boolean => {
-  const projectConfig = loadProjectConfig(projectDir)
+const hasConfiguredIncludeBoardFiles = (
+  projectConfig: Awaited<ReturnType<typeof loadRuntimeProjectConfig>>,
+): boolean => {
   const hasConfiguredPatterns = Boolean(
     projectConfig?.includeBoardFiles?.some((pattern) => pattern.trim()),
   )
@@ -76,7 +78,7 @@ export const snapshotProject = async ({
     threeD = true
   }
   const projectDir = process.cwd()
-  const projectConfig = loadProjectConfig(projectDir)
+  const projectConfig = await loadRuntimeProjectConfig(projectDir)
   const ignore = [
     ...DEFAULT_IGNORED_PATTERNS,
     ...ignored.map(normalizeIgnorePattern),
@@ -90,7 +92,7 @@ export const snapshotProject = async ({
 
     return fs.statSync(resolvedPath).isDirectory()
   })
-  const boardFiles = findBoardFiles({
+  const boardFiles = await findBoardFilesAsync({
     projectDir,
     ignore,
     filePaths: resolvedPaths,
@@ -100,8 +102,14 @@ export const snapshotProject = async ({
     if (explicitDirectoryTarget) {
       const relativeDirectory =
         path.relative(projectDir, explicitDirectoryTarget) || "."
-      const includeBoardFilePatterns = getBoardFilePatterns(projectDir)
-      const patternSourceMessage = hasConfiguredIncludeBoardFiles(projectDir)
+      const runtimeIncludeBoardFilePatterns =
+        projectConfig?.includeBoardFiles?.filter((pattern) => pattern.trim()) ??
+        []
+      const includeBoardFilePatterns =
+        runtimeIncludeBoardFilePatterns.length > 0
+          ? runtimeIncludeBoardFilePatterns
+          : getBoardFilePatterns(projectDir)
+      const patternSourceMessage = hasConfiguredIncludeBoardFiles(projectConfig)
         ? "Searched using tscircuit.config.json includeBoardFiles"
         : "Searched using default includeBoardFiles"
 
@@ -120,10 +128,15 @@ export const snapshotProject = async ({
     return onExit(0)
   }
 
-  const snapshotsDirName = getSnapshotsDir(projectDir)
+  const snapshotsDirName =
+    projectConfig?.snapshotsDir ?? getSnapshotsDir(projectDir)
   const pcbSnapshotSettings = pcbSnapshotSettingsOverride
     ? { ...projectConfig?.pcbSnapshotSettings, ...pcbSnapshotSettingsOverride }
     : projectConfig?.pcbSnapshotSettings
+  const mergedPlatformConfig = mergePlatformConfigs(
+    projectConfig?.platformConfig,
+    platformConfig,
+  )
   const mismatches: string[] = []
   let didUpdate = false
 
@@ -204,7 +217,7 @@ export const snapshotProject = async ({
         pcbOnly,
         schematicOnly,
         forceUpdate,
-        platformConfig,
+        platformConfig: mergedPlatformConfig,
         pcbSnapshotSettings,
         createDiff,
         cameraPreset,

package.json

@@ -18,7 +18,7 @@
     "@tscircuit/image-utils": "^0.0.3",
     "@tscircuit/krt-wasm": "^0.1.0",
     "@tscircuit/math-utils": "0.0.36",
-    "@tscircuit/props": "^0.0.536",
+    "@tscircuit/props": "^0.0.546",
     "@tscircuit/runframe": "^0.0.2057",
     "@tscircuit/schematic-match-adapt": "^0.0.22",
     "@types/bun": "^1.2.2",

tests/cli/runtime-project-config-command-flows.test.ts

@@ -3,6 +3,7 @@ import { mkdir, readFile, writeFile } from "node:fs/promises"
 import { join } from "node:path"
 import { getCliTestFixture } from "../fixtures/get-cli-test-fixture"
 import { getBuildEntrypoints } from "../../cli/build/get-build-entrypoints"
+import "bun-match-svg"
 
 const createTiPlatformConfigModule = ({
   includeBoardFiles,
@@ -260,3 +261,32 @@ test("simulate analog consumes runtime platformConfig from tscircuit.config.ts",
   expect(stderr).toContain("source_port_id")
   expect(stdout).toContain("Index  time")
 }, 30_000)
+
+test("snapshot command consumes runtime platformConfig from tscircuit.config.ts", async () => {
+  const { tmpDir, runCommand } = await getCliTestFixture()
+  const circuitPath = join(tmpDir, "index.circuit.tsx")
+
+  await writeFile(circuitPath, tiBoardCircuitCode)
+  await writeFile(
+    join(tmpDir, "tscircuit.config.ts"),
+    createTiPlatformConfigModule(),
+  )
+
+  const { stdout, stderr, exitCode } = await runCommand(
+    `tsci snapshot --update`,
+  )
+
+  expect(stderr).toBe("")
+  expect(stdout).toContain("Created snapshots")
+
+  const snapshotDir = join(tmpDir, "__snapshots__")
+  const pcbSnapshot = Bun.file(join(snapshotDir, "index.circuit-pcb.snap.svg"))
+  const schematicSnapshot = Bun.file(
+    join(snapshotDir, "index.circuit-schematic.snap.svg"),
+  )
+  expect(pcbSnapshot.text()).toMatchSvgSnapshot(import.meta.path, "pcb")
+  expect(schematicSnapshot.text()).toMatchSvgSnapshot(
+    import.meta.path,
+    "schematic",
+  )
+})