@rnx-kit/cli 1.0.1 → 1.1.0

package/README.md

@@ -334,8 +334,6 @@ The following commands route to `@react-native-community/cli`:
 
 <!-- References -->
 
-[@rnx-kit/align-deps]:
-  https://github.com/microsoft/rnx-kit/tree/main/packages/align-deps#readme
+[@rnx-kit/align-deps]: https://github.com/microsoft/rnx-kit/tree/main/packages/align-deps#readme
 [Metro]: https://facebook.github.io/metro
-[configuration]:
-  https://github.com/microsoft/rnx-kit/tree/main/packages/config#readme
+[configuration]: https://github.com/microsoft/rnx-kit/tree/main/packages/config#readme

package/lib/build.d.ts

@@ -26,10 +26,10 @@ export declare const rnxBuildCommand: {
         default: string;
         parse: typeof asDestination;
     } | {
-        default?: undefined;
         name: string;
         description: string;
         parse: typeof setCcacheDir;
+        default?: undefined;
     })[];
 };
 export {};

package/lib/bundle/hermes.js

@@ -119,7 +119,7 @@ function emitBytecode(cliConfig, input, sourcemap, options) {
         const compilerSourcemap = JSON.parse(fs.readFileSync(outputMap, options));
         const { composeSourceMaps } = (0, metro_1.requireModuleFromMetro)("metro-source-map");
         const composed = composeSourceMaps([packagerSourcemap, compilerSourcemap]);
-        (0, tools_filesystem_1.writeJSONFile)(outputMap, composed, 0);
+        (0, tools_filesystem_1.writeJSONFileSync)(outputMap, composed, 0);
     }
 }
 //# sourceMappingURL=hermes.js.map

package/lib/bundle/kit-config.d.ts

@@ -1,5 +1,5 @@
 import type { AllPlatforms } from "@rnx-kit/types-bundle-config";
-import type { CliPlatformBundleConfig } from "./types.ts";
+import type { CLIPlatformBundleConfig } from "./types.ts";
 /**
  * Get the list of target platforms for bundling.
  *
@@ -19,5 +19,5 @@ export declare function getTargetPlatforms(overridePlatform?: AllPlatforms, targ
  * @param overridePlatform Override platform, typically from the command-line. When given, this overrides the list of target platforms.
  * @returns Array of platform-specific bundle configurations
  */
-export declare function getCliPlatformBundleConfigs(id?: string, overridePlatform?: AllPlatforms, kitConfig?: import("@rnx-kit/types-kit-config").KitConfig | undefined): CliPlatformBundleConfig[];
+export declare function getCliPlatformBundleConfigs(id?: string, overridePlatform?: AllPlatforms, kitConfig?: import("@rnx-kit/types-kit-config").KitConfig | undefined): CLIPlatformBundleConfig[];
 //# sourceMappingURL=kit-config.d.ts.map

package/lib/bundle/metro.d.ts

@@ -1,7 +1,7 @@
 import { bundle } from "@rnx-kit/metro-service";
 import type { ConfigT } from "metro-config";
 import * as nodefs from "node:fs";
-import type { CliPlatformBundleConfig } from "./types.ts";
+import type { CLIPlatformBundleConfig } from "./types.ts";
 /**
  * Run the Metro bundler.
  *
@@ -14,5 +14,5 @@ import type { CliPlatformBundleConfig } from "./types.ts";
  * @param minify Optionally choose whether or not the bundle is minified. When not set, minification is controlled by the `dev` property.
  * @param output Output bundle format; defaults to plain JS
  */
-export declare function metroBundle(metroConfig: ConfigT, bundleConfig: CliPlatformBundleConfig, dev: boolean, minify?: boolean, output?: typeof bundle, fs?: typeof nodefs): Promise<void>;
+export declare function metroBundle(metroConfig: ConfigT, bundleConfig: CLIPlatformBundleConfig, dev: boolean, minify?: boolean, output?: typeof bundle, fs?: typeof nodefs): Promise<void>;
 //# sourceMappingURL=metro.d.ts.map

package/lib/bundle/metro.js

@@ -54,19 +54,6 @@ const metro_config_ts_1 = require("../helpers/metro-config.js");
  */
 async function metroBundle(metroConfig, bundleConfig, dev, minify, output = metro_service_1.bundle, fs = nodefs) {
     (0, console_1.info)(`Bundling ${bundleConfig.platform}...`);
-    if (!dev && bundleConfig.treeShake) {
-        if (minify != null) {
-            if (typeof bundleConfig.treeShake === "object") {
-                bundleConfig.treeShake.minify = minify;
-            }
-            else {
-                bundleConfig.treeShake = { minify };
-            }
-        }
-    }
-    else {
-        bundleConfig.treeShake = false;
-    }
     (0, metro_config_ts_1.customizeMetroConfig)(metroConfig, bundleConfig);
     const metroBundleArgs = {
         ...bundleConfig,
@@ -74,12 +61,12 @@ async function metroBundle(metroConfig, bundleConfig, dev, minify, output = metr
         minify,
     };
     // ensure all output directories exist
-    (0, tools_filesystem_1.ensureDir)(path.dirname(metroBundleArgs.bundleOutput), fs);
+    (0, tools_filesystem_1.ensureDirSync)(path.dirname(metroBundleArgs.bundleOutput), fs);
     if (metroBundleArgs.sourcemapOutput) {
-        (0, tools_filesystem_1.ensureDir)(path.dirname(metroBundleArgs.sourcemapOutput), fs);
+        (0, tools_filesystem_1.ensureDirSync)(path.dirname(metroBundleArgs.sourcemapOutput), fs);
     }
     if (metroBundleArgs.assetsDest) {
-        (0, tools_filesystem_1.ensureDir)(metroBundleArgs.assetsDest, fs);
+        (0, tools_filesystem_1.ensureDirSync)(metroBundleArgs.assetsDest, fs);
     }
     // create the bundle
     await output(metroBundleArgs, metroConfig);

package/lib/bundle/overrides.d.ts

@@ -1,13 +1,13 @@
-import type { CliPlatformBundleConfig } from "./types.ts";
-type BundleConfigOverrides = Partial<Pick<CliPlatformBundleConfig, "entryFile" | "bundleOutput" | "bundleEncoding" | "sourcemapOutput" | "sourcemapSourcesRoot" | "sourcemapUseAbsolutePath" | "assetsDest" | "treeShake" | "unstableTransformProfile" | "indexedRamBundle" | "hermes">>;
-export declare const overridableCommonBundleOptions: readonly (keyof BundleConfigOverrides)[];
+import type { CLIPlatformBundleConfig } from "./types.ts";
+export type BundleConfigOverrides = Partial<Pick<CLIPlatformBundleConfig, "assetsDest" | "bundleEncoding" | "bundleOutput" | "entryFile" | "hermes" | "indexedRamBundle" | "sourcemapOutput" | "sourcemapSourcesRoot" | "sourcemapUseAbsolutePath" | "treeShake" | "unstableTransformProfile">>;
+export declare const BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES: readonly (keyof BundleConfigOverrides)[];
 /**
- * Apply overrides, if any, to each rnx-kit bundle configuration. Overrides are applied in-place.
+ * Apply overrides from the command line, if any, to the bundle configuration.
+ * Overrides are applied in-place.
  *
+ * @param config Platform-specific bundle configuration; this is modified if any overrides are applied.
  * @param overrides Optional overrides to apply
- * @param configs Array of platform-specific bundle configurations. This is modified if any overrides are applied.
- * @param keys Config keys to pick from {@link overrides}
+ * @param keys Config keys to pick from {@link overrides}; defaults to {@link BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES}
  */
-export declare function applyBundleConfigOverrides(overrides: BundleConfigOverrides, configs: CliPlatformBundleConfig[], keys: (keyof BundleConfigOverrides)[]): void;
-export {};
+export declare function applyCommandLineOverrides(config: CLIPlatformBundleConfig, overrides: BundleConfigOverrides, flags?: readonly ("assetsDest" | "bundleEncoding" | "bundleOutput" | "entryFile" | "hermes" | "indexedRamBundle" | "sourcemapOutput" | "sourcemapSourcesRoot" | "sourcemapUseAbsolutePath" | "treeShake" | "unstableTransformProfile")[]): void;
 //# sourceMappingURL=overrides.d.ts.map

package/lib/bundle/overrides.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.overridableCommonBundleOptions = void 0;
-exports.applyBundleConfigOverrides = applyBundleConfigOverrides;
-const properties_1 = require("@rnx-kit/tools-language/properties");
-exports.overridableCommonBundleOptions = [
+exports.BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES = void 0;
+exports.applyCommandLineOverrides = applyCommandLineOverrides;
+// TODO: Add `hermes` and `treeShake` when we remove support for `ram-bundle`
+exports.BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES = [
     "assetsDest",
     "bundleEncoding",
     "bundleOutput",
@@ -14,17 +14,19 @@ exports.overridableCommonBundleOptions = [
     "unstableTransformProfile",
 ];
 /**
- * Apply overrides, if any, to each rnx-kit bundle configuration. Overrides are applied in-place.
+ * Apply overrides from the command line, if any, to the bundle configuration.
+ * Overrides are applied in-place.
  *
+ * @param config Platform-specific bundle configuration; this is modified if any overrides are applied.
  * @param overrides Optional overrides to apply
- * @param configs Array of platform-specific bundle configurations. This is modified if any overrides are applied.
- * @param keys Config keys to pick from {@link overrides}
+ * @param keys Config keys to pick from {@link overrides}; defaults to {@link BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES}
  */
-function applyBundleConfigOverrides(overrides, configs, keys) {
-    const overridesToApply = (0, properties_1.pickValues)(overrides, keys);
-    if (overridesToApply) {
-        for (const config of configs) {
-            Object.assign(config, overridesToApply);
+function applyCommandLineOverrides(config, overrides, flags = exports.BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES) {
+    for (const flag of flags) {
+        if (Object.hasOwn(overrides, flag)) {
+            const value = overrides[flag];
+            // @ts-expect-error TypeScript can't infer that `flag` is a key of `BundleConfigOverrides`, which is a subset of the keys of `CLIPlatformBundleConfig`
+            config[flag] = value;
         }
     }
 }

package/lib/bundle/types.d.ts

@@ -18,7 +18,7 @@ export type CLICommonBundleOptions = {
     resetCache?: boolean;
     config?: string;
 };
-export type CliPlatformBundleConfig = BundleParameters & Required<Pick<BundleParameters, "entryFile" | "bundleOutput" | "sourcemapUseAbsolutePath" | "treeShake" | "plugins">> & {
+export type CLIPlatformBundleConfig = BundleParameters & Required<Pick<BundleParameters, "entryFile" | "bundleOutput" | "sourcemapUseAbsolutePath" | "treeShake" | "plugins">> & {
     unstableTransformProfile?: TransformProfile;
     /**
      * Target platform for the bundle

package/lib/bundle.d.ts

@@ -2,6 +2,7 @@ import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import type { CLICommonBundleOptions } from "./bundle/types.ts";
 import { asBoolean } from "./helpers/parsers.ts";
 type CLIBundleOptions = CLICommonBundleOptions & {
+    metafile?: boolean | string;
     treeShake?: boolean;
 };
 export declare function rnxBundle(_argv: string[], cliConfig: CLIConfig, cliOptions: CLIBundleOptions): Promise<void>;

package/lib/bundle.js

@@ -9,16 +9,37 @@ const kit_config_ts_1 = require("./bundle/kit-config.js");
 const metro_ts_1 = require("./bundle/metro.js");
 const overrides_ts_1 = require("./bundle/overrides.js");
 const parsers_ts_1 = require("./helpers/parsers.js");
+function applyTreeShakingOverrides(bundleConfig, { dev, metafile, minify }) {
+    if (!dev && bundleConfig.treeShake) {
+        const treeShake = typeof bundleConfig.treeShake === "object" ? bundleConfig.treeShake : {};
+        if (metafile != null) {
+            treeShake.metafile =
+                typeof metafile === "string"
+                    ? metafile
+                    : `${bundleConfig.bundleOutput}.meta.json`;
+        }
+        if (minify != null) {
+            treeShake.minify = minify;
+        }
+        bundleConfig.treeShake = treeShake;
+    }
+    else {
+        bundleConfig.treeShake = false;
+    }
+}
 async function rnxBundle(_argv, cliConfig, cliOptions) {
     const metroConfig = await (0, metro_service_1.loadMetroConfig)(cliConfig, cliOptions);
     const bundleConfigs = (0, kit_config_ts_1.getCliPlatformBundleConfigs)(cliOptions.id, cliOptions.platform);
-    (0, overrides_ts_1.applyBundleConfigOverrides)(cliOptions, bundleConfigs, [
-        ...overrides_ts_1.overridableCommonBundleOptions,
+    const overridableFlags = [
+        ...overrides_ts_1.BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES,
         "hermes",
         "treeShake",
-    ]);
+    ];
     for (const bundleConfig of bundleConfigs) {
-        await (0, metro_ts_1.metroBundle)(metroConfig, bundleConfig, cliOptions.dev, cliOptions.minify);
+        (0, overrides_ts_1.applyCommandLineOverrides)(bundleConfig, cliOptions, overridableFlags);
+        applyTreeShakingOverrides(bundleConfig, cliOptions);
+        const { dev, minify } = cliOptions;
+        await (0, metro_ts_1.metroBundle)(metroConfig, bundleConfig, dev, minify);
         const { bundleOutput, hermes, sourcemapOutput } = bundleConfig;
         if (hermes) {
             (0, hermes_ts_1.emitBytecode)(cliConfig, bundleOutput, sourcemapOutput, hermes === true ? {} : hermes);
@@ -31,6 +52,10 @@ exports.rnxBundleCommand = {
     func: rnxBundle,
     options: [
         ...cliOptions_ts_1.commonBundleCommandOptions,
+        {
+            name: "--metafile [boolean|string]",
+            description: "If tree shaking enabled, also produce some metadata about the build in JSON format",
+        },
         {
             name: "--tree-shake [boolean]",
             description: "Enable tree shaking to remove unused code and reduce the bundle size",

package/lib/clean.d.ts

@@ -11,10 +11,10 @@ export declare const rnxCleanCommand: {
     func: typeof rnxClean;
     description: string;
     options: ({
-        parse?: undefined;
         name: string;
         description: string;
         default: string;
+        parse?: undefined;
     } | {
         name: string;
         description: string;

package/lib/copy-assets.js

@@ -161,7 +161,7 @@ async function assembleAarBundle(context, packageName, { aar }, fs = nodefs) {
         ...customEnv,
     };
     const outputDir = path.join(context.options.assetsDest, "aar");
-    (0, tools_filesystem_1.ensureDir)(outputDir);
+    (0, tools_filesystem_1.ensureDirSync)(outputDir, fs);
     const dest = path.join(outputDir, `${targetName}-${version}.aar`);
     const targets = [`:${targetName}:assembleRelease`];
     const targetsToCopy = [[output, dest]];
@@ -234,7 +234,7 @@ async function assembleAarBundle(context, packageName, { aar }, fs = nodefs) {
             `project(":${targetName}").projectDir = file(${JSON.stringify(androidProject)})`,
             "",
         ].join("\n");
-        (0, tools_filesystem_1.ensureDir)(buildDir);
+        (0, tools_filesystem_1.ensureDirSync)(buildDir, fs);
         fs.writeFileSync(path.join(buildDir, "build.gradle"), buildGradle);
         fs.writeFileSync(path.join(buildDir, "gradle.properties"), gradleProperties);
         fs.writeFileSync(path.join(buildDir, "settings.gradle"), settingsGradle);
@@ -247,7 +247,7 @@ function copyFiles(files, destination, fs = nodefs) {
     if (!Array.isArray(files) || files.length === 0) {
         return [];
     }
-    (0, tools_filesystem_1.ensureDir)(destination, fs);
+    (0, tools_filesystem_1.ensureDirSync)(destination, fs);
     return files.map((file) => {
         return cp_r(file, `${destination}/${path.basename(file)}`, fs);
     });

package/lib/ram-bundle.js

@@ -8,28 +8,24 @@ const cliOptions_ts_1 = require("./bundle/cliOptions.js");
 const kit_config_ts_1 = require("./bundle/kit-config.js");
 const metro_ts_1 = require("./bundle/metro.js");
 const overrides_ts_1 = require("./bundle/overrides.js");
-function disableTreeShaking(configs) {
-    const wasEnabled = configs.reduce((modified, config) => {
-        if (config.treeShake) {
-            config.treeShake = false;
-            return true;
-        }
-        return modified;
-    }, false);
-    if (wasEnabled) {
+function disableTreeShaking(config) {
+    if (config.treeShake) {
+        config.treeShake = false;
         (0, console_1.info)("`treeShake` was disabled because it is not compatible with the RAM bundle format");
     }
 }
 async function rnxRamBundle(_argv, cliConfig, cliOptions) {
     const metroConfig = await (0, metro_service_1.loadMetroConfig)(cliConfig, cliOptions);
     const bundleConfigs = (0, kit_config_ts_1.getCliPlatformBundleConfigs)(cliOptions.id, cliOptions.platform);
-    (0, overrides_ts_1.applyBundleConfigOverrides)(cliOptions, bundleConfigs, [
-        ...overrides_ts_1.overridableCommonBundleOptions,
+    const overridableFlags = [
+        ...overrides_ts_1.BUNDLE_CONFIG_COMMAND_LINE_OVERRIDES,
         "indexedRamBundle",
-    ]);
-    disableTreeShaking(bundleConfigs);
+    ];
     for (const bundleConfig of bundleConfigs) {
-        await (0, metro_ts_1.metroBundle)(metroConfig, bundleConfig, cliOptions.dev, cliOptions.minify, metro_service_1.ramBundle);
+        (0, overrides_ts_1.applyCommandLineOverrides)(bundleConfig, cliOptions, overridableFlags);
+        disableTreeShaking(bundleConfig);
+        const { dev, minify } = cliOptions;
+        await (0, metro_ts_1.metroBundle)(metroConfig, bundleConfig, dev, minify, metro_service_1.ramBundle);
     }
 }
 exports.rnxRamBundleCommand = {

package/lib/run.d.ts

@@ -23,10 +23,10 @@ export declare const rnxRunCommand: {
         default: string;
         parse: (destination: string) => import("./build/types.ts").DeviceType;
     } | {
-        default?: undefined;
         name: string;
         description: string;
         parse: typeof import("./build/ccache").setCcacheDir;
+        default?: undefined;
     })[];
 };
 //# sourceMappingURL=run.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnx-kit/cli",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Command-line interface for working with kit packages in your repo",
   "homepage": "https://github.com/microsoft/rnx-kit/tree/main/packages/cli#readme",
   "license": "MIT",
@@ -8,6 +8,14 @@
     "name": "Microsoft Open Source",
     "email": "microsoftopensource@users.noreply.github.com"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rnx-kit",
+    "directory": "packages/cli"
+  },
+  "bin": {
+    "rnx-cli": "bin/rnx-cli.cjs"
+  },
   "files": [
     "bin/rnx-cli.mjs",
     "lib/**/*.d.ts",
@@ -15,9 +23,6 @@
     "react-native.config.js"
   ],
   "main": "lib/index.js",
-  "bin": {
-    "rnx-cli": "bin/rnx-cli.cjs"
-  },
   "types": "lib/index.d.ts",
   "exports": {
     ".": {
@@ -28,11 +33,6 @@
     "./react-native.config.js": "./react-native.config.js",
     "./package.json": "./package.json"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/microsoft/rnx-kit",
-    "directory": "packages/cli"
-  },
   "scripts": {
     "build": "rnx-kit-scripts build",
     "format": "rnx-kit-scripts format",
@@ -52,10 +52,10 @@
     "@rnx-kit/third-party-notices": "^2.0.0",
     "@rnx-kit/tools-android": "^0.2.2",
     "@rnx-kit/tools-apple": "^0.2.2",
-    "@rnx-kit/tools-filesystem": "^0.1.0",
+    "@rnx-kit/tools-filesystem": "^0.2.0",
     "@rnx-kit/tools-language": "^3.0.1",
     "@rnx-kit/tools-node": "^3.0.4",
-    "@rnx-kit/tools-react-native": "^2.3.3",
+    "@rnx-kit/tools-react-native": "^2.3.4",
     "@rnx-kit/types-bundle-config": "^1.0.0",
     "@rnx-kit/types-kit-config": "^1.0.0",
     "@rnx-kit/types-node": "^1.0.0",
@@ -63,24 +63,11 @@
     "ora": "^5.4.1",
     "qrcode": "^1.5.0"
   },
-  "peerDependencies": {
-    "jest": ">=26.0",
-    "react-native": ">=0.64"
-  },
-  "peerDependenciesMeta": {
-    "jest": {
-      "optional": true
-    },
-    "react-native": {
-      "optional": true
-    }
-  },
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "^7.20.0",
     "@react-native-community/cli-types": "^20.0.0",
     "@react-native-windows/cli": "^0.79.0",
-    "@rnx-kit/eslint-config": "*",
     "@rnx-kit/jest-preset": "*",
     "@rnx-kit/scripts": "*",
     "@rnx-kit/tsconfig": "*",
@@ -88,6 +75,7 @@
     "@types/node": "^24.0.0",
     "@types/qrcode": "^1.4.2",
     "markdown-table": "^3.0.0",
+    "memfs": "^4.56.10",
     "metro": "^0.83.3",
     "metro-babel-transformer": "^0.83.1",
     "metro-config": "^0.83.3",
@@ -95,10 +83,22 @@
     "react-native": "^0.83.0",
     "type-fest": "^4.0.0"
   },
-  "engines": {
-    "node": ">=22.11"
+  "peerDependencies": {
+    "jest": ">=26.0",
+    "react-native": ">=0.64"
+  },
+  "peerDependenciesMeta": {
+    "jest": {
+      "optional": true
+    },
+    "react-native": {
+      "optional": true
+    }
   },
   "jest": {
     "preset": "@rnx-kit/jest-preset/private"
+  },
+  "engines": {
+    "node": ">=22.11"
   }
 }