Merge branch 'main' into kh/cmake-rn-error-early-on-arch-conflicts

Author: kraenhansen

.changeset/nice-crews-wonder.md

@@ -0,0 +1,8 @@
+---
+"gyp-to-cmake": patch
+"cmake-rn": patch
+"ferric-cli": patch
+"react-native-node-api": patch
+---
+
+Add support for source maps across CLI bins

.changeset/rich-weeks-cry.md

@@ -0,0 +1,7 @@
+---
+"cmake-rn": minor
+"ferric-cli": minor
+"react-native-node-api": minor
+---
+
+Add support for building versioned frameworks for Apple Darwin / macOS

.changeset/tall-snakes-beg.md

@@ -0,0 +1,5 @@
+---
+"cmake-rn": minor
+---
+
+Detect ccache and use when building for Android and Apple

.github/workflows/check.yml

@@ -4,7 +4,7 @@ env:
   # Version here should match the one in React Native template and packages/cmake-rn/src/cli.ts
   NDK_VERSION: 27.1.12297006
   # Building Hermes from source doesn't support CMake v4
-  CMAKE_VERSION: 3.31.6
+  CMAKE_VERSION: 4.2.2
   # Enabling the Gradle test on CI (disabled by default because it downloads a lot)
   ENABLE_GRADLE_TESTS: true
 
@@ -28,10 +28,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       # Set up JDK and Android SDK only because we need weak-node-api, to build ferric-example and to run the linting
       # TODO: Remove this once we have a way to run linting without building the native code
       - name: Set up JDK 17
@@ -71,10 +75,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
@@ -104,10 +112,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - run: npm ci
       - run: npm run build
       - name: Prepare weak-node-api
@@ -127,10 +139,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
@@ -151,7 +167,7 @@ jobs:
       - name: Run tests (iOS)
         run: npm run test:ios:allTests
         # TODO: Enable release mode when it works
-        # run: npm run test:ios -- --mode Release
+        # run: npm run test:ios:allTests -- --mode Release
         working-directory: apps/test-app
   test-macos:
     # Disabling this on main for now, as initializing the template takes a long time and
@@ -164,10 +180,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:
@@ -187,9 +207,17 @@ jobs:
       - run: npm run init-macos-test-app
       - run: pod install --project-directory=macos
         working-directory: apps/macos-test-app
-      - name: Run MacOS test app
-        run: npm run test:allTests -- --mode Release
+      - name: Bundle test app
+        run: npx react-native bundle --entry-file index.js --platform macos --dev false --minify false --bundle-output dist/main.macos.jsbundle --assets-dest dist/res
         working-directory: apps/macos-test-app
+      - name: Build test app
+        run: xcodebuild archive -workspace MacOSTestApp.xcworkspace -configuration Release -scheme MacOSTestApp-macOS -destination generic/platform="macOS" -archivePath ./build/macos-test-app.xcarchive | xcbeautify
+        working-directory: apps/macos-test-app/macos
+      - name: Run test app
+        run: npx mocha-remote --exit-on-error -- macos/build/macos-test-app.xcarchive/Products/Applications/MacOSTestApp.app/Contents/MacOS/MacOSTestApp
+        working-directory: apps/macos-test-app
+        env:
+          MOCHA_REMOTE_CONTEXT: allTests
   test-android:
     if: github.ref == 'refs/heads/main' || contains(github.event.pull_request.labels.*.name, 'Android 🤖')
     name: Test app (Android)
@@ -199,10 +227,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v4
         with:
@@ -283,10 +315,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:

.github/workflows/release.yml

@@ -21,10 +21,14 @@ jobs:
       - uses: actions/setup-node@v6
         with:
           node-version: lts/krypton
-      - name: Setup clang-format
+      - name: Setup cpp tools
         uses: aminya/setup-cpp@v1
         with:
           clang-format: true
+      - name: ccache
+        uses: hendrikmuhs/ccache-action@v1.2
+        with:
+          key: ${{ github.job }}-${{ runner.os }}
       - name: Set up JDK 17
         uses: actions/setup-java@v3
         with:

apps/test-app/metro.config.js

@@ -11,7 +11,7 @@ const config = makeMetroConfig({
   },
 });
 
-if (config.watchFolders.length === 0) {
+if (config.projectRoot.endsWith("macos-test-app")) {
   // This patch is needed to locate packages in the monorepo from the MacOS app
   // which is intentionally kept outside of the workspaces configuration to prevent
   // duplicate react-native version and pollution of the package lock.

eslint.config.js

@@ -11,6 +11,7 @@ export default tseslint.config(
     "**/dist/**",
     "**/build/**",
     "apps/test-app/ios/**",
+    "apps/macos-test-app/**",
     "packages/host/hermes/**",
     "packages/node-addon-examples/examples/**",
     "packages/ferric-example/ferric_example.js",

packages/cmake-rn/bin/cmake-rn.js

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
+#!/usr/bin/env -S node --enable-source-maps
 import "../dist/run.js";

packages/cmake-rn/src/ccache.ts

@@ -0,0 +1,13 @@
+import cp from "node:child_process";
+
+export function getCcachePath(): string | null {
+  const result = cp.spawnSync(
+    process.platform === "win32" ? "where" : "which",
+    ["ccache"],
+  );
+  if (result.status === 0) {
+    return result.stdout.toString().trim();
+  } else {
+    return null;
+  }
+}

packages/cmake-rn/src/cli.ts

@@ -20,12 +20,11 @@ import {
   platformHasTriplet,
 } from "./platforms.js";
 import { Platform } from "./platforms/types.js";
+import { getCcachePath } from "./ccache.js";
 
 // We're attaching a lot of listeners when spawning in parallel
 EventEmitter.defaultMaxListeners = 100;
 
-// TODO: Add automatic ccache support
-
 const verboseOption = new Option(
   "--verbose",
   "Print more output during the build",
@@ -125,6 +124,11 @@ const cmakeJsOption = new Option(
   "Define CMAKE_JS_* variables used for compatibility with cmake-js",
 ).default(false);
 
+const ccachePathOption = new Option(
+  "--ccache-path <path>",
+  "Specify the path to the ccache executable",
+).default(getCcachePath());
+
 let program = new Command("cmake-rn")
   .description("Build React Native Node API modules with CMake")
   .addOption(tripletOption)
@@ -139,7 +143,8 @@ let program = new Command("cmake-rn")
   .addOption(stripOption)
   .addOption(noAutoLinkOption)
   .addOption(noWeakNodeApiLinkageOption)
-  .addOption(cmakeJsOption);
+  .addOption(cmakeJsOption)
+  .addOption(ccachePathOption);
 
 for (const platform of platforms) {
   const allOption = new Option(
@@ -169,7 +174,14 @@ program = program.action(
       process.cwd(),
       expandTemplate(baseOptions.out, baseOptions),
     );
-    const { verbose, clean, source, out, build: buildPath } = baseOptions;
+    const {
+      verbose,
+      clean,
+      source,
+      out,
+      build: buildPath,
+      ccachePath,
+    } = baseOptions;
 
     assertFixable(
       fs.existsSync(path.join(source, "CMakeLists.txt")),
@@ -179,6 +191,10 @@ program = program.action(
       },
     );
 
+    if (ccachePath) {
+      console.log(`♻️ Using ccache: ${chalk.dim(ccachePath)}`);
+    }
+
     if (clean) {
       await fs.promises.rm(buildPath, { recursive: true, force: true });
     }
@@ -228,9 +244,16 @@ program = program.action(
         triplet,
         platform,
         async spawn(command: string, args: string[], cwd?: string) {
+          const outputPrefix = verbose ? chalk.dim(`[${triplet}] `) : undefined;
+          if (verbose) {
+            console.log(
+              `${outputPrefix}» ${command} ${args.map((arg) => chalk.dim(`${arg}`)).join(" ")}`,
+              cwd ? `(in ${chalk.dim(cwd)})` : "",
+            );
+          }
           await spawn(command, args, {
             outputMode: verbose ? "inherit" : "buffered",
-            outputPrefix: verbose ? chalk.dim(`[${triplet}] `) : undefined,
+            outputPrefix,
             cwd,
           });
         },