@rnx-kit/cli 0.18.0 → 0.18.1

package/README.md

@@ -116,51 +116,6 @@ dependencies.
 
 <!-- @rnx-kit/cli/bundle end -->
 
-## `rnx-cli config`
-
-Routes to
-[`react-native config`](https://github.com/react-native-community/cli/blob/main/packages/cli-config#readme).
-
-## `rnx-cli doctor`
-
-Routes to
-[`react-native doctor`](https://github.com/react-native-community/cli/blob/main/packages/cli-doctor#readme).
-
-## `rnx-cli info`
-
-Routes to
-[`react-native info`](https://github.com/react-native-community/cli/blob/main/packages/cli-doctor#info).
-
-## `rnx-cli build-android`
-
-Routes to
-[`react-native build-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#build-android).
-
-## `rnx-cli build-ios`
-
-Routes to
-[`react-native build-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#build-ios).
-
-## `rnx-cli log-android`
-
-Routes to
-[`react-native log-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#log-android).
-
-## `rnx-cli log-ios`
-
-Routes to
-[`react-native log-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#log-ios).
-
-## `rnx-cli run-android`
-
-Routes to
-[`react-native run-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#run-android).
-
-## `rnx-cli run-ios`
-
-Routes to
-[`react-native run-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#run-ios).
-
 ## `rnx-cli start`
 
 Start a bundle server for a package using [Metro][]. The bundle server uses
@@ -235,6 +190,59 @@ from the bundle configuration (or its [defaults](#bundle-defaults)).
 
 <!-- @rnx-kit/cli/start end -->
 
+## `rnx-cli build`
+
+Builds the native bits in your project.
+
+```sh
+yarn rnx-cli build [options]
+```
+
+<!-- @rnx-kit/cli/build start -->
+
+| Option                         | Description                                                                  |
+| ------------------------------ | ---------------------------------------------------------------------------- |
+| -p, --platform &lt;string&gt;  | Target platform                                                              |
+| --workspace &lt;string&gt;     | Path, relative to project root, of the Xcode workspace to build (macOS only) |
+| --scheme &lt;string&gt;        | Name of scheme to build (Apple platforms only)                               |
+| --configuration &lt;string&gt; | Build configuration for building the app; 'Debug' or 'Release'               |
+| --destination &lt;string&gt;   | Destination of the built app; 'device', 'emulator', or 'simulator'           |
+
+<!-- @rnx-kit/cli/build end -->
+
+### Example Commands
+
+```sh
+yarn rnx-cli build -p ios
+```
+
+## `rnx-cli run`
+
+Launches the native app (building it first if necessary).
+
+```sh
+yarn rnx-cli run [options]
+```
+
+<!-- @rnx-kit/cli/run start -->
+
+| Option                         | Description                                                                  |
+| ------------------------------ | ---------------------------------------------------------------------------- |
+| -p, --platform &lt;string&gt;  | Target platform                                                              |
+| --workspace &lt;string&gt;     | Path, relative to project root, of the Xcode workspace to build (macOS only) |
+| --scheme &lt;string&gt;        | Name of scheme to build (Apple platforms only)                               |
+| --configuration &lt;string&gt; | Build configuration for building the app; 'Debug' or 'Release'               |
+| --destination &lt;string&gt;   | Destination of the built app; 'device', 'emulator', or 'simulator'           |
+| -d, --device &lt;string&gt;    | The name of the device to launch the app in                                  |
+
+<!-- @rnx-kit/cli/run end -->
+
+### Example Commands
+
+```sh
+yarn rnx-cli run -p ios
+```
+
 ## `rnx-cli align-deps`
 
 Manage dependencies within a repository and across many repositories.
@@ -281,19 +289,43 @@ yarn rnx-cli write-third-party-notices [options]
 
 <!-- @rnx-kit/cli/write-third-party-notices start -->
 
-| Option                           | Description                                                                                                                                    |
-| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| --root-path &lt;path&gt;         | The root of the repo — the starting point for finding each module in the source map dependency graph                                           |
-| --source-map-file &lt;file&gt;   | The source map file associated with the package's entry file — this source map eventually leads to all package dependencies and their licenses |
-| --json                           | Format the 3rd-party notice file as JSON instead of text                                                                                       |
-| --output-file &lt;file&gt;       | The path to use when writing the 3rd-party notice file                                                                                         |
-| --ignore-scopes &lt;string&gt;   | Comma-separated list of npm scopes to ignore when traversing the source map dependency graph                                                   |
-| --ignore-modules &lt;string&gt;  | Comma-separated list of modules to ignore when traversing the source map dependency graph                                                      |
-| --preamble-text &lt;string&gt;   | A string to prepend to the start of the 3rd-party notice                                                                                       |
-| --additional-text &lt;string&gt; | A string to append to the end of the 3rd-party notice                                                                                          |
+| Option                           | Description                                                           |
+| -------------------------------- | --------------------------------------------------------------------- |
+| --root-path &lt;path&gt;         | The root of the repo to start resolving modules from                  |
+| --source-map-file &lt;path&gt;   | The source map file to generate license contents for                  |
+| --json                           | Output license information as a JSON                                  |
+| --output-file &lt;path&gt;       | The output file to write the license file to                          |
+| --ignore-scopes &lt;string&gt;   | npm scopes to ignore and not emit license information for             |
+| --ignore-modules &lt;string&gt;  | Modules (JS packages) to not emit license information for             |
+| --preamble-text &lt;string&gt;   | A list of lines to prepend at the start of the generated license file |
+| --additional-text &lt;string&gt; | A list of lines to append at the end of the generated license file    |
+| --full-license-text              | Include full license text in the JSON output                          |
 
 <!-- @rnx-kit/cli/write-third-party-notices end -->
 
+## Other Commands
+
+The following commands route to `@react-native-community/cli`:
+
+- `rnx-cli build-android` →
+  [`react-native build-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#build-android)
+- `rnx-cli build-ios` →
+  [`react-native build-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#build-ios)
+- `rnx-cli config` →
+  [`react-native config`](https://github.com/react-native-community/cli/blob/main/packages/cli-config#readme)
+- `rnx-cli doctor` →
+  [`react-native doctor`](https://github.com/react-native-community/cli/blob/main/packages/cli-doctor#readme)
+- `rnx-cli info` →
+  [`react-native info`](https://github.com/react-native-community/cli/blob/main/packages/cli-doctor#info)
+- `rnx-cli log-android` →
+  [`react-native log-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#log-android)
+- `rnx-cli log-ios` →
+  [`react-native log-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#log-ios)
+- `rnx-cli run-android` →
+  [`react-native run-android`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-android#run-android)
+- `rnx-cli run-ios` →
+  [`react-native run-ios`](https://github.com/react-native-community/cli/blob/main/packages/cli-platform-ios#run-ios)
+
 <!-- References -->
 
 [@rnx-kit/align-deps]:

package/lib/build/android.js

@@ -16,10 +16,8 @@ function buildAndroid(config, buildParams, logger = (0, ora_1.default)()) {
         return Promise.resolve(null);
     }
     return import("@rnx-kit/tools-android").then(({ assemble }) => {
-        return new Promise((resolve) => {
-            const gradle = assemble(sourceDir, buildParams);
-            (0, watcher_1.watch)(gradle, logger, () => resolve(sourceDir), resolve);
-        });
+        const gradle = assemble(sourceDir, buildParams);
+        return (0, watcher_1.watch)(gradle, logger, () => sourceDir);
     });
 }
 //# sourceMappingURL=android.js.map

package/lib/build/apple.js

@@ -4,13 +4,9 @@ exports.runBuild = runBuild;
 const watcher_1 = require("./watcher");
 function runBuild(xcworkspace, buildParams, logger) {
     return import("@rnx-kit/tools-apple").then(({ xcodebuild }) => {
-        return new Promise((resolve) => {
-            const onSuccess = () => resolve({ xcworkspace, args: build.spawnargs });
-            const build = xcodebuild(xcworkspace, buildParams, (text) => {
-                logger.info(text);
-            });
-            (0, watcher_1.watch)(build, logger, onSuccess, resolve);
-        });
+        const log = (message) => logger.info(message);
+        const build = xcodebuild(xcworkspace, buildParams, log);
+        return (0, watcher_1.watch)(build, logger, () => ({ xcworkspace, args: build.spawnargs }));
     });
 }
 //# sourceMappingURL=apple.js.map

package/lib/build/watcher.d.ts

@@ -1,4 +1,5 @@
 import type { ChildProcessWithoutNullStreams } from "node:child_process";
 import type { Ora } from "ora";
-export declare function watch(subproc: ChildProcessWithoutNullStreams, logger: Ora, onSuccess: () => void, onFail: (exitCode: number | null) => void): void;
+export type ExitCode = number | null;
+export declare function watch<T>(subproc: ChildProcessWithoutNullStreams, logger: Ora, onSuccess: () => T): Promise<ExitCode | T>;
 //# sourceMappingURL=watcher.d.ts.map

package/lib/build/watcher.js

@@ -1,22 +1,31 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watch = watch;
-function watch(subproc, logger, onSuccess, onFail) {
-    subproc.stdout.on("data", () => (logger.text += "."));
-    const errors = [];
-    subproc.stderr.on("data", (data) => errors.push(data));
-    subproc.on("close", (code) => {
-        if (code === 0) {
-            logger.succeed("Build succeeded");
-            onSuccess();
+function watch(subproc, logger, onSuccess) {
+    return new Promise((resolve) => {
+        const errors = [];
+        const isCI = Boolean(process.env.CI);
+        if (isCI) {
+            subproc.stdout.on("data", (chunk) => process.stdout.write(chunk));
+            subproc.stderr.on("data", (chunk) => process.stderr.write(chunk));
         }
         else {
-            logger.fail(Buffer.concat(errors).toString());
-            process.exitCode = code ?? 1;
-            onFail(code);
+            subproc.stdout.on("data", () => (logger.text += "."));
+            subproc.stderr.on("data", (data) => errors.push(data));
         }
+        subproc.on("close", (code) => {
+            if (code === 0) {
+                logger.succeed("Build succeeded");
+                resolve(onSuccess());
+            }
+            else {
+                logger.fail(Buffer.concat(errors).toString());
+                process.exitCode = code ?? 1;
+                resolve(code);
+            }
+        });
+        logger.info(`Command: ${subproc.spawnargs.join(" ")}`);
+        logger.start("Building");
     });
-    logger.info(`Command: ${subproc.spawnargs.join(" ")}`);
-    logger.start("Building");
 }
 //# sourceMappingURL=watcher.js.map

package/lib/index.d.ts

@@ -1,4 +1,13 @@
 import type { Command } from "@react-native-community/cli-types";
+import { rnxBuild, rnxBuildCommand } from "./build";
+import { rnxBundle, rnxBundleCommand } from "./bundle";
+import { rnxClean, rnxCleanCommand } from "./clean";
+import { copyProjectAssets, rnxCopyAssetsCommand } from "./copy-assets";
+import { rnxRamBundle, rnxRamBundleCommand } from "./ram-bundle";
+import { rnxRun, rnxRunCommand } from "./run";
+import { rnxStart, rnxStartCommand } from "./start";
+import { rnxTest, rnxTestCommand } from "./test";
+export { copyProjectAssets, rnxBuild, rnxBuildCommand, rnxBundle, rnxBundleCommand, rnxClean, rnxCleanCommand, rnxCopyAssetsCommand, rnxRamBundle, rnxRamBundleCommand, rnxRun, rnxRunCommand, rnxStart, rnxStartCommand, rnxTest, rnxTestCommand, };
 export declare const reactNativeConfig: {
     commands: Command<false>[];
 };
@@ -37,12 +46,4 @@ export declare const rnxWriteThirdPartyNoticesCommand: {
         default: string | false | undefined;
     }[];
 };
-export { rnxBuild, rnxBuildCommand } from "./build";
-export { rnxBundle, rnxBundleCommand } from "./bundle";
-export { rnxClean, rnxCleanCommand } from "./clean";
-export { copyProjectAssets, rnxCopyAssetsCommand } from "./copy-assets";
-export { rnxRamBundle, rnxRamBundleCommand } from "./ram-bundle";
-export { rnxRun, rnxRunCommand } from "./run";
-export { rnxStart, rnxStartCommand } from "./start";
-export { rnxTest, rnxTestCommand } from "./test";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -1,16 +1,32 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rnxTestCommand = exports.rnxTest = exports.rnxStartCommand = exports.rnxStart = exports.rnxRunCommand = exports.rnxRun = exports.rnxRamBundleCommand = exports.rnxRamBundle = exports.rnxCopyAssetsCommand = exports.copyProjectAssets = exports.rnxCleanCommand = exports.rnxClean = exports.rnxBundleCommand = exports.rnxBundle = exports.rnxBuildCommand = exports.rnxBuild = exports.rnxWriteThirdPartyNoticesCommand = exports.rnxWriteThirdPartyNotices = exports.rnxAlignDepsCommand = exports.rnxAlignDeps = exports.reactNativeConfig = void 0;
+exports.rnxWriteThirdPartyNoticesCommand = exports.rnxWriteThirdPartyNotices = exports.rnxAlignDepsCommand = exports.rnxAlignDeps = exports.reactNativeConfig = exports.rnxTestCommand = exports.rnxTest = exports.rnxStartCommand = exports.rnxStart = exports.rnxRunCommand = exports.rnxRun = exports.rnxRamBundleCommand = exports.rnxRamBundle = exports.rnxCopyAssetsCommand = exports.rnxCleanCommand = exports.rnxClean = exports.rnxBundleCommand = exports.rnxBundle = exports.rnxBuildCommand = exports.rnxBuild = exports.copyProjectAssets = void 0;
 const align_deps_1 = require("@rnx-kit/align-deps");
 const third_party_notices_1 = require("@rnx-kit/third-party-notices");
 const build_1 = require("./build");
+Object.defineProperty(exports, "rnxBuild", { enumerable: true, get: function () { return build_1.rnxBuild; } });
+Object.defineProperty(exports, "rnxBuildCommand", { enumerable: true, get: function () { return build_1.rnxBuildCommand; } });
 const bundle_1 = require("./bundle");
+Object.defineProperty(exports, "rnxBundle", { enumerable: true, get: function () { return bundle_1.rnxBundle; } });
+Object.defineProperty(exports, "rnxBundleCommand", { enumerable: true, get: function () { return bundle_1.rnxBundleCommand; } });
 const clean_1 = require("./clean");
+Object.defineProperty(exports, "rnxClean", { enumerable: true, get: function () { return clean_1.rnxClean; } });
+Object.defineProperty(exports, "rnxCleanCommand", { enumerable: true, get: function () { return clean_1.rnxCleanCommand; } });
 const copy_assets_1 = require("./copy-assets");
+Object.defineProperty(exports, "copyProjectAssets", { enumerable: true, get: function () { return copy_assets_1.copyProjectAssets; } });
+Object.defineProperty(exports, "rnxCopyAssetsCommand", { enumerable: true, get: function () { return copy_assets_1.rnxCopyAssetsCommand; } });
 const ram_bundle_1 = require("./ram-bundle");
+Object.defineProperty(exports, "rnxRamBundle", { enumerable: true, get: function () { return ram_bundle_1.rnxRamBundle; } });
+Object.defineProperty(exports, "rnxRamBundleCommand", { enumerable: true, get: function () { return ram_bundle_1.rnxRamBundleCommand; } });
 const run_1 = require("./run");
+Object.defineProperty(exports, "rnxRun", { enumerable: true, get: function () { return run_1.rnxRun; } });
+Object.defineProperty(exports, "rnxRunCommand", { enumerable: true, get: function () { return run_1.rnxRunCommand; } });
 const start_1 = require("./start");
+Object.defineProperty(exports, "rnxStart", { enumerable: true, get: function () { return start_1.rnxStart; } });
+Object.defineProperty(exports, "rnxStartCommand", { enumerable: true, get: function () { return start_1.rnxStartCommand; } });
 const test_1 = require("./test");
+Object.defineProperty(exports, "rnxTest", { enumerable: true, get: function () { return test_1.rnxTest; } });
+Object.defineProperty(exports, "rnxTestCommand", { enumerable: true, get: function () { return test_1.rnxTestCommand; } });
 exports.reactNativeConfig = {
     commands: [
         bundle_1.rnxBundleCommand,
@@ -31,28 +47,4 @@ exports.rnxAlignDepsCommand = align_deps_1.alignDepsCommand;
 // @rnx-kit/third-party-notices
 exports.rnxWriteThirdPartyNotices = third_party_notices_1.writeThirdPartyNoticesCommand.func;
 exports.rnxWriteThirdPartyNoticesCommand = third_party_notices_1.writeThirdPartyNoticesCommand;
-var build_2 = require("./build");
-Object.defineProperty(exports, "rnxBuild", { enumerable: true, get: function () { return build_2.rnxBuild; } });
-Object.defineProperty(exports, "rnxBuildCommand", { enumerable: true, get: function () { return build_2.rnxBuildCommand; } });
-var bundle_2 = require("./bundle");
-Object.defineProperty(exports, "rnxBundle", { enumerable: true, get: function () { return bundle_2.rnxBundle; } });
-Object.defineProperty(exports, "rnxBundleCommand", { enumerable: true, get: function () { return bundle_2.rnxBundleCommand; } });
-var clean_2 = require("./clean");
-Object.defineProperty(exports, "rnxClean", { enumerable: true, get: function () { return clean_2.rnxClean; } });
-Object.defineProperty(exports, "rnxCleanCommand", { enumerable: true, get: function () { return clean_2.rnxCleanCommand; } });
-var copy_assets_2 = require("./copy-assets");
-Object.defineProperty(exports, "copyProjectAssets", { enumerable: true, get: function () { return copy_assets_2.copyProjectAssets; } });
-Object.defineProperty(exports, "rnxCopyAssetsCommand", { enumerable: true, get: function () { return copy_assets_2.rnxCopyAssetsCommand; } });
-var ram_bundle_2 = require("./ram-bundle");
-Object.defineProperty(exports, "rnxRamBundle", { enumerable: true, get: function () { return ram_bundle_2.rnxRamBundle; } });
-Object.defineProperty(exports, "rnxRamBundleCommand", { enumerable: true, get: function () { return ram_bundle_2.rnxRamBundleCommand; } });
-var run_2 = require("./run");
-Object.defineProperty(exports, "rnxRun", { enumerable: true, get: function () { return run_2.rnxRun; } });
-Object.defineProperty(exports, "rnxRunCommand", { enumerable: true, get: function () { return run_2.rnxRunCommand; } });
-var start_2 = require("./start");
-Object.defineProperty(exports, "rnxStart", { enumerable: true, get: function () { return start_2.rnxStart; } });
-Object.defineProperty(exports, "rnxStartCommand", { enumerable: true, get: function () { return start_2.rnxStartCommand; } });
-var test_2 = require("./test");
-Object.defineProperty(exports, "rnxTest", { enumerable: true, get: function () { return test_2.rnxTest; } });
-Object.defineProperty(exports, "rnxTestCommand", { enumerable: true, get: function () { return test_2.rnxTestCommand; } });
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnx-kit/cli",
-  "version": "0.18.0",
+  "version": "0.18.1",
   "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",
@@ -34,21 +34,20 @@
   },
   "scripts": {
     "build": "rnx-kit-scripts build",
-    "depcheck": "rnx-kit-scripts depcheck",
     "format": "rnx-kit-scripts format",
     "lint": "rnx-kit-scripts lint",
     "test": "rnx-kit-scripts test"
   },
   "dependencies": {
-    "@rnx-kit/align-deps": "^3.0.0",
+    "@rnx-kit/align-deps": "^3.0.1",
     "@rnx-kit/config": "^0.7.0",
     "@rnx-kit/console": "^2.0.0",
     "@rnx-kit/metro-plugin-cyclic-dependencies-detector": "^2.0.0",
     "@rnx-kit/metro-plugin-duplicates-checker": "^3.0.0",
     "@rnx-kit/metro-plugin-typescript": "^0.5.0",
     "@rnx-kit/metro-serializer": "^2.0.0",
-    "@rnx-kit/metro-serializer-esbuild": "^0.2.0",
-    "@rnx-kit/metro-service": "^4.0.0",
+    "@rnx-kit/metro-serializer-esbuild": "^0.2.1",
+    "@rnx-kit/metro-service": "^4.0.1",
     "@rnx-kit/third-party-notices": "^2.0.0",
     "@rnx-kit/tools-android": "^0.2.0",
     "@rnx-kit/tools-apple": "^0.2.0",
@@ -100,11 +99,6 @@
   "engines": {
     "node": ">=16.17"
   },
-  "depcheck": {
-    "ignoreMatches": [
-      "connect"
-    ]
-  },
   "jest": {
     "preset": "@rnx-kit/jest-preset/private"
   }