@rnx-kit/tools-react-native/src/metro.ts

A collection of supplemental react-native functions and types

import { readPackage } from "@rnx-kit/tools-node/package";
import type { Module, ReadOnlyGraph, SerializerOptions } from "metro";
import { findCommunityCliPluginPath } from "./cli.ts";
import { resolveFrom } from "./resolve.ts";

// https://github.com/facebook/metro/blob/v0.83.2/packages/metro-runtime/src/modules/types.js
type Bundle = {
  modules: readonly [number, string][];
  post: string;
  pre: string;
};

// https://github.com/facebook/metro/blob/v0.83.2/packages/metro-runtime/src/modules/types.js
type BundleMetadata = {
  pre: number;
  post: number;
  modules: readonly [number, number][];
};

type MetroBaseJSBundle = (
  entryPoint: string,
  preModules: readonly Module[],
  graph: ReadOnlyGraph,
  options: SerializerOptions
) => Bundle;

type MetroBundleToString = (bundle: Bundle) => {
  code: string;
  metadata: BundleMetadata;
};

type MetroImport =
  | typeof import("metro")
  | /* typeof import("metro/private/DeltaBundler/Serializers/baseJSBundle") */ MetroBaseJSBundle
  | typeof import("metro/private/Server").default
  | typeof import("metro/private/lib/TerminalReporter").TerminalReporter
  | /* typeof import("metro/private/lib/bundleToString") */ MetroBundleToString
  | typeof import("metro/private/shared/output/bundle")
  | typeof import("metro-config")
  | typeof import("metro-core")
  | typeof import("metro-resolver")
  | typeof import("metro-source-map");

type MetroModule =
  | "metro"
  | "metro/src/DeltaBundler/Serializers/baseJSBundle"
  | "metro/src/Server"
  | "metro/src/lib/TerminalReporter"
  | "metro/src/lib/bundleToString"
  | "metro/src/shared/output/bundle"
  | "metro-config"
  | "metro-core"
  | "metro-resolver"
  | "metro-source-map";

const metroPathCache: Record<string, string | undefined> = {};

function findMetroPathInternal(projectRoot: string): string | undefined {
  const rnDir = resolveFrom("react-native", projectRoot);
  if (!rnDir) {
    return undefined;
  }

  // `metro` dependency was moved to `@react-native/community-cli-plugin` in 0.73
  // https://github.com/facebook/react-native/commit/fdcb94ad1310af6613cfb2a2c3f22f200bfa1c86
  const cliPluginDir = findCommunityCliPluginPath(projectRoot, rnDir);
  if (cliPluginDir) {
    return resolveFrom("metro", cliPluginDir);
  }

  const cliDir = resolveFrom("@react-native-community/cli", rnDir);
  if (!cliDir) {
    return undefined;
  }

  const cliMetroDir = resolveFrom(
    "@react-native-community/cli-plugin-metro",
    cliDir
  );
  return resolveFrom("metro", cliMetroDir || cliDir);
}

/**
 * Finds the installation path of Metro.
 * @param projectRoot The root of the project; defaults to the current working directory
 * @returns The path to the Metro installation; `undefined` if Metro could not be found
 */
export function findMetroPath(projectRoot = process.cwd()): string | undefined {
  if (projectRoot in metroPathCache) {
    return metroPathCache[projectRoot];
  }

  const p = findMetroPathInternal(projectRoot);
  metroPathCache[projectRoot] = p;
  return p;
}

/**
 * Returns Metro version number.
 * @param projectRoot The root of the project; defaults to the current working directory
 * @returns Metro version number; `undefined` if Metro could not be found
 */
export function getMetroVersion(
  projectRoot = process.cwd()
): string | undefined {
  const metroPath = findMetroPath(projectRoot);
  if (!metroPath) {
    return undefined;
  }

  const { version } = readPackage(metroPath);
  return version;
}

export function requireModuleFromMetro(
  moduleName: "metro",
  fromDir?: string
): typeof import("metro");

export function requireModuleFromMetro(
  moduleName: "metro/src/DeltaBundler/Serializers/baseJSBundle",
  fromDir?: string
): MetroBaseJSBundle;

export function requireModuleFromMetro(
  moduleName: "metro/src/Server",
  fromDir?: string
): typeof import("metro/private/Server").default;

export function requireModuleFromMetro(
  moduleName: "metro/src/lib/TerminalReporter",
  fromDir?: string
): typeof import("metro/private/lib/TerminalReporter").TerminalReporter;

export function requireModuleFromMetro(
  moduleName: "metro/src/lib/bundleToString",
  fromDir?: string
): MetroBundleToString;

export function requireModuleFromMetro(
  moduleName: "metro/src/shared/output/bundle",
  fromDir?: string
): typeof import("metro/private/shared/output/bundle");

export function requireModuleFromMetro(
  moduleName: "metro-config",
  fromDir?: string
): typeof import("metro-config");

export function requireModuleFromMetro(
  moduleName: "metro-core",
  fromDir?: string
): typeof import("metro-core");

export function requireModuleFromMetro(
  moduleName: "metro-resolver",
  fromDir?: string
): typeof import("metro-resolver");

export function requireModuleFromMetro(
  moduleName: "metro-source-map",
  fromDir?: string
): typeof import("metro-source-map");

/**
 * Imports specified module starting from the installation directory of the
 * currently used `metro` version.
 */
export function requireModuleFromMetro(
  moduleName: MetroModule,
  fromDir = process.cwd()
): MetroImport {
  const startDir = findMetroPath(fromDir);
  if (!startDir) {
    throw new Error("Cannot find module 'metro'");
  }

  const metroDir = "metro/";
  const modulePath = moduleName.startsWith(metroDir)
    ? `${startDir}/${moduleName.substring(metroDir.length)}`
    : resolveFrom(moduleName, startDir);
  if (!modulePath) {
    throw new Error(
      `Cannot find module '${moduleName}'. This probably means that ` +
        "'@rnx-kit/tools-react-native' is not compatible with the version " +
        "of 'metro' 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."
    );
  }

  const m = require(modulePath);
  return m.default ?? m;
}