@rnx-kit/cli 0.14.4 → 0.14.6

package/src/ram-bundle.ts

@@ -0,0 +1,78 @@
+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: Array<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/kit-config.ts

@@ -1,7 +1,7 @@
 import type { ServerConfig, BundlerPlugins } from "@rnx-kit/config";
 import { getKitConfig, getBundleConfig } from "@rnx-kit/config";
-import { getDefaultBundlerPlugins } from "../bundler-plugin-defaults";
 import { pickValues } from "@rnx-kit/tools-language/properties";
+import { getDefaultBundlerPlugins } from "../bundle/defaultPlugins";
 
 export type ServerConfigOverrides = {
   projectRoot?: string;

package/src/start.ts

@@ -11,8 +11,8 @@ import type { Server as HttpsServer } from "https";
 import type { ReportableEvent, Reporter } from "metro";
 import type { Middleware } from "metro-config";
 import type Server from "metro/src/Server";
-import os from "os";
-import path from "path";
+import * as os from "os";
+import * as path from "path";
 import qrcode from "qrcode";
 import readline from "readline";
 import { customizeMetroConfig } from "./metro-config";
@@ -137,16 +137,9 @@ export async function rnxStart(
   });
 
   // customize the metro config to include plugins, presets, etc.
-  customizeMetroConfig(
-    metroConfig,
-    serverConfig.detectCyclicDependencies,
-    serverConfig.detectDuplicateDependencies,
-    serverConfig.typescriptValidation,
-    serverConfig.treeShake,
-    (message: string): void => {
-      terminal.log(message);
-    }
-  );
+  customizeMetroConfig(metroConfig, serverConfig, (message: string): void => {
+    terminal.log(message);
+  });
 
   // create middleware -- a collection of plugins which handle incoming
   // http(s) requests, routing them to static pages or JS functions.

package/src/typescript/project-cache.ts

@@ -9,8 +9,8 @@ import {
   Project,
   readConfigFile,
 } from "@rnx-kit/typescript-service";
-import fs from "fs";
-import path from "path";
+import * as fs from "fs";
+import * as path from "path";
 import ts from "typescript";
 
 export type ProjectInfo = {

package/test/bundle/overrides.test.ts

@@ -1,5 +1,8 @@
 import "jest-extended";
-import { applyBundleConfigOverrides } from "../../src/bundle/overrides";
+import {
+  applyBundleConfigOverrides,
+  overridableCommonBundleOptions,
+} from "../../src/bundle/overrides";
 import type { CliPlatformBundleConfig } from "../../src/bundle/types";
 
 describe("CLI > Bundle > Overrides > applyBundleConfigOverrides", () => {
@@ -11,12 +14,17 @@ describe("CLI > Bundle > Overrides > applyBundleConfigOverrides", () => {
     detectDuplicateDependencies: true,
     typescriptValidation: true,
     treeShake: true,
+    indexedRamBundle: false,
     platform: "ios",
   };
 
   test("has no effect when no overrides are given", () => {
     const copy = { ...config };
-    applyBundleConfigOverrides({}, [copy]);
+    applyBundleConfigOverrides(
+      {},
+      [copy],
+      [...overridableCommonBundleOptions, "treeShake"]
+    );
     expect(copy).toEqual(config);
   });
 
@@ -28,10 +36,9 @@ describe("CLI > Bundle > Overrides > applyBundleConfigOverrides", () => {
       }
     }
     applyBundleConfigOverrides(
-      {
-        [name]: value,
-      },
-      [copy]
+      { [name]: value },
+      [copy],
+      [...overridableCommonBundleOptions, "treeShake", "indexedRamBundle"]
     );
     expect(copy).toEqual({
       ...config,
@@ -39,35 +46,39 @@ describe("CLI > Bundle > Overrides > applyBundleConfigOverrides", () => {
     });
   }
 
-  test("changes entryFile using an override", () => {
+  test("changes `entryFile` using an override", () => {
     testOverride("entryFile", "foo.js");
   });
 
-  test("changes bundleOutput using an override", () => {
+  test("changes `bundleOutput` using an override", () => {
     testOverride("bundleOutput", "foo.bundle");
   });
 
-  test("sets bundleEncoding using an override", () => {
+  test("sets `bundleEncoding` using an override", () => {
     testOverride("bundleEncoding", "utf8");
   });
 
-  test("sets sourcemapOutput using an override", () => {
+  test("sets `sourcemapOutput` using an override", () => {
     testOverride("sourcemapOutput", "out/foo.map");
   });
 
-  test("sets sourcemapSourcesRoot using an override", () => {
+  test("sets `sourcemapSourcesRoot` using an override", () => {
     testOverride("sourcemapSourcesRoot", "/myrepo/packags/foo");
   });
 
-  test("changes sourcemapUseAbsolutePath using an override", () => {
+  test("changes `sourcemapUseAbsolutePath` using an override", () => {
     testOverride("sourcemapUseAbsolutePath", true);
   });
 
-  test("sets assetsDest using an override", () => {
+  test("sets `assetsDest` using an override", () => {
     testOverride("assetsDest", "dist");
   });
 
-  test("changes treeShake using an override", () => {
+  test("changes `treeShake` using an override", () => {
     testOverride("treeShake", false);
   });
+
+  test("changes `indexedRamBundle` using an override", () => {
+    testOverride("indexedRamBundle", true);
+  });
 });

package/test/metro-config.test.ts

@@ -1,5 +1,6 @@
 import { CyclicDependencies } from "@rnx-kit/metro-plugin-cyclic-dependencies-detector";
 import { DuplicateDependencies } from "@rnx-kit/metro-plugin-duplicates-checker";
+import type { InputConfigT } from "metro-config";
 import { customizeMetroConfig } from "../src/metro-config";
 
 jest.mock("@rnx-kit/metro-plugin-cyclic-dependencies-detector", () => {
@@ -14,29 +15,26 @@ jest.mock("@rnx-kit/metro-plugin-duplicates-checker", () => {
   };
 });
 
-describe("cli/metro-config/customizeMetroConfig", () => {
-  const mockConfig = {
+// Always use a new mock since `customizeMetroConfig()` modifies the object.
+function makeMockConfig(): InputConfigT {
+  return {
     serializer: {
       customSerializer: false,
       experimentalSerializerHook: false,
     },
     transformer: {},
-  };
+  } as unknown as InputConfigT;
+}
 
+describe("cli/metro-config/customizeMetroConfig", () => {
   afterEach(() => {
     (CyclicDependencies as any).mockClear();
     (DuplicateDependencies as any).mockClear();
   });
 
   test("returns a config with plugins by default", () => {
-    const inputConfig = { ...mockConfig };
-    customizeMetroConfig(
-      inputConfig as any,
-      undefined,
-      undefined,
-      undefined,
-      undefined
-    );
+    const inputConfig = makeMockConfig();
+    customizeMetroConfig(inputConfig, {});
 
     expect(inputConfig).toEqual({
       serializer: {
@@ -54,14 +52,11 @@ describe("cli/metro-config/customizeMetroConfig", () => {
   });
 
   test("returns a config without a custom serializer when there are no plugins", () => {
-    const inputConfig = { ...mockConfig };
-    customizeMetroConfig(
-      inputConfig as any,
-      false,
-      false,
-      undefined,
-      undefined
-    );
+    const inputConfig = makeMockConfig();
+    customizeMetroConfig(inputConfig, {
+      detectCyclicDependencies: false,
+      detectDuplicateDependencies: false,
+    });
 
     expect(inputConfig).toEqual({
       serializer: {
@@ -78,14 +73,10 @@ describe("cli/metro-config/customizeMetroConfig", () => {
   });
 
   test("returns a config with only duplicates plugin", () => {
-    const inputConfig = { ...mockConfig };
-    customizeMetroConfig(
-      inputConfig as any,
-      false,
-      undefined,
-      undefined,
-      undefined
-    );
+    const inputConfig = makeMockConfig();
+    customizeMetroConfig(inputConfig, {
+      detectCyclicDependencies: false,
+    });
 
     expect(inputConfig).toEqual({
       serializer: {
@@ -103,14 +94,10 @@ describe("cli/metro-config/customizeMetroConfig", () => {
   });
 
   test("returns a config with only cyclic dependencies plugin", () => {
-    const inputConfig = { ...mockConfig };
-    customizeMetroConfig(
-      inputConfig as any,
-      undefined,
-      false,
-      undefined,
-      undefined
-    );
+    const inputConfig = makeMockConfig();
+    customizeMetroConfig(inputConfig, {
+      detectDuplicateDependencies: false,
+    });
 
     expect(inputConfig).toEqual({
       serializer: {
@@ -128,16 +115,13 @@ describe("cli/metro-config/customizeMetroConfig", () => {
   });
 
   test("forwards plugin options", () => {
-    const inputConfig = { ...mockConfig };
+    const inputConfig = makeMockConfig();
     const cyclicDependenciesOptions = { cyclicDependencies: true } as any;
     const duplicateDependencesOptions = { duplicateDependencies: true } as any;
-    customizeMetroConfig(
-      inputConfig as any,
-      cyclicDependenciesOptions,
-      duplicateDependencesOptions,
-      undefined,
-      undefined
-    );
+    customizeMetroConfig(inputConfig, {
+      detectCyclicDependencies: cyclicDependenciesOptions,
+      detectDuplicateDependencies: duplicateDependencesOptions,
+    });
 
     expect(inputConfig).toEqual({
       serializer: {
@@ -157,8 +141,12 @@ describe("cli/metro-config/customizeMetroConfig", () => {
   });
 
   test("returns a config with a custom serializer when tree shaking is enabled", () => {
-    const inputConfig = { ...mockConfig };
-    customizeMetroConfig(inputConfig as any, false, false, undefined, true);
+    const inputConfig = makeMockConfig();
+    customizeMetroConfig(inputConfig, {
+      detectCyclicDependencies: false,
+      detectDuplicateDependencies: false,
+      treeShake: true,
+    });
 
     expect(inputConfig).toEqual({
       serializer: {

package/lib/bundler-plugin-defaults.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundler-plugin-defaults.d.ts","sourceRoot":"","sources":["../src/bundler-plugin-defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,wBAAgB,wBAAwB,IAAI,QAAQ,CAAC,cAAc,CAAC,CAOnE"}

package/lib/bundler-plugin-defaults.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"bundler-plugin-defaults.js","sourceRoot":"","sources":["../src/bundler-plugin-defaults.ts"],"names":[],"mappings":";;;AAEA,SAAgB,wBAAwB;IACtC,OAAO;QACL,wBAAwB,EAAE,IAAI;QAC9B,2BAA2B,EAAE,IAAI;QACjC,oBAAoB,EAAE,IAAI;QAC1B,SAAS,EAAE,KAAK;KACjB,CAAC;AACJ,CAAC;AAPD,4DAOC"}