@rnx-kit/cli 0.16.28 → 0.16.30

package/lib/write-third-party-notices.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.rnxWriteThirdPartyNoticesCommand = exports.rnxWriteThirdPartyNotices = void 0;
+exports.rnxWriteThirdPartyNoticesCommand = void 0;
+exports.rnxWriteThirdPartyNotices = rnxWriteThirdPartyNotices;
 const third_party_notices_1 = require("@rnx-kit/third-party-notices");
 function rnxWriteThirdPartyNotices(_argv, _config, { additionalText, ignoreModules, ignoreScopes, json, outputFile, preambleText, rootPath, sourceMapFile, }) {
     // react-native-cli is not as rich as yargs, so we have to perform a mapping.
@@ -15,7 +16,6 @@ function rnxWriteThirdPartyNotices(_argv, _config, { additionalText, ignoreModul
         additionalText: additionalText ? [additionalText] : undefined,
     });
 }
-exports.rnxWriteThirdPartyNotices = rnxWriteThirdPartyNotices;
 exports.rnxWriteThirdPartyNoticesCommand = {
     name: "rnx-write-third-party-notices",
     description: "Writes third party notices based on the given bundle",
@@ -23,36 +23,36 @@ exports.rnxWriteThirdPartyNoticesCommand = {
     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.",
+            description: "The root of the repo — 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.",
+            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.",
+            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: "--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-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: "--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: "--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: "--additional-text <string>",
+            description: "A string to append to the end of the 3rd-party notice",
         },
     ],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rnx-kit/cli",
-  "version": "0.16.28",
+  "version": "0.16.30",
   "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",
@@ -11,8 +11,7 @@
   "files": [
     "lib/**/*.d.ts",
     "lib/**/*.js",
-    "react-native.config.js",
-    "src"
+    "react-native.config.js"
   ],
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -21,8 +20,8 @@
       "types": "./lib/index.d.ts",
       "default": "./lib/index.js"
     },
-    "./package.json": "./package.json",
-    "./react-native.config.js": "./react-native.config.js"
+    "./react-native.config.js": "./react-native.config.js",
+    "./package.json": "./package.json"
   },
   "repository": {
     "type": "git",
@@ -44,12 +43,12 @@
     "@rnx-kit/metro-plugin-duplicates-checker": "^2.1.1",
     "@rnx-kit/metro-plugin-typescript": "^0.4.4",
     "@rnx-kit/metro-serializer": "^1.0.14",
-    "@rnx-kit/metro-serializer-esbuild": "^0.1.31",
+    "@rnx-kit/metro-serializer-esbuild": "^0.1.36",
     "@rnx-kit/metro-service": "^3.1.6",
     "@rnx-kit/third-party-notices": "^1.3.4",
     "@rnx-kit/tools-language": "^2.0.0",
     "@rnx-kit/tools-node": "^2.1.1",
-    "@rnx-kit/tools-react-native": "^1.3.5",
+    "@rnx-kit/tools-react-native": "^1.4.0",
     "fs-extra": "^10.0.0",
     "node-fetch": "^2.6.7",
     "ora": "^5.4.1",
@@ -71,7 +70,6 @@
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "^7.20.0",
-    "@react-native-community/cli-clean": "^12.3.0",
     "@react-native-community/cli-types": "^12.3.0",
     "@rnx-kit/eslint-config": "*",
     "@rnx-kit/jest-preset": "*",

package/lib/serve/external.d.ts

@@ -1,7 +0,0 @@
-import type { CliServerApi, CoreDevMiddleware } from "./types";
-type CliClean = typeof import("@react-native-community/cli-clean");
-export declare function requireExternal(module: "@react-native-community/cli-clean"): CliClean;
-export declare function requireExternal(module: "@react-native-community/cli-server-api"): CliServerApi;
-export declare function requireExternal(module: "@react-native/dev-middleware"): CoreDevMiddleware;
-export {};
-//# sourceMappingURL=external.d.ts.map

package/src/align-deps.ts

@@ -1,83 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { cli, cliOptions } from "@rnx-kit/align-deps";
-import { pickValues } from "@rnx-kit/tools-language/properties";
-
-type CLIArgs = Record<string, string | number | boolean | undefined>;
-
-const optionsMap: Partial<Record<keyof typeof cliOptions, string>> = {
-  "exclude-packages": "excludePackages",
-  init: "init",
-  presets: "presets",
-  requirements: "requirements",
-  "set-version": "setVersion",
-};
-
-export function rnxAlignDeps(
-  argv: string[],
-  _config: CLIConfig,
-  args: CLIArgs
-): void {
-  cli({
-    ...pickValues(args, Object.values(optionsMap), Object.keys(optionsMap)),
-    "diff-mode": args.diffMode?.toString(),
-    loose: Boolean(args.loose),
-    "migrate-config": Boolean(args.migrateConfig),
-    "no-unmanaged": Boolean(args.noUnmanaged),
-    verbose: Boolean(args.verbose),
-    write: Boolean(args.write),
-    packages: argv,
-  });
-}
-
-export const rnxAlignDepsCommand = {
-  name: "rnx-align-deps",
-  description:
-    "Manage dependencies within a repository and across many repositories",
-  func: rnxAlignDeps,
-  options: [
-    {
-      name: `--diff-mode [${cliOptions["diff-mode"].choices.join("|")}]`,
-      description: cliOptions["diff-mode"].description,
-    },
-    {
-      name: "--exclude-packages [packages]",
-      description: cliOptions["exclude-packages"].description,
-    },
-    {
-      name: `--init [${cliOptions.init.choices?.join("|")}]`,
-      description: cliOptions.init.description,
-    },
-    {
-      name: "--loose",
-      description: cliOptions.loose.description,
-    },
-    {
-      name: "--migrate-config",
-      description: cliOptions["migrate-config"].description,
-    },
-    {
-      name: "--no-unmanaged",
-      description: cliOptions["no-unmanaged"].description,
-    },
-    {
-      name: "--presets [presets]",
-      description: cliOptions.presets.description,
-    },
-    {
-      name: "--requirements [requirements]",
-      description: cliOptions.requirements.description,
-    },
-    {
-      name: "--set-version [versions]",
-      description: cliOptions["set-version"].description,
-    },
-    {
-      name: "--verbose",
-      description: cliOptions.verbose.description,
-    },
-    {
-      name: "--write",
-      description: cliOptions.write.description,
-    },
-  ],
-};

package/src/bundle/cliOptions.ts

@@ -1,82 +0,0 @@
-import { parsePlatform } from "@rnx-kit/tools-react-native/platform";
-import { asBoolean, asNumber, parseTransformProfile } from "../parsers";
-
-export const commonBundleCommandOptions = [
-  {
-    name: "--id [id]",
-    description:
-      "Target bundle definition. This is only needed when the rnx-kit configuration has multiple bundle definitions.",
-  },
-  {
-    name: "--entry-file [path]",
-    description:
-      "Path to the root JavaScript or TypeScript file, either absolute or relative to the package.",
-  },
-  {
-    name: "--platform [ios|android|windows|win32|macos]",
-    description:
-      "Target platform. When not given, all platforms in the rnx-kit configuration are bundled.",
-    parse: parsePlatform,
-  },
-  {
-    name: "--dev [boolean]",
-    description: "If false, warnings are disabled and the bundle is minified.",
-    default: true,
-    parse: asBoolean,
-  },
-  {
-    name: "--minify [boolean]",
-    description:
-      "Controls whether or not the bundle is minified. Disabling minification is useful for test builds.",
-    parse: asBoolean,
-  },
-  {
-    name: "--bundle-output [string]",
-    description:
-      "Path to the output bundle file, either absolute or relative to the package.",
-  },
-  {
-    name: "--bundle-encoding [utf8|utf16le|ascii]",
-    description: "Character encoding to use when writing the bundle file.",
-    default: "utf8",
-  },
-  {
-    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: "--sourcemap-output [string]",
-    description:
-      "Path where the bundle source map is written, either absolute or relative to the package.",
-  },
-  {
-    name: "--sourcemap-sources-root [string]",
-    description:
-      "Path to use when relativizing file entries in the bundle source map.",
-  },
-  {
-    name: "--sourcemap-use-absolute-path",
-    description: "Report SourceMapURL using its full path",
-  },
-  {
-    name: "--assets-dest [path]",
-    description:
-      "Path where bundle assets like images are written, either absolute or relative to the package. If not given, assets are ignored.",
-  },
-  {
-    name: "--unstable-transform-profile [string]",
-    description:
-      "Experimental, transform JS for a specific JS engine. Currently supported: hermes, hermes-canary, default",
-    parse: parseTransformProfile,
-  },
-  {
-    name: "--reset-cache",
-    description: "Reset the Metro cache.",
-  },
-  {
-    name: "--config [string]",
-    description: "Path to the Metro configuration file.",
-  },
-];

package/src/bundle/defaultPlugins.ts

@@ -1,16 +0,0 @@
-import type { BundleParameters } from "@rnx-kit/config";
-
-type DefaultPlugins = Pick<Required<BundleParameters>, "plugins" | "treeShake">;
-
-const defaultPlugins: DefaultPlugins = {
-  plugins: [
-    "@rnx-kit/metro-plugin-cyclic-dependencies-detector",
-    "@rnx-kit/metro-plugin-duplicates-checker",
-    "@rnx-kit/metro-plugin-typescript",
-  ],
-  treeShake: false,
-};
-
-export function getDefaultBundlerPlugins(): DefaultPlugins {
-  return defaultPlugins;
-}

package/src/bundle/hermes.ts

@@ -1,114 +0,0 @@
-import type { HermesOptions } from "@rnx-kit/config";
-import { error, info } from "@rnx-kit/console";
-import { findPackageDependencyDir } from "@rnx-kit/tools-node/package";
-import { requireModuleFromMetro } from "@rnx-kit/tools-react-native/metro";
-import { spawnSync } from "child_process";
-import * as fs from "fs";
-import * as os from "os";
-import * as path from "path";
-
-function hermesBinaryInDir(hermesc: string): string | null {
-  switch (os.platform()) {
-    case "darwin":
-      return path.join(hermesc, "osx-bin", "hermesc");
-    case "linux":
-      return path.join(hermesc, "linux64-bin", "hermesc");
-    case "win32":
-      return path.join(hermesc, "win64-bin", "hermesc.exe");
-    default:
-      return null;
-  }
-}
-
-function findHermesBinary() {
-  const locations = [
-    () => {
-      const rnPath = findPackageDependencyDir("react-native");
-      if (!rnPath) {
-        throw new Error("Cannot find module 'react-native'");
-      }
-      return path.join(rnPath, "sdks", "hermesc");
-    },
-    () => findPackageDependencyDir("hermes-engine"),
-  ];
-
-  for (const getLocation of locations) {
-    const location = getLocation();
-    if (location) {
-      const hermesc = hermesBinaryInDir(location);
-      if (hermesc && fs.existsSync(hermesc)) {
-        return hermesc;
-      }
-    }
-  }
-
-  return null;
-}
-
-function getOutput(args: string[]): string | null {
-  const length = args.length;
-  for (let i = 0; i < length; ++i) {
-    const flag = args[i];
-    if (flag === "-out") {
-      return args[i + 1];
-    } else if (flag.startsWith("-out=")) {
-      return flag.substring(5);
-    }
-  }
-  return null;
-}
-
-export function emitBytecode(
-  input: string,
-  sourcemap: string | undefined,
-  options: HermesOptions
-): void {
-  const cmd = options.command || findHermesBinary();
-  if (!cmd) {
-    error("No Hermes compiler was found");
-    return;
-  }
-
-  const args = [
-    "-emit-binary",
-    // If Hermes can't detect the width of the terminal, it will set the limit
-    // to "unlimited". Since we might be passing a minified bundle to Hermes,
-    // limit output width to avoid issues when it outputs diagnostics. See:
-    //   - https://github.com/microsoft/rnx-kit/issues/2416
-    //   - https://github.com/microsoft/rnx-kit/issues/2419
-    //   - https://github.com/microsoft/rnx-kit/issues/2424
-    "-max-diagnostic-width=80",
-    ...(options.flags ?? ["-O", "-output-source-map", "-w"]),
-  ];
-
-  let output = getOutput(args);
-  if (!output) {
-    output = input + ".hbc";
-    args.push("-out", output);
-  }
-
-  args.push(input);
-
-  info("Emitting bytecode to:", output);
-  const result = spawnSync(cmd, args, { stdio: "inherit" });
-  if (result.status !== 0) {
-    throw result.error;
-  }
-
-  if (sourcemap && args.includes("-output-source-map")) {
-    const outputMap = output + ".map";
-    info(`Combining source maps: ${sourcemap} + ${outputMap}`);
-
-    const options = { encoding: "utf-8" } as const;
-    const packagerSourcemap = JSON.parse(fs.readFileSync(sourcemap, options));
-    const compilerSourcemap = JSON.parse(fs.readFileSync(outputMap, options));
-
-    // `composeSourceMaps` was introduced in 0.56 — see
-    // https://github.com/facebook/metro/commit/6017085bdad96ca5cec39d50038eb5622ce1097b
-    // @ts-expect-error Property 'composeSourceMaps' does not exist
-    const { composeSourceMaps } = requireModuleFromMetro("metro-source-map");
-
-    const composed = composeSourceMaps([packagerSourcemap, compilerSourcemap]);
-    fs.writeFileSync(outputMap, JSON.stringify(composed));
-  }
-}

package/src/bundle/kit-config.ts

@@ -1,81 +0,0 @@
-import {
-  getBundleConfig,
-  getKitConfig,
-  getPlatformBundleConfig,
-} from "@rnx-kit/config";
-import type { AllPlatforms } from "@rnx-kit/tools-react-native/platform";
-import { getDefaultBundlerPlugins } from "./defaultPlugins";
-import type { CliPlatformBundleConfig } from "./types";
-
-/**
- * Get the list of target platforms for bundling.
- *
- * @param overridePlatform Override platform, typically from the command-line. When given, this overrides the list of target platforms.
- * @param targetPlatforms Target platforms, typically from the kit configuration.
- * @returns Array of target platforms
- */
-export function getTargetPlatforms(
-  overridePlatform?: AllPlatforms,
-  targetPlatforms?: AllPlatforms[]
-): AllPlatforms[] {
-  if (overridePlatform) {
-    return [overridePlatform];
-  }
-  if (targetPlatforms && targetPlatforms.length > 0) {
-    return targetPlatforms;
-  }
-  throw new Error(
-    "No target platforms given. Update the rnx-kit configuration to include a target platform, or provide a target platform on the command-line."
-  );
-}
-
-function getDefaultBundleParameters(platform: string) {
-  const extension =
-    platform === "ios" || platform === "macos" ? "jsbundle" : "bundle";
-
-  return {
-    entryFile: "index.js",
-    bundleOutput: `index.${platform}.${extension}`,
-    sourcemapUseAbsolutePath: false,
-  };
-}
-
-/**
- * Get the bundle configuration and target platform(s) from the rnx-kit
- * configuration. Use them to create an array of platform-specific
- * bundle configurations.
- *
- * If an id is given, search for the matching bundle definition. Otherwise, use the first bundle definition.
- *
- * @param id Optional identity of the target bundle definition to return
- * @param overridePlatform Override platform, typically from the command-line. When given, this overrides the list of target platforms.
- * @returns Array of platform-specific bundle configurations
- */
-export function getCliPlatformBundleConfigs(
-  id?: string,
-  overridePlatform?: AllPlatforms
-): CliPlatformBundleConfig[] {
-  const kitConfig = getKitConfig();
-  const maybeBundleConfig = kitConfig
-    ? getBundleConfig(kitConfig, id)
-    : undefined;
-  const bundleConfig = maybeBundleConfig ?? {};
-
-  const platforms = getTargetPlatforms(overridePlatform, bundleConfig.targets);
-
-  return platforms.map<CliPlatformBundleConfig>((platform) => {
-    const platformBundleConfig = getPlatformBundleConfig(
-      bundleConfig,
-      platform
-    );
-
-    // apply defaults to fill in any required props that are missing
-
-    return {
-      ...getDefaultBundlerPlugins(),
-      ...getDefaultBundleParameters(platform),
-      ...platformBundleConfig,
-      platform,
-    };
-  });
-}

package/src/bundle/metro.ts

@@ -1,66 +0,0 @@
-import { info } from "@rnx-kit/console";
-import type { BundleArgs as MetroBundleArgs } from "@rnx-kit/metro-service";
-import { bundle } from "@rnx-kit/metro-service";
-import * as fs from "fs";
-import type { ConfigT } from "metro-config";
-import * as path from "path";
-import { customizeMetroConfig } from "../metro-config";
-import type { CliPlatformBundleConfig } from "./types";
-
-function ensureDir(p: string): void {
-  fs.mkdirSync(p, { recursive: true, mode: 0o755 });
-}
-
-/**
- * Run the Metro bundler.
- *
- * @param metroConfig Metro configuration
- * @param bundleConfig Bundle configuration
- * @param dev Choose whether or not this will be a "developer" bundle. The alternative is a "production" bundle.
- *            When `true`, warnings are enabled, and the bundle is not minified by default.
- *            Further, optimizations like constant folding are disabled.
- *            When `false`, warnings are disabled and the bundle is minified by default.
- * @param minify Optionally choose whether or not the bundle is minified. When not set, minification is controlled by the `dev` property.
- * @param output Output bundle format; defaults to plain JS
- */
-export async function metroBundle(
-  metroConfig: ConfigT,
-  bundleConfig: CliPlatformBundleConfig,
-  dev: boolean,
-  minify?: boolean,
-  output = bundle
-): Promise<void> {
-  info(`Bundling ${bundleConfig.platform}...`);
-
-  if (!dev && bundleConfig.treeShake) {
-    if (minify != null) {
-      if (typeof bundleConfig.treeShake === "object") {
-        bundleConfig.treeShake.minify = minify;
-      } else {
-        bundleConfig.treeShake = { minify };
-      }
-    }
-  } else {
-    bundleConfig.treeShake = false;
-  }
-
-  customizeMetroConfig(metroConfig, bundleConfig);
-
-  const metroBundleArgs: MetroBundleArgs = {
-    ...bundleConfig,
-    dev,
-    minify,
-  };
-
-  // ensure all output directories exist
-  ensureDir(path.dirname(metroBundleArgs.bundleOutput));
-  if (metroBundleArgs.sourcemapOutput) {
-    ensureDir(path.dirname(metroBundleArgs.sourcemapOutput));
-  }
-  if (metroBundleArgs.assetsDest) {
-    ensureDir(metroBundleArgs.assetsDest);
-  }
-
-  // create the bundle
-  await output(metroBundleArgs, metroConfig);
-}

package/src/bundle/overrides.ts

@@ -1,51 +0,0 @@
-import { pickValues } from "@rnx-kit/tools-language/properties";
-import type { CliPlatformBundleConfig } from "./types";
-
-type BundleConfigOverrides = Partial<
-  Pick<
-    CliPlatformBundleConfig,
-    | "entryFile"
-    | "bundleOutput"
-    | "bundleEncoding"
-    | "sourcemapOutput"
-    | "sourcemapSourcesRoot"
-    | "sourcemapUseAbsolutePath"
-    | "assetsDest"
-    | "treeShake"
-    | "unstableTransformProfile"
-    | "indexedRamBundle"
-    | "hermes"
-  >
->;
-
-export const overridableCommonBundleOptions: readonly (keyof BundleConfigOverrides)[] =
-  [
-    "assetsDest",
-    "bundleEncoding",
-    "bundleOutput",
-    "entryFile",
-    "sourcemapOutput",
-    "sourcemapSourcesRoot",
-    "sourcemapUseAbsolutePath",
-    "unstableTransformProfile",
-  ];
-
-/**
- * Apply overrides, if any, to each rnx-kit bundle configuration. Overrides are applied in-place.
- *
- * @param overrides Optional overrides to apply
- * @param configs Array of platform-specific bundle configurations. This is modified if any overrides are applied.
- * @param keys Config keys to pick from {@link overrides}
- */
-export function applyBundleConfigOverrides(
-  overrides: BundleConfigOverrides,
-  configs: CliPlatformBundleConfig[],
-  keys: (keyof BundleConfigOverrides)[]
-): void {
-  const overridesToApply = pickValues(overrides, keys);
-  if (overridesToApply) {
-    for (const config of configs) {
-      Object.assign(config, overridesToApply);
-    }
-  }
-}

package/src/bundle/types.ts

@@ -1,41 +0,0 @@
-import type { BundleParameters } from "@rnx-kit/config";
-import type { BundleArgs } from "@rnx-kit/metro-service";
-import type { AllPlatforms } from "@rnx-kit/tools-react-native/platform";
-import type { TransformProfile } from "metro-babel-transformer";
-
-export type CLICommonBundleOptions = {
-  id?: string;
-  entryFile?: string;
-  platform?: AllPlatforms;
-  dev: boolean;
-  minify?: boolean;
-  bundleOutput?: string;
-  bundleEncoding?: BundleArgs["bundleEncoding"];
-  maxWorkers?: number;
-  sourcemapOutput?: string;
-  sourcemapSourcesRoot?: string;
-  sourcemapUseAbsolutePath?: boolean;
-  assetsDest?: string;
-  unstableTransformProfile?: TransformProfile;
-  resetCache?: boolean;
-  config?: string;
-};
-
-export type CliPlatformBundleConfig = BundleParameters &
-  Required<
-    Pick<
-      BundleParameters,
-      | "entryFile"
-      | "bundleOutput"
-      | "sourcemapUseAbsolutePath"
-      | "treeShake"
-      | "plugins"
-    >
-  > & {
-    unstableTransformProfile?: TransformProfile;
-
-    /**
-     * Target platform for the bundle
-     */
-    platform: AllPlatforms;
-  };