Add --verbose, --concurrency, --clean options

Author: kraenhansen

.changeset/big-plums-write.md

@@ -0,0 +1,5 @@
+---
+"ferric-cli": patch
+---
+
+Add --verbose, --concurrency, --clean options

packages/ferric/src/build.ts

@@ -1,5 +1,6 @@
 import path from "node:path";
 import fs from "node:fs";
+import os from "node:os";
 
 import {
   chalk,
@@ -9,6 +10,8 @@ import {
   assertFixable,
   wrapAction,
   prettyPath,
+  pLimit,
+  spawn,
 } from "@react-native-node-api/cli-utils";
 
 import {
@@ -85,6 +88,10 @@ function getDefaultTargets() {
 const targetOption = new Option("--target <target...>", "Target triple")
   .choices(ALL_TARGETS)
   .default(getDefaultTargets());
+const cleanOption = new Option(
+  "--clean",
+  "Delete the target directory before building",
+).default(false);
 const appleTarget = new Option("--apple", "Use all Apple targets");
 const androidTarget = new Option("--android", "Use all Android targets");
 const ndkVersionOption = new Option(
@@ -112,28 +119,61 @@ const appleBundleIdentifierOption = new Option(
   "Unique CFBundleIdentifier used for Apple framework artifacts",
 ).default(undefined, "com.callstackincubator.node-api.{libraryName}");
 
+const concurrencyOption = new Option(
+  "--concurrency <limit>",
+  "Limit the number of concurrent tasks",
+)
+  .argParser((value) => parseInt(value, 10))
+  .default(
+    os.availableParallelism(),
+    `${os.availableParallelism()} or 1 when verbose is enabled`,
+  );
+
+const verboseOption = new Option(
+  "--verbose",
+  "Print more output from underlying compiler & tools",
+).default(process.env.CI ? true : false, `false in general and true on CI`);
+
 export const buildCommand = new Command("build")
   .description("Build Rust Node-API module")
   .addOption(targetOption)
+  .addOption(cleanOption)
   .addOption(appleTarget)
   .addOption(androidTarget)
   .addOption(ndkVersionOption)
   .addOption(outputPathOption)
   .addOption(configurationOption)
   .addOption(xcframeworkExtensionOption)
   .addOption(appleBundleIdentifierOption)
+  .addOption(concurrencyOption)
+  .addOption(verboseOption)
   .action(
     wrapAction(
       async ({
         target: targetArg,
+        clean,
         apple,
         android,
         ndkVersion,
         output: outputPath,
         configuration,
         xcframeworkExtension,
         appleBundleIdentifier,
+        concurrency,
+        verbose,
       }) => {
+        if (clean) {
+          await oraPromise(
+            () => spawn("cargo", ["clean"], { outputMode: "buffered" }),
+            {
+              text: "Cleaning target directory",
+              successText: "Cleaned target directory",
+              failText: (error) => `Failed to clean target directory: ${error}`,
+            },
+          );
+        }
+        // Force a limit of 1 concurrent task to avoid interleaving output
+        const limit = pLimit(verbose ? 1 : concurrency);
         const targets = new Set([...targetArg]);
         if (apple) {
           for (const target of APPLE_TARGETS) {
@@ -180,30 +220,40 @@ export const buildCommand = new Command("build")
           targets.size +
           (targets.size === 1 ? " target" : " targets") +
           chalk.dim(" (" + [...targets].join(", ") + ")");
+
         const [appleLibraries, androidLibraries] = await oraPromise(
           Promise.all([
             Promise.all(
-              appleTargets.map(
-                async (target) =>
-                  [target, await build({ configuration, target })] as const,
+              appleTargets.map((target) =>
+                limit(
+                  async () =>
+                    [
+                      target,
+                      await build({ configuration, target, verbose }),
+                    ] as const,
+                ),
               ),
             ),
             Promise.all(
-              androidTargets.map(
-                async (target) =>
-                  [
-                    target,
-                    await build({
-                      configuration,
+              androidTargets.map((target) =>
+                limit(
+                  async () =>
+                    [
                       target,
-                      ndkVersion,
-                      androidApiLevel: ANDROID_API_LEVEL,
-                    }),
-                  ] as const,
+                      await build({
+                        configuration,
+                        target,
+                        verbose,
+                        ndkVersion,
+                        androidApiLevel: ANDROID_API_LEVEL,
+                      }),
+                    ] as const,
+                ),
               ),
             ),
           ]),
           {
+            isSilent: verbose,
             text: `Building ${targetsDescription}`,
             successText: `Built ${targetsDescription}`,
             failText: (error: Error) => `Failed to build: ${error.message}`,
@@ -225,11 +275,13 @@ export const buildCommand = new Command("build")
           );
 
           await oraPromise(
-            createAndroidLibsDirectory({
-              outputPath: androidLibsOutputPath,
-              libraries,
-              autoLink: true,
-            }),
+            limit(() =>
+              createAndroidLibsDirectory({
+                outputPath: androidLibsOutputPath,
+                libraries,
+                autoLink: true,
+              }),
+            ),
             {
               text: "Assembling Android libs directory",
               successText: `Android libs directory assembled into ${prettyPath(
@@ -243,14 +295,25 @@ export const buildCommand = new Command("build")
 
         if (appleLibraries.length > 0) {
           const libraryPaths = await combineLibraries(appleLibraries);
-          const frameworkPaths = await Promise.all(
-            libraryPaths.map((libraryPath) =>
-              // TODO: Pass true as `versioned` argument for -darwin targets
-              createAppleFramework({
-                libraryPath,
-                bundleIdentifier: appleBundleIdentifier,
-              }),
+
+          const frameworkPaths = await oraPromise(
+            Promise.all(
+              libraryPaths.map((libraryPath) =>
+                limit(() =>
+                  // TODO: Pass true as `versioned` argument for -darwin targets
+                  createAppleFramework({
+                    libraryPath,
+                    bundleIdentifier: appleBundleIdentifier,
+                  }),
+                ),
+              ),
             ),
+            {
+              text: "Creating Apple frameworks",
+              successText: `Created Apple frameworks`,
+              failText: ({ message }) =>
+                `Failed to create Apple frameworks: ${message}`,
+            },
           );
           const xcframeworkFilename = determineXCFrameworkFilename(
             frameworkPaths,

packages/ferric/src/cargo.ts

@@ -95,6 +95,7 @@ export function ensureCargo() {
 
 type BuildOptions = {
   configuration: "debug" | "release";
+  verbose: boolean;
 } & (
   | {
       target: AndroidTargetName;
@@ -109,7 +110,7 @@ type BuildOptions = {
 );
 
 export async function build(options: BuildOptions) {
-  const { target, configuration } = options;
+  const { target, configuration, verbose } = options;
   const args = ["build", "--target", target];
   if (configuration.toLowerCase() === "release") {
     args.push("--release");
@@ -123,7 +124,8 @@ export async function build(options: BuildOptions) {
     args.push("-Z", "build-std=std,panic_abort");
   }
   await spawn("cargo", args, {
-    outputMode: "buffered",
+    outputMode: verbose ? "inherit" : "buffered",
+    outputPrefix: verbose ? chalk.dim(`[${target}]`) : undefined,
     env: {
       ...process.env,
       ...getTargetEnvironmentVariables(options),