@rnx-kit/cli 0.16.18 → 0.16.20

package/react-native.config.js

@@ -1,184 +1 @@
-const path = require("path");
-const {
-  parseBoolean,
-  parseInt,
-  rnxAlignDepsCommand,
-  rnxBundleCommand,
-  rnxClean,
-  rnxCopyAssetsCommand,
-  rnxRamBundleCommand,
-  rnxStart,
-  rnxTestCommand,
-  rnxWriteThirdPartyNotices,
-} = require("./lib/index");
-
-module.exports = {
-  commands: [
-    rnxBundleCommand,
-    rnxRamBundleCommand,
-    {
-      name: "rnx-start",
-      func: rnxStart,
-      description:
-        "Start a bundle-server to host your react-native experience during development",
-      options: [
-        {
-          name: "--port [number]",
-          description:
-            "Host port to use when listening for incoming server requests.",
-          parse: parseInt,
-          default: 8081,
-        },
-        {
-          name: "--host [string]",
-          description:
-            "Host name or address to bind when listening for incoming server requests. When not given, requests from all addresses are accepted.",
-          default: "",
-        },
-        {
-          name: "--projectRoot [path]",
-          description:
-            "Path to the root of your react-native project. The bundle server uses this root path to resolve all web requests.",
-          parse: (val) => path.resolve(val),
-        },
-        {
-          name: "--watchFolders [paths]",
-          description:
-            "Additional folders which will be added to the file-watch list. Comma-separated. By default, Metro watches all project files.",
-          parse: (val) => val.split(",").map((folder) => path.resolve(folder)),
-        },
-        {
-          name: "--assetPlugins [list]",
-          description:
-            "Additional asset plugins to be used by the Metro Babel transformer. Comma-separated list containing plugin module names or absolute paths to plugin packages.",
-          parse: (val) => val.split(","),
-        },
-        {
-          name: "--sourceExts [list]",
-          description:
-            "Additional source-file extensions to include when generating bundles. Comma-separated list, excluding the leading dot.",
-          parse: (val) => val.split(","),
-        },
-        {
-          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.",
-          parse: parseInt,
-        },
-        {
-          name: "--reset-cache",
-          description: "Reset the Metro cache.",
-        },
-        {
-          name: "--custom-log-reporter-path [string]",
-          description:
-            "Path to a JavaScript file which exports a Metro 'TerminalReporter' function. This replaces the default reporter, which writes all messages to the Metro console.",
-        },
-        {
-          name: "--https",
-          description:
-            "Use a secure (https) web server. When not specified, an insecure (http) web server is used.",
-        },
-        {
-          name: "--key [path]",
-          description:
-            "Path to a custom SSL private key file to use for secure (https) communication.",
-        },
-        {
-          name: "--cert [path]",
-          description:
-            "Path to a custom SSL certificate file to use for secure (https) communication.",
-        },
-        {
-          name: "--config [string]",
-          description: "Path to the Metro configuration file.",
-          parse: (val) => path.resolve(val),
-        },
-        {
-          name: "--no-interactive",
-          description: "Disables interactive mode.",
-        },
-        {
-          name: "--id [string]",
-          description:
-            "Specify which bundle configuration to use if server configuration is missing.",
-        },
-      ],
-    },
-    rnxCopyAssetsCommand,
-    rnxAlignDepsCommand,
-    rnxTestCommand,
-    {
-      name: "rnx-write-third-party-notices",
-      description: "Writes third party notices based on the given bundle",
-      func: rnxWriteThirdPartyNotices,
-      options: [
-        {
-          name: "--root-path <path>",
-          description:
-            "The root of the repo. This is the starting point for finding each module in the source map dependency graph.",
-        },
-        {
-          name: "--source-map-file <file>",
-          description:
-            "The source map file associated with the package's entry file. This source map eventually leads to all package dependencies and their licenses.",
-        },
-        {
-          name: "--json",
-          description:
-            "Format the 3rd-party notice file as JSON instead of text.",
-          default: false,
-          parse: parseBoolean,
-        },
-        {
-          name: "--output-file [file]",
-          description:
-            "The path to use when writing the 3rd-party notice file.",
-        },
-        {
-          name: "--ignore-scopes [string]",
-          description:
-            "Comma-separated list of `npm` scopes to ignore when traversing the source map dependency graph.",
-        },
-        {
-          name: "--ignore-modules [string]",
-          description:
-            "Comma-separated list of modules to ignore when traversing the source map dependency graph.",
-        },
-        {
-          name: "--preamble-text [string]",
-          description:
-            "A string to prepend to the start of the 3rd-party notice.",
-        },
-        {
-          name: "--additional-text [path]",
-          description: "A string to append to the end of the 3rd-party notice.",
-        },
-      ],
-    },
-    {
-      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: "--project-root <path>",
-          description: "Root path to your React Native project",
-          default: process.cwd(),
-          parse: (val) => path.resolve(val),
-        },
-        {
-          name: "--verify",
-          description: "Whether to verify the integrity of the cache",
-          default: false,
-        },
-      ],
-    },
-  ],
-};
+module.exports = require("./lib/index").reactNativeConfig;

package/src/clean.ts

@@ -194,3 +194,28 @@ function execute(command: string, args: string[], cwd: string): Promise<void> {
     });
   });
 }
+
+export const 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: "--project-root <path>",
+      description: "Root path to your React Native project",
+      default: process.cwd(),
+      parse: (val: string) => path.resolve(val),
+    },
+    {
+      name: "--verify",
+      description: "Whether to verify the integrity of the cache",
+      default: false,
+    },
+  ],
+};

package/src/index.ts

@@ -1,9 +1,34 @@
+import { rnxAlignDepsCommand } from "./align-deps";
+import { rnxBundleCommand } from "./bundle";
+import { rnxCleanCommand } from "./clean";
+import { rnxCopyAssetsCommand } from "./copy-assets";
+import { rnxRamBundleCommand } from "./ram-bundle";
+import { rnxStartCommand } from "./start";
+import { rnxTestCommand } from "./test";
+import { rnxWriteThirdPartyNoticesCommand } from "./write-third-party-notices";
+
+export const reactNativeConfig = {
+  commands: [
+    rnxBundleCommand,
+    rnxRamBundleCommand,
+    rnxStartCommand,
+    rnxCopyAssetsCommand,
+    rnxAlignDepsCommand,
+    rnxTestCommand,
+    rnxWriteThirdPartyNoticesCommand,
+    rnxCleanCommand,
+  ],
+};
+
 export { rnxAlignDeps, rnxAlignDepsCommand } from "./align-deps";
 export { rnxBundle, rnxBundleCommand } from "./bundle";
-export { rnxClean } from "./clean";
+export { rnxClean, rnxCleanCommand } from "./clean";
 export { copyProjectAssets, rnxCopyAssetsCommand } from "./copy-assets";
 export { parseBoolean, parseInt, parseTransformProfile } from "./parsers";
 export { rnxRamBundle, rnxRamBundleCommand } from "./ram-bundle";
-export { rnxStart } from "./start";
+export { rnxStart, rnxStartCommand } from "./start";
 export { rnxTest, rnxTestCommand } from "./test";
-export { rnxWriteThirdPartyNotices } from "./write-third-party-notices";
+export {
+  rnxWriteThirdPartyNotices,
+  rnxWriteThirdPartyNoticesCommand,
+} from "./write-third-party-notices";

package/src/start.ts

@@ -223,3 +223,94 @@ export async function rnxStart(
     attachKeyHandlers({ devServerUrl, help, messageSocketEndpoint, terminal });
   }
 }
+
+export const rnxStartCommand = {
+  name: "rnx-start",
+  func: rnxStart,
+  description:
+    "Start a bundle-server to host your react-native experience during development",
+  options: [
+    {
+      name: "--port [number]",
+      description:
+        "Host port to use when listening for incoming server requests.",
+      parse: parseInt,
+      default: 8081,
+    },
+    {
+      name: "--host [string]",
+      description:
+        "Host name or address to bind when listening for incoming server requests. When not given, requests from all addresses are accepted.",
+      default: "",
+    },
+    {
+      name: "--projectRoot [path]",
+      description:
+        "Path to the root of your react-native project. The bundle server uses this root path to resolve all web requests.",
+      parse: (val: string) => path.resolve(val),
+    },
+    {
+      name: "--watchFolders [paths]",
+      description:
+        "Additional folders which will be added to the file-watch list. Comma-separated. By default, Metro watches all project files.",
+      parse: (val: string) =>
+        val.split(",").map((folder) => path.resolve(folder)),
+    },
+    {
+      name: "--assetPlugins [list]",
+      description:
+        "Additional asset plugins to be used by the Metro Babel transformer. Comma-separated list containing plugin module names or absolute paths to plugin packages.",
+      parse: (val: string) => val.split(","),
+    },
+    {
+      name: "--sourceExts [list]",
+      description:
+        "Additional source-file extensions to include when generating bundles. Comma-separated list, excluding the leading dot.",
+      parse: (val: string) => val.split(","),
+    },
+    {
+      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.",
+      parse: parseInt,
+    },
+    {
+      name: "--reset-cache",
+      description: "Reset the Metro cache.",
+    },
+    {
+      name: "--custom-log-reporter-path [string]",
+      description:
+        "Path to a JavaScript file which exports a Metro 'TerminalReporter' function. This replaces the default reporter, which writes all messages to the Metro console.",
+    },
+    {
+      name: "--https",
+      description:
+        "Use a secure (https) web server. When not specified, an insecure (http) web server is used.",
+    },
+    {
+      name: "--key [path]",
+      description:
+        "Path to a custom SSL private key file to use for secure (https) communication.",
+    },
+    {
+      name: "--cert [path]",
+      description:
+        "Path to a custom SSL certificate file to use for secure (https) communication.",
+    },
+    {
+      name: "--config [string]",
+      description: "Path to the Metro configuration file.",
+      parse: (val: string) => path.resolve(val),
+    },
+    {
+      name: "--no-interactive",
+      description: "Disables interactive mode.",
+    },
+    {
+      name: "--id [string]",
+      description:
+        "Specify which bundle configuration to use if server configuration is missing.",
+    },
+  ],
+};

package/src/test.ts

@@ -1,8 +1,10 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import { error } from "@rnx-kit/console";
-import { findPackageDir } from "@rnx-kit/tools-node";
+import {
+  findPackageDir,
+  resolveDependencyChain,
+} from "@rnx-kit/tools-node/package";
 import { parsePlatform } from "@rnx-kit/tools-react-native/platform";
-import * as path from "path";
 
 type Args = {
   platform: "android" | "ios" | "macos" | "windows" | "win32";
@@ -20,23 +22,19 @@ type Options = {
 };
 
 const COMMAND_NAME = "rnx-test";
-
-export function resolveJestCli(): string {
-  const jestPath = path.dirname(require.resolve("jest/package.json"));
-  return require.resolve("jest-cli", { paths: [jestPath] });
-}
+const JEST_CLI = ["jest", "jest-cli"];
 
 export function rnxTest(
   _argv: string[],
-  _config: CLIConfig,
+  { root }: CLIConfig,
   { platform }: Args
 ): void {
   const runJest: (argv: string[]) => void = (() => {
     try {
-      const { run } = require(resolveJestCli());
+      const { run } = require(resolveDependencyChain(JEST_CLI, root));
       return run;
     } catch (e) {
-      error("'rnx-test' is unavailable because 'jest-cli' is not installed");
+      error("'rnx-test' is unavailable because 'jest' is not installed");
       throw e;
     }
   })();
@@ -64,10 +62,21 @@ export function rnxTest(
 
 export function jestOptions(): Options[] {
   const options = (() => {
+    const jestCliPath = (() => {
+      try {
+        return resolveDependencyChain(JEST_CLI);
+      } catch (_) {
+        return undefined;
+      }
+    })();
+    if (!jestCliPath) {
+      return {};
+    }
+
     try {
       // `yargsOptions` is exported as of 29.5.0
       // https://github.com/jestjs/jest/commit/0e8ed24a527b951efe11ed49da46e0bd8c0ebef9
-      const { yargsOptions } = require("jest-cli");
+      const { yargsOptions } = require(jestCliPath);
       if (yargsOptions) {
         return yargsOptions;
       }
@@ -82,7 +91,7 @@ export function jestOptions(): Options[] {
     //
     // To work around this, resolve `jest-cli` first, then use the resolved
     // path to import `./build/cli/args`.
-    const jestPath = findPackageDir(resolveJestCli()) || "jest-cli";
+    const jestPath = findPackageDir(jestCliPath) || "jest-cli";
 
     try {
       // `args.js` was moved in 29.2.0

package/src/write-third-party-notices.ts

@@ -1,5 +1,6 @@
 import type { Config as CLIConfig } from "@react-native-community/cli-types";
 import { writeThirdPartyNotices } from "@rnx-kit/third-party-notices";
+import { parseBoolean } from "./parsers";
 
 type CliThirdPartyNoticesOptions = {
   rootPath: string;
@@ -38,3 +39,49 @@ export function rnxWriteThirdPartyNotices(
     additionalText: additionalText ? [additionalText] : undefined,
   });
 }
+
+export const rnxWriteThirdPartyNoticesCommand = {
+  name: "rnx-write-third-party-notices",
+  description: "Writes third party notices based on the given bundle",
+  func: rnxWriteThirdPartyNotices,
+  options: [
+    {
+      name: "--root-path <path>",
+      description:
+        "The root of the repo. This is the starting point for finding each module in the source map dependency graph.",
+    },
+    {
+      name: "--source-map-file <file>",
+      description:
+        "The source map file associated with the package's entry file. This source map eventually leads to all package dependencies and their licenses.",
+    },
+    {
+      name: "--json",
+      description: "Format the 3rd-party notice file as JSON instead of text.",
+      default: false,
+      parse: parseBoolean,
+    },
+    {
+      name: "--output-file [file]",
+      description: "The path to use when writing the 3rd-party notice file.",
+    },
+    {
+      name: "--ignore-scopes [string]",
+      description:
+        "Comma-separated list of `npm` scopes to ignore when traversing the source map dependency graph.",
+    },
+    {
+      name: "--ignore-modules [string]",
+      description:
+        "Comma-separated list of modules to ignore when traversing the source map dependency graph.",
+    },
+    {
+      name: "--preamble-text [string]",
+      description: "A string to prepend to the start of the 3rd-party notice.",
+    },
+    {
+      name: "--additional-text [path]",
+      description: "A string to append to the end of the 3rd-party notice.",
+    },
+  ],
+};

package/test/__mocks__/fs.js

@@ -1,20 +1 @@
-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.mkdirSync = (...args) => vol.mkdirSync(...args);
-fs.readFileSync = (...args) => vol.readFileSync(...args);
-fs.stat = (...args) => Promise.resolve(vol.stat(...args));
-fs.statSync = (...args) => vol.statSync(...args);
-
-module.exports = fs;
+module.exports = require("@rnx-kit/metro-plugin-duplicates-checker/test/__mocks__/fs");

package/test/test.test.ts

@@ -1,4 +1,4 @@
-import { jestOptions, resolveJestCli } from "../src/test";
+import { jestOptions } from "../src/test";
 
 describe("rnx-test", () => {
   test("retrieves options from 'jest-cli'", () => {
@@ -8,10 +8,4 @@ describe("rnx-test", () => {
     const updateSnapshot = options.find(({ name }) => name.startsWith("-u,"));
     expect(updateSnapshot).toBeDefined();
   });
-
-  test("resolves 'jest-cli' starting from 'jest'", () => {
-    expect(resolveJestCli()).toMatch(
-      /node_modules[/\\]jest-cli[/\\]build[/\\]index.js$/
-    );
-  });
 });