@rnx-kit/cli 0.16.29 → 0.17.0

package/lib/bundle/cliOptions.js

@@ -2,74 +2,74 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commonBundleCommandOptions = void 0;
 const platform_1 = require("@rnx-kit/tools-react-native/platform");
-const parsers_1 = require("../parsers");
+const parsers_1 = require("../helpers/parsers");
 exports.commonBundleCommandOptions = [
     {
-        name: "--id [id]",
-        description: "Target bundle definition. This is only needed when the rnx-kit configuration has multiple bundle definitions.",
+        name: "--id <id>",
+        description: "Target bundle definition; only needed when the rnx-kit configuration has multiple bundle definitions",
     },
     {
-        name: "--entry-file [path]",
-        description: "Path to the root JavaScript or TypeScript file, either absolute or relative to the package.",
+        name: "--entry-file <path>",
+        description: "Path to the root JavaScript or TypeScript file, either absolute or relative to the package",
     },
     {
-        name: "--platform [ios|android|windows|win32|macos]",
-        description: "Target platform. When not given, all platforms in the rnx-kit configuration are bundled.",
+        name: "--platform <ios|android|windows|win32|macos>",
+        description: "Target platform; when unspecified, all platforms in the rnx-kit configuration are bundled",
         parse: platform_1.parsePlatform,
     },
     {
         name: "--dev [boolean]",
-        description: "If false, warnings are disabled and the bundle is minified.",
+        description: "If false, warnings are disabled and the bundle is minified",
         default: true,
         parse: parsers_1.asBoolean,
     },
     {
         name: "--minify [boolean]",
-        description: "Controls whether or not the bundle is minified. Disabling minification is useful for test builds.",
+        description: "Controls whether or not the bundle is minified (useful for test builds)",
         parse: parsers_1.asBoolean,
     },
     {
-        name: "--bundle-output [string]",
-        description: "Path to the output bundle file, either absolute or relative to the package.",
+        name: "--bundle-output <string>",
+        description: "Path to the output bundle file, either absolute or relative to the package",
     },
     {
-        name: "--bundle-encoding [utf8|utf16le|ascii]",
-        description: "Character encoding to use when writing the bundle file.",
+        name: "--bundle-encoding <utf8|utf16le|ascii>",
+        description: "Character encoding to use when writing the bundle file",
         default: "utf8",
     },
     {
-        name: "--max-workers [number]",
-        description: "Specifies the maximum number of parallel worker threads to use for transforming files. This defaults to the number of cores available on your machine.",
+        name: "--max-workers <number>",
+        description: "Specifies the maximum number of parallel worker threads to use for transforming files; defaults to the number of cores available on your machine",
         parse: parsers_1.asNumber,
     },
     {
-        name: "--sourcemap-output [string]",
-        description: "Path where the bundle source map is written, either absolute or relative to the package.",
+        name: "--sourcemap-output <string>",
+        description: "Path where the bundle source map is written, either absolute or relative to the package",
     },
     {
-        name: "--sourcemap-sources-root [string]",
-        description: "Path to use when relativizing file entries in the bundle source map.",
+        name: "--sourcemap-sources-root <string>",
+        description: "Path to use when relativizing file entries in the bundle source map",
     },
     {
         name: "--sourcemap-use-absolute-path",
         description: "Report SourceMapURL using its full path",
     },
     {
-        name: "--assets-dest [path]",
-        description: "Path where bundle assets like images are written, either absolute or relative to the package. If not given, assets are ignored.",
+        name: "--assets-dest <path>",
+        description: "Path where bundle assets like images are written, either absolute or relative to the package; if unspecified, assets are ignored",
     },
     {
-        name: "--unstable-transform-profile [string]",
-        description: "Experimental, transform JS for a specific JS engine. Currently supported: hermes, hermes-canary, default",
-        parse: parsers_1.parseTransformProfile,
+        name: "--unstable-transform-profile <string>",
+        description: "[Experimental] Transform JS for a specific JS engine; currently supported: hermes, hermes-canary, default",
+        parse: parsers_1.asTransformProfile,
     },
     {
         name: "--reset-cache",
-        description: "Reset the Metro cache.",
+        description: "Reset the Metro cache",
     },
     {
-        name: "--config [string]",
-        description: "Path to the Metro configuration file.",
+        name: "--config <string>",
+        description: "Path to the Metro configuration file",
     },
 ];
 //# sourceMappingURL=cliOptions.js.map

package/lib/bundle/hermes.d.ts

@@ -1,3 +1,4 @@
+import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import type { HermesOptions } from "@rnx-kit/config";
-export declare function emitBytecode(input: string, sourcemap: string | undefined, options: HermesOptions): void;
+export declare function emitBytecode(cliConfig: CLIConfig, input: string, sourcemap: string | undefined, options: HermesOptions): void;
 //# sourceMappingURL=hermes.d.ts.map

package/lib/bundle/hermes.js

@@ -27,10 +27,10 @@ exports.emitBytecode = emitBytecode;
 const console_1 = require("@rnx-kit/console");
 const package_1 = require("@rnx-kit/tools-node/package");
 const metro_1 = require("@rnx-kit/tools-react-native/metro");
-const child_process_1 = require("child_process");
-const fs = __importStar(require("fs"));
-const os = __importStar(require("os"));
-const path = __importStar(require("path"));
+const node_child_process_1 = require("node:child_process");
+const fs = __importStar(require("node:fs"));
+const os = __importStar(require("node:os"));
+const path = __importStar(require("node:path"));
 function hermesBinaryInDir(hermesc) {
     switch (os.platform()) {
         case "darwin":
@@ -43,15 +43,9 @@ function hermesBinaryInDir(hermesc) {
             return null;
     }
 }
-function findHermesBinary() {
+function findHermesBinary({ reactNativePath }) {
     const locations = [
-        () => {
-            const rnPath = (0, package_1.findPackageDependencyDir)("react-native");
-            if (!rnPath) {
-                throw new Error("Cannot find module 'react-native'");
-            }
-            return path.join(rnPath, "sdks", "hermesc");
-        },
+        () => path.join(reactNativePath, "sdks", "hermesc"),
         () => (0, package_1.findPackageDependencyDir)("hermes-engine"),
     ];
     for (const getLocation of locations) {
@@ -78,9 +72,9 @@ function getOutput(args) {
     }
     return null;
 }
-function emitBytecode(input, sourcemap, options) {
+function emitBytecode(cliConfig, input, sourcemap, options) {
     var _a;
-    const cmd = options.command || findHermesBinary();
+    const cmd = options.command || findHermesBinary(cliConfig);
     if (!cmd) {
         (0, console_1.error)("No Hermes compiler was found");
         return;
@@ -103,7 +97,7 @@ function emitBytecode(input, sourcemap, options) {
     }
     args.push(input);
     (0, console_1.info)("Emitting bytecode to:", output);
-    const result = (0, child_process_1.spawnSync)(cmd, args, { stdio: "inherit" });
+    const result = (0, node_child_process_1.spawnSync)(cmd, args, { stdio: "inherit" });
     if (result.status !== 0) {
         throw result.error;
     }

package/lib/bundle/metro.js

@@ -26,12 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.metroBundle = metroBundle;
 const console_1 = require("@rnx-kit/console");
 const metro_service_1 = require("@rnx-kit/metro-service");
-const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const metro_config_1 = require("../metro-config");
-function ensureDir(p) {
-    fs.mkdirSync(p, { recursive: true, mode: 0o755 });
-}
+const path = __importStar(require("node:path"));
+const filesystem_1 = require("../helpers/filesystem");
+const metro_config_1 = require("../helpers/metro-config");
 /**
  * Run the Metro bundler.
  *
@@ -66,12 +63,12 @@ async function metroBundle(metroConfig, bundleConfig, dev, minify, output = metr
         minify,
     };
     // ensure all output directories exist
-    ensureDir(path.dirname(metroBundleArgs.bundleOutput));
+    (0, filesystem_1.ensureDir)(path.dirname(metroBundleArgs.bundleOutput));
     if (metroBundleArgs.sourcemapOutput) {
-        ensureDir(path.dirname(metroBundleArgs.sourcemapOutput));
+        (0, filesystem_1.ensureDir)(path.dirname(metroBundleArgs.sourcemapOutput));
     }
     if (metroBundleArgs.assetsDest) {
-        ensureDir(metroBundleArgs.assetsDest);
+        (0, filesystem_1.ensureDir)(metroBundleArgs.assetsDest);
     }
     // create the bundle
     await output(metroBundleArgs, metroConfig);

package/lib/bundle.d.ts

@@ -1,6 +1,6 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import type { CLICommonBundleOptions } from "./bundle/types";
-import { asBoolean } from "./parsers";
+import { asBoolean } from "./helpers/parsers";
 type CLIBundleOptions = CLICommonBundleOptions & {
     treeShake?: boolean;
 };
@@ -37,12 +37,12 @@ export declare const rnxBundleCommand: {
     } | {
         name: string;
         description: string;
-        parse: typeof import("./parsers").asNumber;
+        parse: typeof import("./helpers/parsers").asNumber;
         default?: undefined;
     } | {
         name: string;
         description: string;
-        parse: typeof import("./parsers").parseTransformProfile;
+        parse: typeof import("./helpers/parsers").asTransformProfile;
         default?: undefined;
     })[];
 };

package/lib/bundle.js

@@ -8,7 +8,7 @@ const hermes_1 = require("./bundle/hermes");
 const kit_config_1 = require("./bundle/kit-config");
 const metro_1 = require("./bundle/metro");
 const overrides_1 = require("./bundle/overrides");
-const parsers_1 = require("./parsers");
+const parsers_1 = require("./helpers/parsers");
 async function rnxBundle(_argv, cliConfig, cliOptions) {
     const metroConfig = await (0, metro_service_1.loadMetroConfig)(cliConfig, cliOptions);
     const bundleConfigs = (0, kit_config_1.getCliPlatformBundleConfigs)(cliOptions.id, cliOptions.platform);
@@ -21,19 +21,19 @@ async function rnxBundle(_argv, cliConfig, cliOptions) {
         await (0, metro_1.metroBundle)(metroConfig, bundleConfig, cliOptions.dev, cliOptions.minify);
         const { bundleOutput, hermes, sourcemapOutput } = bundleConfig;
         if (hermes) {
-            (0, hermes_1.emitBytecode)(bundleOutput, sourcemapOutput, hermes === true ? {} : hermes);
+            (0, hermes_1.emitBytecode)(cliConfig, bundleOutput, sourcemapOutput, hermes === true ? {} : hermes);
         }
     }
 }
 exports.rnxBundleCommand = {
     name: "rnx-bundle",
-    description: "Bundle your rnx-kit package for offline use. See https://aka.ms/rnx-kit.",
+    description: "Bundle your JavaScript for offline use",
     func: rnxBundle,
     options: [
         ...cliOptions_1.commonBundleCommandOptions,
         {
             name: "--tree-shake [boolean]",
-            description: "Enable tree shaking to remove unused code and reduce the bundle size.",
+            description: "Enable tree shaking to remove unused code and reduce the bundle size",
             parse: parsers_1.asBoolean,
         },
     ],

package/lib/clean.d.ts

@@ -1,11 +1,11 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { asResolvedPath } from "./parsers";
+import { asResolvedPath } from "./helpers/parsers";
 type Args = {
     include?: string;
     projectRoot?: string;
-    verify?: boolean;
+    verifyCache?: boolean;
 };
-export declare function rnxClean(_argv: string[], _config: CLIConfig, cliOptions: Args): Promise<void>;
+export declare function rnxClean(_argv: string[], { root }: CLIConfig, cliOptions: Args): Promise<void>;
 export declare const rnxCleanCommand: {
     name: string;
     func: typeof rnxClean;

package/lib/clean.js

@@ -28,29 +28,38 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.rnxCleanCommand = void 0;
 exports.rnxClean = rnxClean;
-const child_process_1 = require("child_process");
-const fs = __importStar(require("fs-extra"));
+const node_child_process_1 = require("node:child_process");
+const node_fs_1 = require("node:fs");
+const fs = __importStar(require("node:fs/promises"));
+const os = __importStar(require("node:os"));
+const path = __importStar(require("node:path"));
 const ora_1 = __importDefault(require("ora"));
-const os = __importStar(require("os"));
-const path = __importStar(require("path"));
-const parsers_1 = require("./parsers");
-const external_1 = require("./serve/external");
-async function rnxClean(_argv, _config, cliOptions) {
-    var _a, _b, _c;
-    const projectRoot = (_a = cliOptions.projectRoot) !== null && _a !== void 0 ? _a : process.cwd();
-    if (!fs.existsSync(projectRoot)) {
-        throw new Error(`Invalid path provided! ${projectRoot}`);
-    }
-    const spinner = (0, ora_1.default)();
-    try {
-        (0, external_1.requireExternal)("@react-native-community/cli-clean");
-        spinner.warn("`rnx-clean` has been upstreamed to `@react-native-community/cli`. Please use `npx react-native clean` instead.");
-    }
-    catch (_) {
-        // Ignore
+const parsers_1 = require("./helpers/parsers");
+async function rnxClean(_argv, { root = process.cwd() }, cliOptions) {
+    var _a, _b;
+    if (!(0, node_fs_1.existsSync)(root)) {
+        throw new Error(`Invalid project root: ${root}`);
     }
     const npm = os.platform() === "win32" ? "npm.cmd" : "npm";
     const yarn = os.platform() === "win32" ? "yarn.cmd" : "yarn";
+    const execute = (command, args, cwd = root) => {
+        return new Promise((resolve, reject) => {
+            const process = (0, node_child_process_1.spawn)(command, args, {
+                cwd,
+                stdio: ["ignore", "pipe", "pipe"],
+                shell: command.endsWith(".bat") || command.endsWith(".cmd"),
+            });
+            process.on("error", (e) => {
+                const code = "code" in e ? e.code : "errno" in e ? e.errno : "1";
+                reject(`${e.message} (code: ${code})`);
+            });
+            process.on("close", (code) => {
+                if (code === 0) {
+                    resolve();
+                }
+            });
+        });
+    };
     const COMMANDS = {
         android: [
             {
@@ -59,7 +68,7 @@ async function rnxClean(_argv, _config, cliOptions) {
                     const candidates = os.platform() === "win32"
                         ? ["android/gradlew.bat", "gradlew.bat"]
                         : ["android/gradlew", "gradlew"];
-                    const gradlew = findPath(projectRoot, candidates);
+                    const gradlew = findPath(root, candidates);
                     if (gradlew) {
                         const script = path.basename(gradlew);
                         return execute(os.platform() === "win32" ? script : `./${script}`, ["clean"], path.dirname(gradlew));
@@ -73,7 +82,7 @@ async function rnxClean(_argv, _config, cliOptions) {
         cocoapods: [
             {
                 label: "Clean CocoaPods cache",
-                action: () => execute("pod", ["cache", "clean", "--all"], projectRoot),
+                action: () => execute("pod", ["cache", "clean", "--all"]),
             },
         ],
         metro: [
@@ -93,13 +102,13 @@ async function rnxClean(_argv, _config, cliOptions) {
         npm: [
             {
                 label: "Remove node_modules",
-                action: () => cleanDir(`${projectRoot}/node_modules`),
+                action: () => cleanDir(`${root}/node_modules`),
             },
-            ...(cliOptions.verify
+            ...(cliOptions.verifyCache
                 ? [
                     {
                         label: "Verify npm cache",
-                        action: () => execute(npm, ["cache", "verify"], projectRoot),
+                        action: () => execute(npm, ["cache", "verify"]),
                     },
                 ]
                 : []),
@@ -107,26 +116,24 @@ async function rnxClean(_argv, _config, cliOptions) {
         watchman: [
             {
                 label: "Stop Watchman",
-                action: () => execute(os.platform() === "win32" ? "tskill" : "killall", ["watchman"], projectRoot),
+                action: () => execute(os.platform() === "win32" ? "tskill" : "killall", [
+                    "watchman",
+                ]),
             },
             {
                 label: "Delete Watchman cache",
-                action: () => execute("watchman", ["watch-del-all"], projectRoot),
+                action: () => execute("watchman", ["watch-del-all"]),
             },
         ],
         yarn: [
             {
                 label: "Clean Yarn cache",
-                action: () => execute(yarn, ["cache", "clean"], projectRoot),
+                action: () => execute(yarn, ["cache", "clean"]),
             },
         ],
     };
-    const categories = (_c = (_b = cliOptions.include) === null || _b === void 0 ? void 0 : _b.split(",")) !== null && _c !== void 0 ? _c : [
-        "metro",
-        "npm",
-        "watchman",
-        "yarn",
-    ];
+    const categories = (_b = (_a = cliOptions.include) === null || _a === void 0 ? void 0 : _a.split(",")) !== null && _b !== void 0 ? _b : ["metro", "watchman"];
+    const spinner = (0, ora_1.default)();
     for (const category of categories) {
         const commands = COMMANDS[category];
         if (!commands) {
@@ -146,57 +153,30 @@ async function rnxClean(_argv, _config, cliOptions) {
     }
 }
 function cleanDir(path) {
-    if (!fs.existsSync(path)) {
+    if (!(0, node_fs_1.existsSync)(path)) {
         return Promise.resolve();
     }
-    return fs.rmdir(path, { maxRetries: 3, recursive: true });
+    return fs.rm(path, { maxRetries: 3, recursive: true });
 }
 function findPath(startPath, files) {
     // TODO: Find project files via `@react-native-community/cli`
     for (const file of files) {
         const filename = path.resolve(startPath, file);
-        if (fs.existsSync(filename)) {
+        if ((0, node_fs_1.existsSync)(filename)) {
             return filename;
         }
     }
     return undefined;
 }
-function execute(command, args, cwd) {
-    return new Promise((resolve, reject) => {
-        const process = (0, child_process_1.spawn)(command, args, {
-            cwd,
-            stdio: ["inherit", null, null],
-            shell: command.endsWith(".bat") || command.endsWith(".cmd"),
-        });
-        const stderr = [];
-        process.stderr.on("data", (data) => {
-            stderr.push(data);
-        });
-        process.on("close", (code, signal) => {
-            if (code === 0) {
-                resolve();
-            }
-            else if (stderr) {
-                reject(Buffer.concat(stderr).toString().trimEnd());
-            }
-            else if (signal) {
-                reject(`Failed with signal ${signal}`);
-            }
-            else {
-                reject(`Failed with exit code ${code}`);
-            }
-        });
-    });
-}
 exports.rnxCleanCommand = {
     name: "rnx-clean",
     func: rnxClean,
     description: "Clears React Native project related caches",
     options: [
         {
-            name: "--include [android,cocoapods,metro,npm,watchman,yarn]",
-            description: "Comma-separated flag of caches to clear, e.g. `npm,yarn`. When not specified, only non-platform specific caches are cleared.",
-            default: "metro,npm,watchman,yarn",
+            name: "--include <android,cocoapods,metro,npm,watchman,yarn>",
+            description: "Comma-separated flag of caches to clear e.g., `npm,yarn`",
+            default: "metro,watchman",
         },
         {
             name: "--project-root <path>",
@@ -205,7 +185,7 @@ exports.rnxCleanCommand = {
             parse: parsers_1.asResolvedPath,
         },
         {
-            name: "--verify",
+            name: "--verify-cache",
             description: "Whether to verify the integrity of the cache",
             default: false,
         },

package/lib/copy-assets.d.ts

@@ -2,6 +2,7 @@ import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import type { PackageManifest } from "@rnx-kit/tools-node/package";
 import type { AllPlatforms } from "@rnx-kit/tools-react-native";
 import { parsePlatform } from "@rnx-kit/tools-react-native";
+import * as nodefs from "fs";
 export type AndroidArchive = {
     targetName?: string;
     version?: string;
@@ -36,13 +37,14 @@ export type Context = {
     projectRoot: string;
     manifest: PackageManifest;
     options: Options;
+    reactNativePath: string;
 };
 export type AssetsConfig = {
     getAssets?: (context: Context) => Promise<NativeAssets>;
 };
 export declare function versionOf(pkgName: string): string;
 export declare function assembleAarBundle(context: Context, packageName: string, { aar }: NativeAssets): Promise<void>;
-export declare function copyAssets({ options: { assetsDest, xcassetsDest } }: Context, packageName: string, { assets, strings, xcassets }: NativeAssets): Promise<void>;
+export declare function copyAssets({ options: { assetsDest, xcassetsDest } }: Context, packageName: string, { assets, strings, xcassets }: NativeAssets, fs?: typeof nodefs): Promise<void>;
 export declare function gatherConfigs({ projectRoot, manifest, }: Context): Promise<Record<string, AssetsConfig | null> | undefined>;
 /**
  * Copies additional assets not picked by bundlers into desired directory.
@@ -97,11 +99,11 @@ export declare function gatherConfigs({ projectRoot, manifest, }: Context): Prom
  *
  * @param options Options dictate what gets copied where
  */
-export declare function copyProjectAssets(options: Options): Promise<void>;
+export declare function copyProjectAssets(options: Options, { root: projectRoot, reactNativePath }: CLIConfig): Promise<void>;
 export declare const rnxCopyAssetsCommand: {
     name: string;
     description: string;
-    func: (_argv: string[], _config: CLIConfig, options: Options) => Promise<void>;
+    func: (_argv: string[], config: CLIConfig, options: Options) => Promise<void>;
     options: ({
         name: string;
         description: string;