@rnx-kit/cli 0.16.28 → 0.16.30

package/src/start.ts

@@ -1,316 +0,0 @@
-import type { Config } from "@react-native-community/cli-types";
-import * as logger from "@rnx-kit/console";
-import {
-  isDevServerRunning,
-  loadMetroConfig,
-  makeReporter,
-  makeTerminal,
-  startServer,
-} from "@rnx-kit/metro-service";
-import type { ReportableEvent, Reporter, RunServerOptions } from "metro";
-import type { Middleware } from "metro-config";
-import type Server from "metro/src/Server";
-import * as path from "path";
-import { customizeMetroConfig } from "./metro-config";
-import { asNumber, asResolvedPath, asStringArray } from "./parsers";
-import { requireExternal } from "./serve/external";
-import { makeHelp } from "./serve/help";
-import { attachKeyHandlers } from "./serve/keyboard";
-import { getKitServerConfig } from "./serve/kit-config";
-import type {
-  DevServerMiddleware,
-  DevServerMiddleware6,
-  StartCommandArgs,
-} from "./serve/types";
-
-function hasAttachToServerFunction(
-  devServer: DevServerMiddleware | DevServerMiddleware6
-): devServer is DevServerMiddleware6 {
-  return "attachToServer" in devServer;
-}
-
-export async function rnxStart(
-  _argv: string[],
-  ctx: Config,
-  args: StartCommandArgs
-): Promise<void> {
-  const serverConfig = getKitServerConfig(args);
-
-  const { createDevServerMiddleware, indexPageMiddleware } = requireExternal(
-    "@react-native-community/cli-server-api"
-  );
-
-  // interactive mode requires raw access to stdin
-  let interactive = args.interactive;
-  if (interactive) {
-    interactive = process.stdin.isTTY;
-    if (!interactive) {
-      logger.warn("Interactive mode is not supported in this environment");
-    }
-  }
-
-  // load Metro configuration, applying overrides from the command line
-  const metroConfig = await loadMetroConfig(ctx, {
-    ...args,
-    ...(serverConfig.projectRoot
-      ? { projectRoot: path.resolve(serverConfig.projectRoot) }
-      : undefined),
-    ...(serverConfig.sourceExts
-      ? { sourceExts: serverConfig.sourceExts }
-      : undefined),
-    ...(serverConfig.assetPlugins
-      ? {
-          assetPlugins: serverConfig.assetPlugins.map((p) =>
-            require.resolve(p)
-          ),
-        }
-      : undefined),
-  });
-
-  const { projectRoot, watchFolders } = metroConfig;
-  const terminal = makeTerminal(projectRoot);
-
-  // customize the metro config to include plugins, presets, etc.
-  const log = (message: string): void => terminal.log(message);
-  customizeMetroConfig(metroConfig, serverConfig, log);
-
-  const { port } = metroConfig.server;
-  const scheme = args.https === true ? "https" : "http";
-  const serverStatus = await isDevServerRunning(
-    scheme,
-    args.host,
-    port,
-    projectRoot
-  );
-
-  switch (serverStatus) {
-    case "already_running":
-      logger.info(
-        `A dev server is already running for this project on port ${port}. ` +
-          "Exiting..."
-      );
-      return;
-    case "in_use":
-      logger.error(
-        `Another process is using port ${port}. Please terminate this ` +
-          "process and try again, or try another port with `--port`."
-      );
-      return;
-  }
-
-  // create middleware -- a collection of plugins which handle incoming
-  // http(s) requests, routing them to static pages or JS functions.
-  const host = args.host?.length ? args.host : "localhost";
-  const devServerUrl = `${scheme}://${host}:${port}`;
-  const devServer = createDevServerMiddleware({ host, port, watchFolders });
-
-  const coreDevMiddleware = (() => {
-    try {
-      // https://github.com/facebook/react-native/blob/7888338295476f4d4f00733309e54b8d22318e1e/packages/community-cli-plugin/src/commands/start/runServer.js#L115
-      const { createDevMiddleware } = requireExternal(
-        "@react-native/dev-middleware"
-      );
-      return createDevMiddleware({
-        projectRoot,
-        serverBaseUrl: devServerUrl,
-        logger,
-        unstable_experiments: {
-          // NOTE: Only affects the /open-debugger endpoint
-          enableCustomDebuggerFrontend: true,
-        },
-      });
-    } catch (_) {
-      // Fallback to the behavior from before 0.73
-      const middleware = devServer.middleware;
-      middleware.use(indexPageMiddleware);
-
-      // merge the Metro config middleware with our middleware
-      const enhanceMiddleware = metroConfig.server.enhanceMiddleware;
-      // @ts-expect-error We want to override `enhanceMiddleware`
-      metroConfig.server.enhanceMiddleware = (
-        metroMiddleware: Middleware,
-        metroServer: Server
-      ) => {
-        return middleware.use(
-          enhanceMiddleware
-            ? enhanceMiddleware(metroMiddleware, metroServer)
-            : metroMiddleware
-        );
-      };
-      return undefined;
-    }
-  })();
-
-  // `createDevServerMiddleware` changed its return type in
-  // https://github.com/react-native-community/cli/pull/1560
-  let websocketEndpoints: RunServerOptions["websocketEndpoints"] = undefined;
-  let messageSocketEndpoint: DevServerMiddleware["messageSocketEndpoint"];
-  let reportEventDelegate: Reporter["update"] | undefined = undefined;
-
-  if (!hasAttachToServerFunction(devServer)) {
-    websocketEndpoints = devServer.websocketEndpoints;
-    messageSocketEndpoint = devServer.messageSocketEndpoint;
-
-    // bind our `reportEvent` delegate to the Metro server
-    reportEventDelegate = devServer.eventsSocketEndpoint.reportEvent;
-  }
-
-  const help = makeHelp(terminal, { hasDebugger: Boolean(coreDevMiddleware) });
-  const terminalReporter = makeReporter(
-    args.customLogReporterPath,
-    terminal,
-    projectRoot
-  );
-
-  // @ts-expect-error We want to override `reporter`
-  metroConfig.reporter = {
-    update(event: ReportableEvent) {
-      terminalReporter.update(event);
-      reportEventDelegate?.(event);
-      if (interactive && event.type === "dep_graph_loading") {
-        help();
-      }
-    },
-  };
-
-  const serverInstance = await startServer(metroConfig, {
-    host: args.host,
-    secure: args.https,
-    secureCert: args.cert,
-    secureKey: args.key,
-    ...(coreDevMiddleware
-      ? {
-          unstable_extraMiddleware: [
-            devServer.middleware,
-            indexPageMiddleware,
-            coreDevMiddleware.middleware,
-          ],
-          websocketEndpoints: {
-            ...websocketEndpoints,
-            ...coreDevMiddleware.websocketEndpoints,
-          },
-        }
-      : { websocketEndpoints }),
-  });
-
-  if (hasAttachToServerFunction(devServer)) {
-    const { messageSocket, eventsSocket } =
-      devServer.attachToServer(serverInstance);
-    messageSocketEndpoint = messageSocket;
-
-    // bind our `reportEvent` delegate to the Metro server
-    reportEventDelegate = eventsSocket.reportEvent;
-  } else {
-    // `messageSocketEndpoint` should already be set at this point. But this
-    // makes TypeScript happier.
-    messageSocketEndpoint = devServer.messageSocketEndpoint;
-  }
-
-  // In Node 8, the default keep-alive for an HTTP connection is 5 seconds. In
-  // early versions of Node 8, this was implemented in a buggy way which caused
-  // some HTTP responses (like those containing large JS bundles) to be
-  // terminated early.
-  //
-  // As a workaround, arbitrarily increase the keep-alive from 5 to 30 seconds,
-  // which should be enough to send even the largest of JS bundles.
-  //
-  // For more info: https://github.com/nodejs/node/issues/13391
-  //
-  serverInstance.keepAliveTimeout = 30000;
-
-  // in interactive mode, listen for keyboard events from stdin and bind
-  // them to specific actions.
-  if (interactive) {
-    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: asNumber,
-      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: asResolvedPath,
-    },
-    {
-      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) => asStringArray(val).map(asResolvedPath),
-    },
-    {
-      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: asStringArray,
-    },
-    {
-      name: "--sourceExts [list]",
-      description:
-        "Additional source-file extensions to include when generating bundles. Comma-separated list, excluding the leading dot.",
-      parse: asStringArray,
-    },
-    {
-      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: asNumber,
-    },
-    {
-      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: asResolvedPath,
-    },
-    {
-      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,137 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { error } from "@rnx-kit/console";
-import {
-  findPackageDir,
-  resolveDependencyChain,
-} from "@rnx-kit/tools-node/package";
-import { parsePlatform } from "@rnx-kit/tools-react-native/platform";
-
-type Args = {
-  platform: "android" | "ios" | "macos" | "windows" | "win32";
-};
-
-type Options = {
-  name: string;
-  description?: string;
-  parse?: (val: string) => unknown;
-  default?:
-    | string
-    | boolean
-    | number
-    | ((config: CLIConfig) => string | boolean | number);
-};
-
-const COMMAND_NAME = "rnx-test";
-const JEST_CLI = ["jest", "jest-cli"];
-
-export function rnxTest(
-  _argv: string[],
-  { root }: CLIConfig,
-  { platform }: Args
-): void {
-  const runJest: (argv: string[]) => void = (() => {
-    try {
-      const { run } = require(resolveDependencyChain(JEST_CLI, root));
-      return run;
-    } catch (e) {
-      error("'rnx-test' is unavailable because 'jest' is not installed");
-      throw e;
-    }
-  })();
-
-  const commandIndex = process.argv.indexOf(COMMAND_NAME);
-  if (commandIndex < 0) {
-    throw new Error("Failed to parse command arguments");
-  }
-
-  // Copy and remove the first arguments from `node react-native rnx-test ...`
-  const argv = process.argv.slice(commandIndex + 1);
-
-  const platformIndex = argv.indexOf("--platform");
-  if (platformIndex < 0) {
-    throw new Error("A target platform must be specified");
-  }
-
-  // Remove `--platform` otherwise Jest will complain about an unrecognized
-  // option. We can pass the rest of the arguments to Jest as they are.
-  argv.splice(platformIndex, 2);
-
-  process.env["RN_TARGET_PLATFORM"] = platform;
-  runJest(argv);
-}
-
-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(jestCliPath);
-      if (yargsOptions) {
-        return yargsOptions;
-      }
-    } catch (_) {
-      // ignore
-    }
-
-    // Starting with Jest 27, we are getting this error:
-    //
-    // Package subpath './build/cli/args' is not defined by "exports" in
-    // /~/node_modules/jest-cli/package.json
-    //
-    // To work around this, resolve `jest-cli` first, then use the resolved
-    // path to import `./build/cli/args`.
-    const jestPath = findPackageDir(jestCliPath) || "jest-cli";
-
-    try {
-      // `args.js` was moved in 29.2.0
-      // https://github.com/jestjs/jest/commit/2ecf723c50c5d25b2fe94e1ff8081f36aed9d67b
-      const { options } = require(`${jestPath}/build/args`);
-      return options;
-    } catch (_) {
-      // ignore
-    }
-
-    try {
-      const { options } = require(`${jestPath}/build/cli/args`);
-      return options;
-    } catch (_) {
-      // ignore
-    }
-
-    return {};
-  })();
-  return Object.keys(options).map((option) => {
-    const { alias, default: defaultValue, description, type } = options[option];
-    const name = `--${option} [${type}]`;
-    return {
-      name: alias ? `-${alias}, ${name}` : name,
-      description,
-      default: defaultValue,
-    };
-  });
-}
-
-export const rnxTestCommand = {
-  name: COMMAND_NAME,
-  description: "Test runner for React Native apps",
-  func: rnxTest,
-  options: [
-    {
-      name: "--platform [android|ios|macos|windows|win32]",
-      description: "Platform to target",
-      parse: parsePlatform,
-    },
-    ...jestOptions(),
-  ],
-};

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

@@ -1,85 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { writeThirdPartyNotices } from "@rnx-kit/third-party-notices";
-
-type CliThirdPartyNoticesOptions = {
-  rootPath: string;
-  sourceMapFile: string;
-  json: boolean;
-  outputFile?: string;
-  ignoreScopes?: string;
-  ignoreModules?: string;
-  preambleText?: string;
-  additionalText?: string;
-};
-
-export function rnxWriteThirdPartyNotices(
-  _argv: string[],
-  _config: CLIConfig,
-  {
-    additionalText,
-    ignoreModules,
-    ignoreScopes,
-    json,
-    outputFile,
-    preambleText,
-    rootPath,
-    sourceMapFile,
-  }: CliThirdPartyNoticesOptions
-): void {
-  // react-native-cli is not as rich as yargs, so we have to perform a mapping.
-  writeThirdPartyNotices({
-    rootPath,
-    sourceMapFile,
-    json,
-    outputFile,
-    ignoreScopes: ignoreScopes?.split(","),
-    ignoreModules: ignoreModules?.split(","),
-    preambleText: preambleText ? [preambleText] : undefined,
-    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,
-    },
-    {
-      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.",
-    },
-  ],
-};