@rnx-kit/cli 0.16.29 → 0.17.0

package/src/metro-config.ts

@@ -1,208 +0,0 @@
-import type { BundleParameters } from "@rnx-kit/config";
-import { warn } from "@rnx-kit/console";
-import { CyclicDependencies } from "@rnx-kit/metro-plugin-cyclic-dependencies-detector";
-import { DuplicateDependencies } from "@rnx-kit/metro-plugin-duplicates-checker";
-import { TypeScriptPlugin } from "@rnx-kit/metro-plugin-typescript";
-import type { MetroPlugin } from "@rnx-kit/metro-serializer";
-import { MetroSerializer } from "@rnx-kit/metro-serializer";
-import {
-  esbuildTransformerConfig,
-  MetroSerializer as MetroSerializerEsbuild,
-} from "@rnx-kit/metro-serializer-esbuild";
-import type { ConfigT, SerializerConfigT } from "metro-config";
-import type { WritableDeep } from "type-fest";
-import { getDefaultBundlerPlugins } from "./bundle/defaultPlugins";
-
-type MetroExtraParams = Pick<
-  BundleParameters,
-  | "detectCyclicDependencies"
-  | "detectDuplicateDependencies"
-  | "typescriptValidation"
-  | "plugins"
-  | "treeShake"
->;
-
-function resolvePlugin(name: string): string {
-  try {
-    return require.resolve(name);
-  } catch (_) {
-    return require.resolve(name, { paths: [process.cwd()] });
-  }
-}
-
-function importPlugin(name: string) {
-  const plugin = require(resolvePlugin(name));
-  return plugin.default || plugin;
-}
-
-function readLegacyOptions({
-  detectCyclicDependencies,
-  detectDuplicateDependencies,
-  typescriptValidation,
-}: MetroExtraParams): string | undefined {
-  const oldOptions = [];
-  const deprecatedOptions: Record<string, Record<string, unknown> | true> = {};
-
-  if (detectCyclicDependencies) {
-    oldOptions.push("detectCyclicDependencies");
-    deprecatedOptions["@rnx-kit/metro-plugin-cyclic-dependencies-detector"] =
-      detectCyclicDependencies;
-  }
-  if (detectDuplicateDependencies) {
-    oldOptions.push("detectDuplicateDependencies");
-    deprecatedOptions["@rnx-kit/metro-plugin-duplicates-checker"] =
-      detectDuplicateDependencies;
-  }
-  if (typescriptValidation) {
-    oldOptions.push("typescriptValidation");
-    deprecatedOptions["@rnx-kit/metro-plugin-typescript"] =
-      typescriptValidation;
-  }
-
-  if (oldOptions.length === 0) {
-    return undefined;
-  }
-
-  return (
-    `'${oldOptions.join("', '")}' have been replaced by a new 'plugins' ` +
-    "option. Below is an equivalent config:\n" +
-    "\n" +
-    '    "plugins": [\n' +
-    Object.entries(deprecatedOptions)
-      .map(([name, options]) => {
-        if (typeof options === "object") {
-          const json = JSON.stringify(options, null, 2)
-            .split("\n")
-            .join("\n      ");
-          return `      ["${name}", ${json}]`;
-        } else {
-          return `      "${name}"`;
-        }
-      })
-      .join(",\n") +
-    "\n" +
-    "    ]\n" +
-    "\n" +
-    "For more details, see " +
-    "https://github.com/microsoft/rnx-kit/tree/main/packages/cli#readme"
-  );
-}
-
-/**
- * Customize the Metro configuration.
- *
- * @param metroConfigReadonly Metro configuration
- * @param extraParams Parameters used to further customize Metro configuration
- * @param print Optional function to use when printing status messages to the Metro console
- */
-export function customizeMetroConfig(
-  metroConfigReadonly: ConfigT,
-  extraParams: MetroExtraParams,
-  print?: (message: string) => void
-): void {
-  // We will be making changes to the Metro configuration. Coerce from a type
-  // with readonly props to a type where the props are writeable.
-  const metroConfig = metroConfigReadonly as WritableDeep<ConfigT>;
-
-  const metroPlugins: MetroPlugin[] = [];
-  const serializerHooks: Record<
-    string,
-    SerializerConfigT["experimentalSerializerHook"]
-  > = {};
-
-  const legacyWarning = readLegacyOptions(extraParams);
-  if (legacyWarning) {
-    warn(legacyWarning);
-
-    const {
-      detectCyclicDependencies,
-      detectDuplicateDependencies,
-      typescriptValidation,
-    } = extraParams;
-
-    if (typeof detectDuplicateDependencies === "object") {
-      metroPlugins.push(DuplicateDependencies(detectDuplicateDependencies));
-    } else if (detectDuplicateDependencies !== false) {
-      metroPlugins.push(DuplicateDependencies());
-    }
-
-    if (typeof detectCyclicDependencies === "object") {
-      metroPlugins.push(CyclicDependencies(detectCyclicDependencies));
-    } else if (detectCyclicDependencies !== false) {
-      metroPlugins.push(CyclicDependencies());
-    }
-
-    if (typescriptValidation !== false) {
-      const plugin = TypeScriptPlugin(typescriptValidation, print);
-      serializerHooks["@rnx-kit/metro-plugin-typescript"] = plugin;
-    }
-  } else {
-    const plugins = extraParams.plugins || getDefaultBundlerPlugins().plugins;
-    for (const entry of plugins) {
-      const [module, options] = Array.isArray(entry)
-        ? entry
-        : [entry, undefined];
-      const plugin = importPlugin(module);
-      switch (plugin.type) {
-        case "serializer":
-          metroPlugins.push(plugin(options));
-          break;
-
-        case "serializerHook":
-          serializerHooks[module] = plugin(options, print);
-          break;
-
-        default:
-          throw new Error(`${module}: unknown plugin type: ${plugin.type}`);
-      }
-    }
-  }
-
-  if (extraParams.treeShake) {
-    if (metroConfig.serializer.customSerializer) {
-      warn(
-        "`serializer.customSerializer` in `metro.config.js` will be overwritten to enable tree shaking"
-      );
-    }
-    metroConfig.serializer.customSerializer = MetroSerializerEsbuild(
-      metroPlugins,
-      typeof extraParams.treeShake === "object"
-        ? extraParams.treeShake
-        : undefined
-    );
-    Object.assign(metroConfig.transformer, esbuildTransformerConfig);
-  } else if (metroPlugins.length > 0) {
-    // MetroSerializer acts as a CustomSerializer, and it works with both
-    // older and newer versions of Metro. Older versions expect a return
-    // value, while newer versions expect a promise.
-    //
-    // Its return type is the union of both the value and the promise.
-    // This makes TypeScript upset because for any given version of Metro,
-    // it's one or the other. Not both.
-    //
-    // Since it can handle either scenario, just coerce it to whatever
-    // the current version of Metro expects.
-    metroConfig.serializer.customSerializer = MetroSerializer(
-      metroPlugins
-    ) as SerializerConfigT["customSerializer"];
-  } else {
-    // @ts-expect-error We don't want this set if unused
-    delete metroConfig.serializer.customSerializer;
-  }
-
-  const hooks = Object.values(serializerHooks);
-  switch (hooks.length) {
-    case 0:
-      break;
-    case 1:
-      metroConfig.serializer.experimentalSerializerHook = hooks[0];
-      break;
-    default:
-      metroConfig.serializer.experimentalSerializerHook = (graph, delta) => {
-        for (const hook of hooks) {
-          hook(graph, delta);
-        }
-      };
-      break;
-  }
-}

package/src/parsers.ts

@@ -1,44 +0,0 @@
-import type { TransformProfile } from "metro-babel-transformer";
-import * as path from "path";
-
-export function asBoolean(value: string): boolean {
-  switch (value) {
-    case "false":
-      return false;
-    case "true":
-      return true;
-    default:
-      throw new Error(
-        "Invalid boolean value '" + value + "' — must be true or false"
-      );
-  }
-}
-
-export function asNumber(value: string): number {
-  return Number(value);
-}
-
-export function asResolvedPath(value: string): string {
-  return path.resolve(value);
-}
-
-export function asStringArray(value: string): string[] {
-  return value.split(",");
-}
-
-export function parseTransformProfile(val: string): TransformProfile {
-  const allowedProfiles: TransformProfile[] = [
-    "hermes-stable",
-    "hermes-canary",
-    "default",
-  ];
-  if (val in allowedProfiles) {
-    return val as TransformProfile;
-  }
-  throw new Error(
-    "Invalid transform profile '" +
-      val +
-      "' -- must be one of " +
-      allowedProfiles.join(", ")
-  );
-}

package/src/ram-bundle.ts

@@ -1,78 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { info } from "@rnx-kit/console";
-import { loadMetroConfig, ramBundle } from "@rnx-kit/metro-service";
-import { commonBundleCommandOptions } from "./bundle/cliOptions";
-import { getCliPlatformBundleConfigs } from "./bundle/kit-config";
-import { metroBundle } from "./bundle/metro";
-import {
-  applyBundleConfigOverrides,
-  overridableCommonBundleOptions,
-} from "./bundle/overrides";
-import type {
-  CLICommonBundleOptions,
-  CliPlatformBundleConfig,
-} from "./bundle/types";
-
-type CLIRamBundleOptions = CLICommonBundleOptions & {
-  indexedRamBundle?: boolean;
-};
-
-function disableTreeShaking(configs: CliPlatformBundleConfig[]): void {
-  const wasEnabled = configs.reduce((modified, config) => {
-    if (config.treeShake) {
-      config.treeShake = false;
-      return true;
-    }
-    return modified;
-  }, false);
-  if (wasEnabled) {
-    info(
-      "`treeShake` was disabled because it is not compatible with the RAM bundle format"
-    );
-  }
-}
-
-export async function rnxRamBundle(
-  _argv: string[],
-  cliConfig: CLIConfig,
-  cliOptions: CLIRamBundleOptions
-): Promise<void> {
-  const metroConfig = await loadMetroConfig(cliConfig, cliOptions);
-
-  const bundleConfigs = getCliPlatformBundleConfigs(
-    cliOptions.id,
-    cliOptions.platform
-  );
-
-  applyBundleConfigOverrides(cliOptions, bundleConfigs, [
-    ...overridableCommonBundleOptions,
-    "indexedRamBundle",
-  ]);
-
-  disableTreeShaking(bundleConfigs);
-
-  for (const bundleConfig of bundleConfigs) {
-    await metroBundle(
-      metroConfig,
-      bundleConfig,
-      cliOptions.dev,
-      cliOptions.minify,
-      ramBundle
-    );
-  }
-}
-
-export const rnxRamBundleCommand = {
-  name: "rnx-ram-bundle",
-  description:
-    "Bundle your rnx-kit package in the RAM bundle format for offline use. See https://aka.ms/rnx-kit.",
-  func: rnxRamBundle,
-  options: [
-    ...commonBundleCommandOptions,
-    {
-      name: "--indexed-ram-bundle",
-      description:
-        'Force the "Indexed RAM" bundle file format, even when targeting Android.',
-    },
-  ],
-};

package/src/serve/external.ts

@@ -1,62 +0,0 @@
-import { resolveDependencyChain } from "@rnx-kit/tools-node/package";
-import type { CliServerApi, CoreDevMiddleware } from "./types";
-
-type CliClean = typeof import("@react-native-community/cli-clean");
-
-type ExternalModule =
-  | "@react-native-community/cli-clean"
-  | "@react-native-community/cli-server-api"
-  | "@react-native/dev-middleware";
-
-function friendlyRequire<T>(...modules: string[]): T {
-  try {
-    const modulePath = resolveDependencyChain(modules);
-    return require(modulePath) as T;
-  } catch (_) {
-    const module = modules[modules.length - 1];
-    throw new Error(
-      `Cannot find module '${module}'. This probably means that ` +
-        "'@rnx-kit/cli' is not compatible with the version of 'react-native' " +
-        "that you are currently using. Please update to the latest version " +
-        "and try again. If the issue still persists after the update, please " +
-        "file a bug at https://github.com/microsoft/rnx-kit/issues."
-    );
-  }
-}
-
-export function requireExternal(
-  module: "@react-native-community/cli-clean"
-): CliClean;
-
-export function requireExternal(
-  module: "@react-native-community/cli-server-api"
-): CliServerApi;
-
-export function requireExternal(
-  module: "@react-native/dev-middleware"
-): CoreDevMiddleware;
-
-export function requireExternal(
-  module: ExternalModule
-): CliClean | CliServerApi | CoreDevMiddleware {
-  switch (module) {
-    case "@react-native-community/cli-clean":
-      return friendlyRequire<CliClean>(
-        "react-native",
-        "@react-native-community/cli",
-        "@react-native-community/cli-clean"
-      );
-    case "@react-native-community/cli-server-api":
-      return friendlyRequire<CliServerApi>(
-        "react-native",
-        "@react-native-community/cli",
-        "@react-native-community/cli-server-api"
-      );
-    case "@react-native/dev-middleware":
-      return friendlyRequire<CoreDevMiddleware>(
-        "react-native",
-        "@react-native/community-cli-plugin",
-        "@react-native/dev-middleware"
-      );
-  }
-}

package/src/serve/help.ts

@@ -1,59 +0,0 @@
-import { dim } from "@rnx-kit/console";
-import type { MetroTerminal } from "@rnx-kit/metro-service";
-
-type HelpOptions = {
-  hasDebugger: boolean;
-};
-
-type MenuItem = [string, string];
-
-export function makeHelp(
-  terminal: MetroTerminal["terminal"],
-  { hasDebugger }: HelpOptions
-): () => void {
-  const openDebugger: MenuItem | null = hasDebugger
-    ? ["J", "Open debugger"]
-    : null;
-
-  const menuItems: ("" | MenuItem)[] = [
-    ["D", "Open developer menu"],
-    ...(openDebugger ? [openDebugger] : []),
-    ["Q", "Show bundler address QR code"],
-    ["R", "Reload the app"],
-    "",
-    ["H", "Show this help message"],
-    ["Ctrl-C", "Quit"],
-  ];
-
-  const margin = 4;
-  const maxColumnWidth = (index: number) => {
-    return (max: number, item: (typeof menuItems)[number]) => {
-      if (!item) {
-        return max;
-      }
-
-      const width = item[index].length;
-      return width > max ? width : max;
-    };
-  };
-
-  const keyWidth = menuItems.reduce(maxColumnWidth(0), 0);
-  const labelWidth = menuItems.reduce(maxColumnWidth(1), 0);
-  const separator = `┠${"─".repeat(labelWidth + keyWidth + margin + 1)}`;
-
-  const lines = menuItems.map((item) => {
-    if (!item) {
-      return separator;
-    }
-
-    const [key, label] = item;
-    const labelPadding = labelWidth - label.length;
-    const keyPadding = keyWidth - key.length;
-    const padding = " ".repeat(labelPadding + keyPadding + margin);
-    return `┃ ${dim(label)}${padding}${key}`;
-  });
-  lines.push("");
-
-  const help = lines.join("\n");
-  return () => terminal.log(help);
-}

package/src/serve/keyboard.ts

@@ -1,76 +0,0 @@
-import { info } from "@rnx-kit/console";
-import type { MetroTerminal } from "@rnx-kit/metro-service";
-import nodeFetch from "node-fetch";
-import qrcode from "qrcode";
-import readline from "readline";
-import type { DevServerMiddleware } from "./types";
-
-type Options = {
-  devServerUrl: string;
-  help: () => void;
-  messageSocketEndpoint: DevServerMiddleware["messageSocketEndpoint"];
-  terminal: MetroTerminal["terminal"];
-};
-
-export function attachKeyHandlers({
-  devServerUrl,
-  help,
-  messageSocketEndpoint,
-  terminal,
-}: Options) {
-  process.stdin.setRawMode(true);
-  process.stdin.on("keypress", (_key, data) => {
-    const { ctrl, name } = data;
-    if (ctrl === true) {
-      switch (name) {
-        case "c":
-          info("Exiting...");
-          process.exit();
-          break;
-        case "z":
-          process.emit("SIGTSTP", "SIGTSTP");
-          break;
-      }
-    } else {
-      switch (name) {
-        case "d":
-          info("Opening developer menu...");
-          messageSocketEndpoint.broadcast("devMenu", undefined);
-          break;
-
-        case "h":
-          help();
-          break;
-
-        case "j": {
-          info("Opening debugger...");
-          // TODO: Remove `node-fetch` when we drop support for Node 16
-          const ftch = "fetch" in globalThis ? fetch : nodeFetch;
-          ftch(devServerUrl + "/open-debugger", { method: "POST" });
-          break;
-        }
-
-        case "q": {
-          const url = `${devServerUrl}/index.bundle`;
-          qrcode.toString(url, { type: "terminal" }, (_err, qr) => {
-            terminal.log("");
-            terminal.log(url + ":");
-            terminal.log(qr);
-          });
-          break;
-        }
-
-        case "r":
-          info("Reloading app...");
-          messageSocketEndpoint.broadcast("reload", undefined);
-          break;
-
-        case "return":
-          terminal.log("");
-          break;
-      }
-    }
-  });
-
-  readline.emitKeypressEvents(process.stdin);
-}

package/src/serve/kit-config.ts

@@ -1,47 +0,0 @@
-import type { ServerConfig } from "@rnx-kit/config";
-import { getBundleConfig, getKitConfig } from "@rnx-kit/config";
-import { pickValues } from "@rnx-kit/tools-language/properties";
-import { getDefaultBundlerPlugins } from "../bundle/defaultPlugins";
-
-type ServerConfigOverrides = {
-  projectRoot?: string;
-  assetPlugins?: string[];
-  sourceExts?: string[];
-  id?: string;
-};
-
-type CliServerConfig = ServerConfig & {
-  plugins: Required<ServerConfig>["plugins"];
-  treeShake: false;
-};
-
-/**
- * Get the server configuration from the rnx-kit configuration. Apply any overrides.
- *
- * @param overrides Overrides to apply. These take precedence over the values in the rnx-kit configuration.
- * @returns Server configuration
- */
-export function getKitServerConfig(
-  overrides: ServerConfigOverrides
-): CliServerConfig {
-  const kitConfig = getKitConfig();
-  let serverConfig = kitConfig?.server;
-  if (!serverConfig && kitConfig) {
-    const maybeBundleConfig = getBundleConfig(kitConfig, overrides?.id);
-    if (maybeBundleConfig) {
-      serverConfig = pickValues(maybeBundleConfig, [
-        "detectCyclicDependencies",
-        "detectDuplicateDependencies",
-        "typescriptValidation",
-        "plugins",
-      ]);
-    }
-  }
-
-  return {
-    ...getDefaultBundlerPlugins(),
-    ...serverConfig,
-    treeShake: false, // tree shaking does not work with the bundle server
-    ...pickValues(overrides, ["projectRoot", "assetPlugins", "sourceExts"]),
-  };
-}

package/src/serve/types.ts

@@ -1,87 +0,0 @@
-import type * as logger from "@rnx-kit/console";
-import type { Server as Middleware } from "connect";
-import type { Server as HttpServer } from "http";
-import type { Server as HttpsServer } from "https";
-import type { RunServerOptions } from "metro";
-
-// https://github.com/react-native-community/cli/blob/11.x/packages/cli-server-api/src/index.ts#L32
-type MiddlewareOptions = {
-  host?: string;
-  watchFolders: readonly string[];
-  port: number;
-};
-
-type WebSocketServer = Required<RunServerOptions>["websocketEndpoints"][string];
-
-export type DevServerMiddleware = {
-  websocketEndpoints: RunServerOptions["websocketEndpoints"];
-  debuggerProxyEndpoint: {
-    server: WebSocketServer;
-    isDebuggerConnected: () => boolean;
-  };
-  messageSocketEndpoint: {
-    server: WebSocketServer;
-    broadcast: (method: string, params?: Record<string, unknown>) => void;
-  };
-  eventsSocketEndpoint: {
-    server: WebSocketServer;
-    reportEvent: (event: unknown) => void;
-  };
-  middleware: Middleware;
-};
-
-export type DevServerMiddleware6 = Pick<DevServerMiddleware, "middleware"> & {
-  attachToServer: (server: HttpServer | HttpsServer) => {
-    debuggerProxy: DevServerMiddleware["debuggerProxyEndpoint"];
-    eventsSocket: DevServerMiddleware["eventsSocketEndpoint"];
-    messageSocket: DevServerMiddleware["messageSocketEndpoint"];
-  };
-};
-
-/** `@react-native-community/cli-server-api` */
-export type CliServerApi = {
-  createDevServerMiddleware: (
-    options: MiddlewareOptions
-  ) => DevServerMiddleware | DevServerMiddleware6;
-  indexPageMiddleware: Middleware;
-};
-
-// https://github.com/facebook/react-native/blob/d208dc422c9239d126e0da674451c5898d57319d/packages/community-cli-plugin/src/commands/start/runServer.js#L32
-export type StartCommandArgs = {
-  assetPlugins?: string[];
-  cert?: string;
-  customLogReporterPath?: string;
-  host?: string;
-  https?: boolean;
-  maxWorkers?: number;
-  key?: string;
-  platforms?: string[];
-  port?: number;
-  resetCache?: boolean;
-  sourceExts?: string[];
-  transformer?: string;
-  watchFolders?: string[];
-  config?: string;
-  projectRoot?: string;
-  interactive: boolean;
-};
-
-// https://github.com/facebook/react-native/blob/3e7a873f2d1c5170a7f4c88064897e74a149c5d5/packages/dev-middleware/src/createDevMiddleware.js#L40
-type DevMiddlewareAPI = {
-  middleware: Middleware;
-  websocketEndpoints: RunServerOptions["websocketEndpoints"];
-};
-
-type DevMiddlewareOptions = {
-  projectRoot: string;
-  serverBaseUrl: string;
-  logger?: typeof logger;
-  unstable_browserLauncher?: unknown;
-  unstable_eventReporter?: unknown;
-  unstable_experiments?: unknown;
-};
-
-/** `@react-native/dev-middleware` */
-export type CoreDevMiddleware = {
-  createDevMiddleware: (options: DevMiddlewareOptions) => DevMiddlewareAPI;
-};