@rnx-kit/cli 0.12.0 → 0.12.3

package/react-native.config.js

@@ -69,7 +69,12 @@ module.exports = {
         },
         {
           name: "--experimental-tree-shake [boolean]",
-          description: "Experimental: Enable tree shaking.",
+          description: "Deprecated. Use --tree-shake [boolean] instead.",
+          parse: parseBoolean,
+        },
+        {
+          name: "--tree-shake [boolean]",
+          description: "Enable tree shaking.",
           parse: parseBoolean,
         },
         {

package/src/bundle/metro.ts

@@ -75,7 +75,7 @@ export async function metroBundle(
     bundleConfig.detectCyclicDependencies,
     bundleConfig.detectDuplicateDependencies,
     bundleConfig.typescriptValidation ? typescriptValidationOptions : false,
-    bundleConfig.experimental_treeShake
+    bundleConfig.treeShake
   );
 
   const metroBundleArgs = createMetroBundleArgs(bundleConfig);

package/src/bundle/overrides.ts

@@ -10,7 +10,7 @@ export type KitBundleConfigOverrides = {
   bundleEncoding?: BundleArgs["bundleEncoding"];
   sourcemapOutput?: string;
   sourcemapSourcesRoot?: string;
-  experimentalTreeShake?: boolean;
+  treeShake?: boolean;
 };
 
 /**
@@ -33,7 +33,7 @@ export function applyKitBundleConfigOverrides(
       "bundleEncoding",
       "sourcemapOutput",
       "sourcemapSourcesRoot",
-      "experimentalTreeShake",
+      "treeShake",
     ],
     [
       "entryPath",
@@ -43,7 +43,7 @@ export function applyKitBundleConfigOverrides(
       "bundleEncoding",
       "sourcemapOutput",
       "sourcemapSourcesRoot",
-      "experimental_treeShake",
+      "treeShake",
     ]
   );
   if (overridesToApply) {

package/src/bundle.ts

@@ -17,7 +17,8 @@ export type CLIBundleOptions = {
   bundleEncoding?: BundleArgs["bundleEncoding"];
   dev: boolean;
   minify?: boolean;
-  experimentalTreeShake?: boolean;
+  experimentalTreeShake?: boolean; // Deprecated
+  treeShake?: boolean;
   maxWorkers?: number;
   sourcemapOutput?: string;
   sourcemapSourcesRoot?: string;
@@ -30,6 +31,17 @@ export async function rnxBundle(
   cliConfig: CLIConfig,
   cliOptions: CLIBundleOptions
 ): Promise<void> {
+  // experimentalTreeShake is deprecated. Only use it when treeShake is not specified.
+  if (cliOptions.experimentalTreeShake !== undefined) {
+    console.warn(
+      "Warning: The command-line parameter '--experimental-tree-shake' is deprecated. Use `--tree-shake` instead."
+    );
+    if (cliOptions.treeShake === undefined) {
+      cliOptions.treeShake = cliOptions.experimentalTreeShake;
+    }
+    delete cliOptions.experimentalTreeShake;
+  }
+
   const metroConfig = await loadMetroConfig(cliConfig, cliOptions);
 
   const kitBundleConfigs = getKitBundleConfigs(

package/src/clean.ts

@@ -1,10 +1,9 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import { spawn } from "child_process";
-import { existsSync as fileExists } from "fs";
-import fs from "fs/promises";
+import * as fs from "fs-extra";
 import ora from "ora";
-import os from "os";
-import path from "path";
+import * as os from "os";
+import * as path from "path";
 
 type Args = {
   include?: string;
@@ -27,7 +26,7 @@ export async function rnxClean(
   cliOptions: Args
 ): Promise<void> {
   const projectRoot = cliOptions.projectRoot ?? process.cwd();
-  if (!fileExists(projectRoot)) {
+  if (!fs.existsSync(projectRoot)) {
     throw new Error(`Invalid path provided! ${projectRoot}`);
   }
 
@@ -152,7 +151,7 @@ export async function rnxClean(
 }
 
 function cleanDir(path: string): Promise<void> {
-  if (!fileExists(path)) {
+  if (!fs.existsSync(path)) {
     return Promise.resolve();
   }
 
@@ -163,7 +162,7 @@ function findPath(startPath: string, files: string[]): string | undefined {
   // TODO: Find project files via `@react-native-community/cli`
   for (const file of files) {
     const filename = path.resolve(startPath, file);
-    if (fileExists(filename)) {
+    if (fs.existsSync(filename)) {
       return filename;
     }
   }

package/src/copy-assets.ts

@@ -2,7 +2,11 @@ import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import { error, info, warn } from "@rnx-kit/console";
 import { isNonEmptyArray } from "@rnx-kit/tools-language/array";
 import type { PackageManifest } from "@rnx-kit/tools-node/package";
-import { findPackageDir, readPackage } from "@rnx-kit/tools-node/package";
+import {
+  findPackageDependencyDir,
+  findPackageDir,
+  readPackage,
+} from "@rnx-kit/tools-node/package";
 import type { AllPlatforms } from "@rnx-kit/tools-react-native";
 import { parsePlatform } from "@rnx-kit/tools-react-native";
 import { spawnSync } from "child_process";
@@ -11,9 +15,17 @@ import * as os from "os";
 import * as path from "path";
 
 export type AndroidArchive = {
-  targetName: string;
+  targetName?: string;
   version?: string;
   output?: string;
+  android?: {
+    androidPluginVersion?: string;
+    compileSdkVersion?: number;
+    defaultConfig?: {
+      minSdkVersion?: number;
+      targetSdkVersion?: number;
+    };
+  };
 };
 
 export type NativeAssets = {
@@ -44,6 +56,15 @@ export type AssetsConfig = {
   getAssets?: (context: Context) => Promise<NativeAssets>;
 };
 
+const defaultAndroidConfig: Required<Required<AndroidArchive>["android"]> = {
+  androidPluginVersion: "7.1.3",
+  compileSdkVersion: 31,
+  defaultConfig: {
+    minSdkVersion: 23,
+    targetSdkVersion: 29,
+  },
+};
+
 function ensureOption(options: Options, opt: string, flag = opt) {
   if (options[opt] == null) {
     error(`Missing required option: --${flag}`);
@@ -61,6 +82,12 @@ function findGradleProject(projectRoot: string): string | undefined {
   return undefined;
 }
 
+function gradleTargetName(packageName: string): string {
+  return (
+    packageName.startsWith("@") ? packageName.slice(1) : packageName
+  ).replace(/[^\w\-.]+/g, "_");
+}
+
 function isAssetsConfig(config: unknown): config is AssetsConfig {
   return typeof config === "object" && config !== null && "getAssets" in config;
 }
@@ -69,8 +96,13 @@ function keysOf(record: Record<string, unknown> | undefined): string[] {
   return record ? Object.keys(record) : [];
 }
 
-function versionOf(pkgName: string): string {
-  const { version } = readPackage(`${pkgName}/package.json`);
+export function versionOf(pkgName: string): string {
+  const packageDir = findPackageDependencyDir(pkgName);
+  if (!packageDir) {
+    throw new Error(`Could not find module '${pkgName}'`);
+  }
+
+  const { version } = readPackage(packageDir);
   return version;
 }
 
@@ -79,13 +111,19 @@ function getAndroidPaths(
   packageName: string,
   { targetName, version, output }: AndroidArchive
 ) {
-  const projectRoot = path.dirname(
-    require.resolve(`${packageName}/package.json`)
-  );
+  const projectRoot = findPackageDependencyDir(packageName);
+  if (!projectRoot) {
+    throw new Error(`Could not find module '${packageName}'`);
+  }
+
+  const gradleFriendlyName = targetName || gradleTargetName(packageName);
+  const aarVersion = version || versionOf(packageName);
 
   switch (packageName) {
     case "hermes-engine":
       return {
+        targetName: gradleFriendlyName,
+        version: aarVersion,
         projectRoot,
         output: path.join(projectRoot, "android", "hermes-release.aar"),
         destination: path.join(
@@ -97,6 +135,8 @@ function getAndroidPaths(
 
     case "react-native":
       return {
+        targetName: gradleFriendlyName,
+        version: aarVersion,
         projectRoot,
         output: path.join(projectRoot, "android"),
         destination: path.join(
@@ -109,6 +149,8 @@ function getAndroidPaths(
     default: {
       const androidProject = findGradleProject(projectRoot);
       return {
+        targetName: gradleFriendlyName,
+        version: aarVersion,
         projectRoot,
         androidProject,
         output:
@@ -119,19 +161,19 @@ function getAndroidPaths(
               "build",
               "outputs",
               "aar",
-              `${targetName}-release.aar`
+              `${gradleFriendlyName}-release.aar`
             )),
         destination: path.join(
           context.options.assetsDest,
           "aar",
-          `${targetName}-${version || versionOf(packageName)}.aar`
+          `${gradleFriendlyName}-${aarVersion}.aar`
         ),
       };
     }
   }
 }
 
-async function assembleAarBundle(
+export async function assembleAarBundle(
   context: Context,
   packageName: string,
   { aar }: NativeAssets
@@ -149,55 +191,136 @@ async function assembleAarBundle(
     return;
   }
 
-  const { androidProject, output } = getAndroidPaths(context, packageName, aar);
+  const { targetName, version, androidProject, output } = getAndroidPaths(
+    context,
+    packageName,
+    aar
+  );
   if (!androidProject || !output) {
     warn(`Skipped \`${packageName}\`: cannot find \`build.gradle\``);
     return;
   }
 
-  const { targetName, version, env, dependencies } = aar;
+  const { env: customEnv, dependencies, android } = aar;
+  const env = {
+    NODE_MODULES_PATH: path.join(process.cwd(), "node_modules"),
+    REACT_NATIVE_VERSION: versionOf("react-native"),
+    ...process.env,
+    ...customEnv,
+  };
+
+  const outputDir = path.join(context.options.assetsDest, "aar");
+  await fs.ensureDir(outputDir);
+
+  const dest = path.join(outputDir, `${targetName}-${version}.aar`);
+
   const targets = [`:${targetName}:assembleRelease`];
-  const targetsToCopy: [string, string][] = [];
-  if (dependencies) {
-    for (const [dependencyName, aar] of Object.entries(dependencies)) {
-      const { output, destination } = getAndroidPaths(
-        context,
-        dependencyName,
-        aar
-      );
-      if (output) {
-        if (!fs.existsSync(output)) {
-          targets.push(`:${aar.targetName}:assembleRelease`);
-          targetsToCopy.push([output, destination]);
-        } else if (!fs.existsSync(destination)) {
-          targetsToCopy.push([output, destination]);
+  const targetsToCopy: [string, string][] = [[output, dest]];
+
+  const settings = path.join(androidProject, "settings.gradle");
+  if (fs.existsSync(settings)) {
+    if (dependencies) {
+      for (const [dependencyName, aar] of Object.entries(dependencies)) {
+        const { targetName, output, destination } = getAndroidPaths(
+          context,
+          dependencyName,
+          aar
+        );
+        if (output) {
+          if (!fs.existsSync(output)) {
+            targets.push(`:${targetName}:assembleRelease`);
+            targetsToCopy.push([output, destination]);
+          } else if (!fs.existsSync(destination)) {
+            targetsToCopy.push([output, destination]);
+          }
         }
       }
     }
-  }
 
-  // Run only one Gradle task at a time
-  spawnSync(gradlew, targets, {
-    cwd: androidProject,
-    stdio: "inherit",
-    env: {
-      ENABLE_HERMES: "true",
-      NODE_MODULES_PATH: path.join(process.cwd(), "node_modules"),
-      REACT_NATIVE_VERSION: versionOf("react-native"),
-      ...process.env,
-      ...env,
-    },
-  });
+    // Run only one Gradle task at a time
+    spawnSync(gradlew, targets, { cwd: androidProject, stdio: "inherit", env });
+  } else {
+    const reactNativePath = findPackageDependencyDir("react-native");
+    if (!reactNativePath) {
+      throw new Error("Could not find 'react-native'");
+    }
 
-  const destination = path.join(context.options.assetsDest, "aar");
-  await fs.ensureDir(destination);
+    const buildDir = path.join(
+      process.cwd(),
+      "node_modules",
+      ".rnx-gradle-build",
+      targetName
+    );
+
+    const compileSdkVersion =
+      android?.compileSdkVersion ?? defaultAndroidConfig.compileSdkVersion;
+    const minSdkVersion =
+      android?.defaultConfig?.minSdkVersion ??
+      defaultAndroidConfig.defaultConfig.minSdkVersion;
+    const targetSdkVersion =
+      android?.defaultConfig?.targetSdkVersion ??
+      defaultAndroidConfig.defaultConfig.targetSdkVersion;
+    const androidPluginVersion =
+      android?.androidPluginVersion ??
+      defaultAndroidConfig.androidPluginVersion;
+    const buildRelativeReactNativePath = path.relative(
+      buildDir,
+      reactNativePath
+    );
+
+    const buildGradle = [
+      "buildscript {",
+      "  ext {",
+      `      compileSdkVersion = ${compileSdkVersion}`,
+      `      minSdkVersion = ${minSdkVersion}`,
+      `      targetSdkVersion = ${targetSdkVersion}`,
+      `      androidPluginVersion = "${androidPluginVersion}"`,
+      "  }",
+      "",
+      "  repositories {",
+      "      mavenCentral()",
+      "      google()",
+      "  }",
+      "",
+      "  dependencies {",
+      '      classpath("com.android.tools.build:gradle:${project.ext.androidPluginVersion}")',
+      "  }",
+      "}",
+      "",
+      "allprojects {",
+      "  repositories {",
+      "      maven {",
+      "          // All of React Native (JS, Obj-C sources, Android binaries) is installed from npm",
+      `          url("\${rootDir}/${buildRelativeReactNativePath}/android")`,
+      "      }",
+      "      mavenCentral()",
+      "      google()",
+      "  }",
+      "}",
+      "",
+    ].join("\n");
+
+    const gradleProperties = "android.useAndroidX=true\n";
+
+    const settingsGradle = [
+      `include(":${targetName}")`,
+      `project(":${targetName}").projectDir = file("${androidProject}")`,
+      "",
+    ].join("\n");
+
+    await fs.ensureDir(buildDir);
+    await fs.writeFile(path.join(buildDir, "build.gradle"), buildGradle);
+    await fs.writeFile(
+      path.join(buildDir, "gradle.properties"),
+      gradleProperties
+    );
+    await fs.writeFile(path.join(buildDir, "settings.gradle"), settingsGradle);
+
+    // Run only one Gradle task at a time
+    spawnSync(gradlew, targets, { cwd: buildDir, stdio: "inherit", env });
+  }
 
-  const aarVersion = version || versionOf(packageName);
-  const dest = path.join(destination, `${targetName}-${aarVersion}.aar`);
-  await Promise.all([
-    fs.copy(output, dest),
-    ...targetsToCopy.map(([src, dest]) => fs.copy(src, dest)),
-  ]);
+  await Promise.all(targetsToCopy.map(([src, dest]) => fs.copy(src, dest)));
 }
 
 async function copyFiles(files: unknown, destination: string): Promise<void> {

package/src/metro-config.ts

@@ -109,14 +109,14 @@ const emptySerializerHook = (_graph: Graph, _delta: DeltaResult): void => {
  * @param detectCyclicDependencies When true, cyclic dependency checking is enabled with a default set of options. Otherwise the object allows for fine-grained control over the detection process.
  * @param detectDuplicateDependencies When true, duplicate dependency checking is enabled with a default set of options. Otherwise, the object allows for fine-grained control over the detection process.
  * @param typescriptValidation When true, TypeScript type-checking is enabled with a default set of options. Otherwise, the object allows for fine-grained control over the type-checking process.
- * @param experimental_treeShake When true, experimental tree shaking is enabled.
+ * @param treeShake When true, tree shaking is enabled.
  */
 export function customizeMetroConfig(
   metroConfigReadonly: InputConfigT,
   detectCyclicDependencies: boolean | CyclicDetectorOptions,
   detectDuplicateDependencies: boolean | DuplicateDetectorOptions,
   typescriptValidation: boolean | TypeScriptValidationOptions,
-  experimental_treeShake: boolean
+  treeShake: boolean
 ): void {
   //  We will be making changes to the Metro configuration. Coerce from a
   //  type with readonly props to a type where the props are writeable.
@@ -134,7 +134,7 @@ export function customizeMetroConfig(
     plugins.push(CyclicDependencies());
   }
 
-  if (experimental_treeShake) {
+  if (treeShake) {
     metroConfig.serializer.customSerializer = MetroSerializerEsbuild(plugins);
     Object.assign(metroConfig.transformer, esbuildTransformerConfig);
   } else if (plugins.length > 0) {

package/src/start.ts

@@ -131,7 +131,7 @@ export async function rnxStart(
     serverConfig.detectCyclicDependencies,
     serverConfig.detectDuplicateDependencies,
     serverConfig.typescriptValidation ? typescriptValidationOptions : false,
-    serverConfig.experimental_treeShake
+    serverConfig.treeShake
   );
 
   // create middleware -- a collection of plugins which handle incoming

package/src/test.ts

@@ -1,7 +1,7 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
+import { findPackageDependencyDir } from "@rnx-kit/tools-node";
 import { parsePlatform } from "@rnx-kit/tools-react-native/platform";
 import { run as runJest } from "jest-cli";
-import path from "path";
 
 type Args = {
   platform: "android" | "ios" | "macos" | "windows" | "win32";
@@ -54,8 +54,8 @@ function jestOptions(): Options[] {
   //
   // To work around this, resolve `jest-cli` first, then use the resolved path
   // to import `./build/cli/args`.
-  const jestPath = require.resolve("jest-cli/package.json");
-  const { options } = require(`${path.dirname(jestPath)}/build/cli/args`);
+  const jestPath = findPackageDependencyDir("jest-cli") || "jest-cli";
+  const { options } = require(`${jestPath}/build/cli/args`);
 
   return Object.keys(options).map((option) => {
     const { default: defaultValue, description, type } = options[option];

package/test/__mocks__/child_process.js

@@ -0,0 +1,5 @@
+const child_process = jest.createMockFromModule("child_process");
+
+child_process.spawnSync(() => undefined);
+
+module.exports = child_process;

package/test/__mocks__/fs-extra.js

@@ -14,7 +14,9 @@ fs.__toJSON = () => vol.toJSON();
 
 fs.copy = (...args) => vol.promises.copyFile(...args);
 fs.ensureDir = (dir) => vol.promises.mkdir(dir, { recursive: true });
+fs.existsSync = (...args) => vol.existsSync(...args);
 fs.pathExists = (...args) => Promise.resolve(vol.existsSync(...args));
 fs.readFile = (...args) => vol.promises.readFile(...args);
+fs.writeFile = (...args) => vol.promises.writeFile(...args);
 
 module.exports = fs;

package/test/__mocks__/fs.js

@@ -0,0 +1,19 @@
+const fs = jest.createMockFromModule("fs");
+
+const { vol } = require("memfs");
+
+/** @type {(newMockFiles: { [filename: string]: string }) => void} */
+fs.__setMockFiles = (files) => {
+  vol.reset();
+  vol.fromJSON(files);
+};
+
+fs.__toJSON = () => vol.toJSON();
+
+fs.lstat = (...args) => Promise.resolve(vol.lstat(...args));
+fs.lstatSync = (...args) => vol.lstatSync(...args);
+fs.readFileSync = (...args) => vol.readFileSync(...args);
+fs.stat = (...args) => Promise.resolve(vol.stat(...args));
+fs.statSync = (...args) => vol.statSync(...args);
+
+module.exports = fs;

package/test/bundle/kit-config.test.ts

@@ -80,7 +80,7 @@ describe("CLI > Bundle > Kit Config > getKitBundleConfigs", () => {
     detectCyclicDependencies: true,
     detectDuplicateDependencies: true,
     typescriptValidation: true,
-    experimental_treeShake: true,
+    treeShake: true,
     targets: ["ios", "android"],
     platforms: {
       ios: {
@@ -123,4 +123,26 @@ describe("CLI > Bundle > Kit Config > getKitBundleConfigs", () => {
       platform: "android",
     });
   });
+
+  test("uses deprecated experimental_treeShake", () => {
+    const d: Record<string, unknown> = { ...definition };
+    delete d.treeShake;
+    d.experimental_treeShake = true;
+    rnxKitConfig.__setMockConfig({
+      bundle: {
+        ...d,
+      },
+    });
+    consoleWarnSpy.mockReset();
+
+    const kitBundleConfigs = getKitBundleConfigs(undefined, "ios");
+    expect(kitBundleConfigs[0].treeShake).toBe(true);
+    expect(consoleWarnSpy).toBeCalledTimes(1);
+    expect(consoleWarnSpy).toBeCalledWith(
+      expect.stringContaining("deprecated")
+    );
+    expect(consoleWarnSpy).toBeCalledWith(
+      expect.stringContaining("experimental_treeShake")
+    );
+  });
 });

package/test/bundle/metro.test.ts

@@ -8,7 +8,7 @@ describe("CLI > Bundle > Metro > createMetroBundleArgs", () => {
     detectCyclicDependencies: true,
     detectDuplicateDependencies: true,
     typescriptValidation: true,
-    experimental_treeShake: true,
+    treeShake: true,
     entryPath: "out/entry.js",
     distPath: "out",
     assetsPath: "out/assets",

package/test/bundle/overrides.test.ts

@@ -7,7 +7,7 @@ describe("CLI > Bundle > Overrides > applyKitBundleConfigOverrides", () => {
     detectCyclicDependencies: true,
     detectDuplicateDependencies: true,
     typescriptValidation: true,
-    experimental_treeShake: true,
+    treeShake: true,
     entryPath: "dist/index.js",
     distPath: "dist",
     assetsPath: "dist",
@@ -63,17 +63,7 @@ describe("CLI > Bundle > Overrides > applyKitBundleConfigOverrides", () => {
     testOverride("sourcemapSourcesRoot", "out");
   });
 
-  test("set experimental_treeShake using override experimentalTreeShake", () => {
-    const copy = { ...config };
-    applyKitBundleConfigOverrides(
-      {
-        experimentalTreeShake: true,
-      },
-      [copy]
-    );
-    expect(copy).toEqual({
-      ...config,
-      experimental_treeShake: true,
-    });
+  test("changes treeShake using an override", () => {
+    testOverride("treeShake", true);
   });
 });