Add --verbose option to cmake-rn (#130)

* Add verbose option

* Upgrading bufout to not fail when flushing in verbose mode

Author: kraenhansen

package-lock.json

@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@commander-js/extra-typings": "^13.1.0",
-    "bufout": "^0.3.1",
+    "bufout": "^0.3.2",
     "chalk": "^5.4.1",
     "cmake-js": "^7.3.1",
     "commander": "^13.1.0",

packages/cmake-rn/package.json

@@ -42,6 +42,11 @@ const DEFAULT_NDK_VERSION = "27.1.12297006";
 
 // TODO: Add automatic ccache support
 
+const verboseOption = new Option(
+  "--verbose",
+  "Print more output during the build"
+).default(process.env.CI === "true");
+
 const sourcePathOption = new Option(
   "--source <path>",
   "Specify the source directory containing a CMakeLists.txt file"
@@ -100,6 +105,7 @@ const xcframeworkExtensionOption = new Option(
 
 export const program = new Command("cmake-rn")
   .description("Build React Native Node API modules with CMake")
+  .addOption(verboseOption)
   .addOption(sourcePathOption)
   .addOption(configurationOption)
   .addOption(tripletOption)
@@ -163,6 +169,7 @@ export const program = new Command("cmake-rn")
       // Configure every triplet project
       await oraPromise(Promise.all(tripletContext.map(configureProject)), {
         text: "Configuring projects",
+        isSilent: globalContext.verbose,
         successText: "Configured projects",
         failText: ({ message }) => `Failed to configure projects: ${message}`,
       });
@@ -182,6 +189,7 @@ export const program = new Command("cmake-rn")
         ),
         {
           text: "Building projects",
+          isSilent: globalContext.verbose,
           successText: "Built projects",
           failText: ({ message }) => `Failed to build projects: ${message}`,
         }
@@ -365,8 +373,14 @@ function getBuildArgs(triplet: SupportedTriplet) {
 }
 
 async function configureProject(context: TripletScopedContext) {
-  const { triplet, tripletBuildPath, source, ndkVersion, weakNodeApiLinkage } =
-    context;
+  const {
+    verbose,
+    triplet,
+    tripletBuildPath,
+    source,
+    ndkVersion,
+    weakNodeApiLinkage,
+  } = context;
   await spawn(
     "cmake",
     [
@@ -381,13 +395,14 @@ async function configureProject(context: TripletScopedContext) {
       }),
     ],
     {
-      outputMode: "buffered",
+      outputMode: verbose ? "inherit" : "buffered",
+      outputPrefix: verbose ? chalk.dim(`[${triplet}] `) : undefined,
     }
   );
 }
 
 async function buildProject(context: TripletScopedContext) {
-  const { triplet, tripletBuildPath, configuration } = context;
+  const { verbose, triplet, tripletBuildPath, configuration } = context;
   await spawn(
     "cmake",
     [
@@ -399,7 +414,8 @@ async function buildProject(context: TripletScopedContext) {
       ...getBuildArgs(triplet),
     ],
     {
-      outputMode: "buffered",
+      outputMode: verbose ? "inherit" : "buffered",
+      outputPrefix: verbose ? chalk.dim(`[${triplet}] `) : undefined,
     }
   );
 }

packages/cmake-rn/src/cli.ts

@@ -18,7 +18,7 @@
   "dependencies": {
     "@napi-rs/cli": "3.0.0-alpha.80",
     "@commander-js/extra-typings": "^13.1.0",
-    "bufout": "^0.3.1",
+    "bufout": "^0.3.2",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "ora": "^8.2.0"

packages/ferric/package.json

@@ -76,7 +76,7 @@
   "license": "MIT",
   "dependencies": {
     "@commander-js/extra-typings": "^13.1.0",
-    "bufout": "^0.3.1",
+    "bufout": "^0.3.2",
     "chalk": "^5.4.1",
     "commander": "^13.1.0",
     "ora": "^8.2.0",