@rnx-kit/cli 0.16.29 → 0.17.0

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;
-  };

package/src/bundle.ts

@@ -1,69 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { loadMetroConfig } from "@rnx-kit/metro-service";
-import { commonBundleCommandOptions } from "./bundle/cliOptions";
-import { emitBytecode } from "./bundle/hermes";
-import { getCliPlatformBundleConfigs } from "./bundle/kit-config";
-import { metroBundle } from "./bundle/metro";
-import {
-  applyBundleConfigOverrides,
-  overridableCommonBundleOptions,
-} from "./bundle/overrides";
-import type { CLICommonBundleOptions } from "./bundle/types";
-import { asBoolean } from "./parsers";
-
-type CLIBundleOptions = CLICommonBundleOptions & {
-  treeShake?: boolean;
-};
-
-export async function rnxBundle(
-  _argv: string[],
-  cliConfig: CLIConfig,
-  cliOptions: CLIBundleOptions
-): Promise<void> {
-  const metroConfig = await loadMetroConfig(cliConfig, cliOptions);
-
-  const bundleConfigs = getCliPlatformBundleConfigs(
-    cliOptions.id,
-    cliOptions.platform
-  );
-
-  applyBundleConfigOverrides(cliOptions, bundleConfigs, [
-    ...overridableCommonBundleOptions,
-    "hermes",
-    "treeShake",
-  ]);
-
-  for (const bundleConfig of bundleConfigs) {
-    await metroBundle(
-      metroConfig,
-      bundleConfig,
-      cliOptions.dev,
-      cliOptions.minify
-    );
-
-    const { bundleOutput, hermes, sourcemapOutput } = bundleConfig;
-    if (hermes) {
-      emitBytecode(
-        bundleOutput,
-        sourcemapOutput,
-        hermes === true ? {} : hermes
-      );
-    }
-  }
-}
-
-export const rnxBundleCommand = {
-  name: "rnx-bundle",
-  description:
-    "Bundle your rnx-kit package for offline use. See https://aka.ms/rnx-kit.",
-  func: rnxBundle,
-  options: [
-    ...commonBundleCommandOptions,
-    {
-      name: "--tree-shake [boolean]",
-      description:
-        "Enable tree shaking to remove unused code and reduce the bundle size.",
-      parse: asBoolean,
-    },
-  ],
-};

package/src/clean.ts

@@ -1,223 +0,0 @@
-import type { Config as CLIConfig } from "@react-native-community/cli-types";
-import { spawn } from "child_process";
-import * as fs from "fs-extra";
-import ora from "ora";
-import * as os from "os";
-import * as path from "path";
-import { asResolvedPath } from "./parsers";
-import { requireExternal } from "./serve/external";
-
-type Args = {
-  include?: string;
-  projectRoot?: string;
-  verify?: boolean;
-};
-
-type Task = {
-  label: string;
-  action: () => Promise<void>;
-};
-
-type CLICommand = Record<string, Task[]>;
-
-export async function rnxClean(
-  _argv: string[],
-  _config: CLIConfig,
-  cliOptions: Args
-): Promise<void> {
-  const projectRoot = cliOptions.projectRoot ?? process.cwd();
-  if (!fs.existsSync(projectRoot)) {
-    throw new Error(`Invalid path provided! ${projectRoot}`);
-  }
-
-  const spinner = ora();
-  try {
-    requireExternal("@react-native-community/cli-clean");
-    spinner.warn(
-      "`rnx-clean` has been upstreamed to `@react-native-community/cli`. Please use `npx react-native clean` instead."
-    );
-  } catch (_) {
-    // Ignore
-  }
-
-  const npm = os.platform() === "win32" ? "npm.cmd" : "npm";
-  const yarn = os.platform() === "win32" ? "yarn.cmd" : "yarn";
-
-  const COMMANDS: CLICommand = {
-    android: [
-      {
-        label: "Clean Gradle cache",
-        action: () => {
-          const candidates =
-            os.platform() === "win32"
-              ? ["android/gradlew.bat", "gradlew.bat"]
-              : ["android/gradlew", "gradlew"];
-          const gradlew = findPath(projectRoot, candidates);
-          if (gradlew) {
-            const script = path.basename(gradlew);
-            return execute(
-              os.platform() === "win32" ? script : `./${script}`,
-              ["clean"],
-              path.dirname(gradlew)
-            );
-          } else {
-            return Promise.resolve();
-          }
-        },
-      },
-    ],
-    cocoapods: [
-      {
-        label: "Clean CocoaPods cache",
-        action: () => execute("pod", ["cache", "clean", "--all"], projectRoot),
-      },
-    ],
-    metro: [
-      {
-        label: "Clean Metro cache",
-        action: () => cleanDir(`${os.tmpdir()}/metro-*`),
-      },
-      {
-        label: "Clean Haste cache",
-        action: () => cleanDir(`${os.tmpdir()}/haste-map-*`),
-      },
-      {
-        label: "Clean React Native cache",
-        action: () => cleanDir(`${os.tmpdir()}/react-*`),
-      },
-    ],
-    npm: [
-      {
-        label: "Remove node_modules",
-        action: () => cleanDir(`${projectRoot}/node_modules`),
-      },
-      ...(cliOptions.verify
-        ? [
-            {
-              label: "Verify npm cache",
-              action: () => execute(npm, ["cache", "verify"], projectRoot),
-            },
-          ]
-        : []),
-    ],
-    watchman: [
-      {
-        label: "Stop Watchman",
-        action: () =>
-          execute(
-            os.platform() === "win32" ? "tskill" : "killall",
-            ["watchman"],
-            projectRoot
-          ),
-      },
-      {
-        label: "Delete Watchman cache",
-        action: () => execute("watchman", ["watch-del-all"], projectRoot),
-      },
-    ],
-    yarn: [
-      {
-        label: "Clean Yarn cache",
-        action: () => execute(yarn, ["cache", "clean"], projectRoot),
-      },
-    ],
-  };
-
-  const categories = cliOptions.include?.split(",") ?? [
-    "metro",
-    "npm",
-    "watchman",
-    "yarn",
-  ];
-
-  for (const category of categories) {
-    const commands = COMMANDS[category];
-    if (!commands) {
-      spinner.warn(`Unknown category: ${category}`);
-      return;
-    }
-
-    for (const { action, label } of commands) {
-      spinner.start(label);
-      await action()
-        .then(() => {
-          spinner.succeed();
-        })
-        .catch((e) => {
-          spinner.fail(`${label} » ${e}`);
-        });
-    }
-  }
-}
-
-function cleanDir(path: string): Promise<void> {
-  if (!fs.existsSync(path)) {
-    return Promise.resolve();
-  }
-
-  return fs.rmdir(path, { maxRetries: 3, recursive: true });
-}
-
-function findPath(startPath: string, files: string[]): string | undefined {
-  // TODO: Find project files via `@react-native-community/cli`
-  for (const file of files) {
-    const filename = path.resolve(startPath, file);
-    if (fs.existsSync(filename)) {
-      return filename;
-    }
-  }
-
-  return undefined;
-}
-
-function execute(command: string, args: string[], cwd: string): Promise<void> {
-  return new Promise((resolve, reject) => {
-    const process = spawn(command, args, {
-      cwd,
-      stdio: ["inherit", null, null],
-      shell: command.endsWith(".bat") || command.endsWith(".cmd"),
-    });
-
-    const stderr: Buffer[] = [];
-    process.stderr.on("data", (data) => {
-      stderr.push(data);
-    });
-
-    process.on("close", (code, signal) => {
-      if (code === 0) {
-        resolve();
-      } else if (stderr) {
-        reject(Buffer.concat(stderr).toString().trimEnd());
-      } else if (signal) {
-        reject(`Failed with signal ${signal}`);
-      } else {
-        reject(`Failed with exit code ${code}`);
-      }
-    });
-  });
-}
-
-export const rnxCleanCommand = {
-  name: "rnx-clean",
-  func: rnxClean,
-  description: "Clears React Native project related caches",
-  options: [
-    {
-      name: "--include [android,cocoapods,metro,npm,watchman,yarn]",
-      description:
-        "Comma-separated flag of caches to clear, e.g. `npm,yarn`. When not specified, only non-platform specific caches are cleared.",
-      default: "metro,npm,watchman,yarn",
-    },
-    {
-      name: "--project-root <path>",
-      description: "Root path to your React Native project",
-      default: process.cwd(),
-      parse: asResolvedPath,
-    },
-    {
-      name: "--verify",
-      description: "Whether to verify the integrity of the cache",
-      default: false,
-    },
-  ],
-};