@typecad/framework-zephyr 1.0.0-alpha.12 → 1.0.0-alpha.14

package/src/toolchain/scaffold.ts

@@ -10,6 +10,7 @@
 import { writeFileSync, existsSync, mkdirSync, readFileSync, readdirSync } from 'node:fs';
 import { join } from 'node:path';
 import { resolveKconfigFragments, type KconfigUsage } from '../dt-config/kconfig.js';
+import { readCuttlefishLibrarySidecar } from '@typecad/cuttlefish/library-packages';
 
 /** Write a file only if the content differs from the existing file.
  *  Returns true when the file was written (content changed or file was new). */
@@ -25,24 +26,58 @@ export function writeIfChanged(filePath: string, content: string): boolean {
   return true;
 }
 
+/**
+ * Names of the cuttlefish-emitted C/C++ sources under src/ (top level only,
+ * matching the old `src/*.cpp src/*.c` glob; sorted so the generated
+ * CMakeLists.txt is stable across readdir orderings). Empty when no sources
+ * exist yet (first prepare call).
+ */
+function listEmittedSources(srcDir: string): string[] {
+  if (!existsSync(srcDir)) return [];
+  const names = readdirSync(srcDir).filter((name) => name.endsWith('.cpp') || name.endsWith('.c'));
+  names.sort();
+  return names;
+}
+
 /**
  * Concatenate all emitted source under src/ so the scaffold can detect which
  * peripherals the program actually uses. The cuttlefish lowering emits
  * well-known driver API tokens (adc_read, spi_transceive, bt_*, …), so scanning
- * the post-transpile source is an authoritative usage signal — and it keeps the
- * scaffold self-contained (no need to thread analysis through the toolchain
+ * the post-transpile source is an authoritative usage signal — and it keeps
+ * the scaffold self-contained (no need to thread analysis through the toolchain
  * contract). Returns '' when no sources exist yet (first prepare call).
  */
 function readEmittedSources(srcDir: string): string {
-  if (!existsSync(srcDir)) return '';
   let out = '';
-  for (const name of readdirSync(srcDir)) {
-    if (name.endsWith('.cpp') || name.endsWith('.c')) {
-      try {
-        out += readFileSync(join(srcDir, name), 'utf8');
-      } catch {
-        // ignore unreadable files
+  for (const name of listEmittedSources(srcDir)) {
+    try {
+      out += readFileSync(join(srcDir, name), 'utf8');
+    } catch {
+      // ignore unreadable files
+    }
+  }
+  return out;
+}
+
+/**
+ * Append cuttlefish library packages' devicetree overlay fragments to the
+ * generated overlay. Library entries come from the transpiler's libraries.json
+ * sidecar (next to the emitted sources) and are already gated on the
+ * library's include token appearing in the emitted sources — no re-detection.
+ * Fragments merge after the framework overlay so library nodes (e.g.
+ * @typecad/zephyr-esp32s3-rgb's WS2812 node on I2S0) layer over it.
+ */
+export function appendLibraryOverlayFragments(overlay: string, projectRoot: string): string {
+  let out = overlay;
+  for (const entry of readCuttlefishLibrarySidecar(join(projectRoot, 'src'))) {
+    if (!entry.overlay) continue;
+    try {
+      const fragment = readFileSync(entry.overlay, 'utf8').trim();
+      if (fragment.length > 0) {
+        out += (out.endsWith('\n') ? '' : '\n') + '\n' + fragment + '\n';
       }
+    } catch {
+      // best-effort; a missing fragment surfaces as a DT error
     }
   }
   return out;
@@ -120,8 +155,13 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
   let changed = false;
 
   // ── Root CMakeLists.txt ─────────────────────────────────────────────────
-  // The canonical Zephyr CMake application. GLOB src/*.cpp so future multi-
-  // file emits are picked up automatically; cuttlefish owns the file contents.
+  // The canonical Zephyr CMake application. The emitted source list is
+  // explicit (no file(GLOB CONFIGURE_DEPENDS ...)): CONFIGURE_DEPENDS puts a
+  // cmake.verify_globs step in the ninja graph that spawns CMake to re-check
+  // the glob on every build, and the scaffold already rewrites this file via
+  // writeIfChanged whenever the emitted file set changes — which flips
+  // configChanged and reconfigures with the new list baked in.
+  const sourceFiles = listEmittedSources(srcDir);
   const cmakeLists = [
     '# Auto-generated by @typecad/framework-zephyr from cuttlefish.config.ts.',
     'cmake_minimum_required(VERSION 3.20.0)',
@@ -130,12 +170,18 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
     '',
     'project(zephyr_app)',
     '',
-    '# Collect cuttlefish-emitted sources. CONFIGURE_DEPENDS makes CMake re-',
-    '# check the glob when the source set changes (e.g. the transpiler removes',
-    '# a stale entry), instead of linking a file list from the last configure.',
-    'file(GLOB app_sources CONFIGURE_DEPENDS src/*.cpp src/*.c)',
-    '',
-    'target_sources(app PRIVATE ${app_sources})',
+    ...(sourceFiles.length > 0
+      ? [
+        '# Cuttlefish-emitted sources. This list is regenerated whenever the',
+        '# emitted file set changes (the scaffold rewrites CMakeLists.txt).',
+        'target_sources(app PRIVATE',
+        ...sourceFiles.map((name) => `  src/${name}`),
+        ')',
+      ]
+      : [
+        '# No emitted sources yet — the scaffold regenerates this list on the',
+        '# next compile once src/ contains .cpp/.c files.',
+      ]),
     // When PSRAM is configured, define BOARD_HAS_PSRAM so the UI runtime's
     // PSRAM canvas allocator (ui_create_canvas_best) is compiled in.
     ...(psram ? ['', '# PSRAM enabled: activate the runtime PSRAM canvas paths.', 'target_compile_definitions(app PRIVATE BOARD_HAS_PSRAM)', ''] : ['']),
@@ -184,6 +230,24 @@ export function scaffoldZephyrProject(projectRoot: string, debug = false, userKc
     if (userKconfig && userKconfig.hasOwnProperty(sym)) continue;
     prjConf.push(`${sym}=${val}`);
   }
+  // ── Cuttlefish library packages ─────────────────────────────────────────
+  // Libraries the program imports (recorded in the transpiler's libraries.json
+  // sidecar, next to the emitted sources) contribute their manifest's kconfig
+  // lines — e.g. @typecad/zephyr-esp32s3-rgb contributes CONFIG_LED_STRIP.
+  // Sidecar entries are already gated on the library's include token
+  // appearing in the emitted sources, so no re-detection here. User
+  // zephyr.kconfig overrides still win.
+  const libraryEntries = readCuttlefishLibrarySidecar(srcDir);
+  if (libraryEntries.length > 0) {
+    prjConf.push('', '# Library packages (cuttlefish.library.json contributions).');
+    for (const entry of libraryEntries) {
+      for (const line of entry.kconfig) {
+        const sym = line.split('=')[0];
+        if (userKconfig && sym !== undefined && userKconfig.hasOwnProperty(sym)) continue;
+        prjConf.push(line);
+      }
+    }
+  }
   // Emit user-specified Kconfig from cuttlefish.config.ts zephyr.kconfig.
   // These override any matching auto-detected symbol (skipped above).
   if (userKconfig) {