@react-native/community-cli-plugin 0.73.0 → 0.73.3

package/README.md

@@ -15,7 +15,7 @@ Start the React Native development server.
 #### Usage
 
 ```sh
-react-native start [options]
+npx react-native start [options]
 ```
 
 #### Options
@@ -45,7 +45,7 @@ Build the bundle for the provided JavaScript entry file.
 #### Usage
 
 ```sh
-react-native bundle --entry-file <path> [options]
+npx react-native bundle --entry-file <path> [options]
 ```
 
 #### Options
@@ -75,7 +75,7 @@ Build the [RAM bundle](https://reactnative.dev/docs/ram-bundles-inline-requires)
 #### Usage
 
 ```sh
-react-native ram-bundle --entry-file <path> [options]
+npx react-native ram-bundle --entry-file <path> [options]
 ```
 
 #### Options
@@ -85,3 +85,7 @@ Accepts all options supported by [`bundle`](#bundle) and the following:
 | Option | Description |
 | - | - |
 | `--indexed-ram-bundle` | Force the "Indexed RAM" bundle file format, even when building for Android. |
+
+## Contributing
+
+Changes to this package can be made locally and tested against the `rn-tester` app, per the [Contributing guide](https://reactnative.dev/contributing/overview#contributing-code). During development, this package is automatically run from source with no build step.

package/dist/commands/bundle/assetCatalogIOS.js.flow

@@ -4,74 +4,26 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
 
-import type {AssetData} from 'metro/src/Assets';
+import type { AssetData } from "metro/src/Assets";
 
-import path from 'path';
-import fs from 'fs';
-import assetPathUtils from './assetPathUtils';
-
-export function cleanAssetCatalog(catalogDir: string): void {
-  const files = fs
-    .readdirSync(catalogDir)
-    .filter(file => file.endsWith('.imageset'));
-  for (const file of files) {
-    fs.rmSync(path.join(catalogDir, file));
-  }
-}
+declare export function cleanAssetCatalog(catalogDir: string): void;
 
 type ImageSet = {
   basePath: string,
-  files: {name: string, src: string, scale: number}[],
+  files: { name: string, src: string, scale: number }[],
 };
 
-export function getImageSet(
+declare export function getImageSet(
   catalogDir: string,
   asset: AssetData,
-  scales: $ReadOnlyArray<number>,
-): ImageSet {
-  const fileName = assetPathUtils.getResourceIdentifier(asset);
-  return {
-    basePath: path.join(catalogDir, `${fileName}.imageset`),
-    files: scales.map((scale, idx) => {
-      const suffix = scale === 1 ? '' : `@${scale}x`;
-      return {
-        name: `${fileName + suffix}.${asset.type}`,
-        scale,
-        src: asset.files[idx],
-      };
-    }),
-  };
-}
-
-export function isCatalogAsset(asset: AssetData): boolean {
-  return asset.type === 'png' || asset.type === 'jpg' || asset.type === 'jpeg';
-}
-
-export function writeImageSet(imageSet: ImageSet): void {
-  fs.mkdirSync(imageSet.basePath, {recursive: true});
+  scales: $ReadOnlyArray<number>
+): ImageSet;
 
-  for (const file of imageSet.files) {
-    const dest = path.join(imageSet.basePath, file.name);
-    fs.copyFileSync(file.src, dest);
-  }
+declare export function isCatalogAsset(asset: AssetData): boolean;
 
-  fs.writeFileSync(
-    path.join(imageSet.basePath, 'Contents.json'),
-    JSON.stringify({
-      images: imageSet.files.map(file => ({
-        filename: file.name,
-        idiom: 'universal',
-        scale: `${file.scale}x`,
-      })),
-      info: {
-        author: 'xcode',
-        version: 1,
-      },
-    }),
-  );
-}
+declare export function writeImageSet(imageSet: ImageSet): void;

package/dist/commands/bundle/assetPathUtils.js.flow

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
@@ -20,74 +20,20 @@ export type PackagerAsset = $ReadOnly<{
  * FIXME: using number to represent discrete scale numbers is fragile in essence because of
  * floating point numbers imprecision.
  */
-function getAndroidAssetSuffix(scale: number): string {
-  switch (scale) {
-    case 0.75:
-      return 'ldpi';
-    case 1:
-      return 'mdpi';
-    case 1.5:
-      return 'hdpi';
-    case 2:
-      return 'xhdpi';
-    case 3:
-      return 'xxhdpi';
-    case 4:
-      return 'xxxhdpi';
-    default:
-      return '';
-  }
-}
+declare function getAndroidAssetSuffix(scale: number): string;
 
-// See https://developer.android.com/guide/topics/resources/drawable-resource.html
-const drawableFileTypes = new Set<string>([
-  'gif',
-  'jpeg',
-  'jpg',
-  'png',
-  'webp',
-  'xml',
-]);
-
-function getAndroidResourceFolderName(
+declare function getAndroidResourceFolderName(
   asset: PackagerAsset,
-  scale: number,
-): string {
-  if (!drawableFileTypes.has(asset.type)) {
-    return 'raw';
-  }
-  const suffix = getAndroidAssetSuffix(scale);
-  if (!suffix) {
-    throw new Error(
-      `Don't know which android drawable suffix to use for asset: ${JSON.stringify(
-        asset,
-      )}`,
-    );
-  }
-  const androidFolder = `drawable-${suffix}`;
-  return androidFolder;
-}
+  scale: number
+): string;
 
-function getResourceIdentifier(asset: PackagerAsset): string {
-  const folderPath = getBasePath(asset);
-  return `${folderPath}/${asset.name}`
-    .toLowerCase()
-    .replace(/\//g, '_') // Encode folder structure in file name
-    .replace(/([^a-z0-9_])/g, '') // Remove illegal chars
-    .replace(/^assets_/, ''); // Remove "assets_" prefix
-}
+declare function getResourceIdentifier(asset: PackagerAsset): string;
 
-function getBasePath(asset: PackagerAsset): string {
-  let basePath = asset.httpServerLocation;
-  if (basePath[0] === '/') {
-    basePath = basePath.substr(1);
-  }
-  return basePath;
-}
+declare function getBasePath(asset: PackagerAsset): string;
 
-export default {
-  getAndroidAssetSuffix,
-  getAndroidResourceFolderName,
-  getResourceIdentifier,
-  getBasePath,
+declare export default {
+  getAndroidAssetSuffix: getAndroidAssetSuffix,
+  getAndroidResourceFolderName: getAndroidResourceFolderName,
+  getResourceIdentifier: getResourceIdentifier,
+  getBasePath: getBasePath,
 };

package/dist/commands/bundle/buildBundle.js

@@ -5,6 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.unstable_buildBundleWithConfig = exports.default = void 0;
 var _Server = _interopRequireDefault(require("metro/src/Server"));
+var _bundle = _interopRequireDefault(require("metro/src/shared/output/bundle"));
+var _RamBundle = _interopRequireDefault(
+  require("metro/src/shared/output/RamBundle")
+);
 var _path = _interopRequireDefault(require("path"));
 var _chalk = _interopRequireDefault(require("chalk"));
 var _saveAssets = _interopRequireDefault(require("./saveAssets"));
@@ -26,16 +30,19 @@ function _interopRequireDefault(obj) {
  * @oncall react_native
  */
 
-const outputBundle = require("metro/src/shared/output/bundle");
-async function buildBundle(args, ctx, output = outputBundle) {
+async function buildBundle(_argv, ctx, args, bundleImpl = _bundle.default) {
   const config = await (0, _loadMetroConfig.default)(ctx, {
     maxWorkers: args.maxWorkers,
     resetCache: args.resetCache,
     config: args.config,
   });
-  return buildBundleWithConfig(args, config, output);
+  return buildBundleWithConfig(args, config, bundleImpl);
 }
-async function buildBundleWithConfig(args, config, output = outputBundle) {
+async function buildBundleWithConfig(
+  args,
+  config,
+  bundleImpl = _bundle.default
+) {
   if (config.resolver.platforms.indexOf(args.platform) === -1) {
     _cliTools.logger.error(
       `Invalid platform ${
@@ -56,7 +63,7 @@ async function buildBundleWithConfig(args, config, output = outputBundle) {
   // have other choice than defining it as an env variable here.
   process.env.NODE_ENV = args.dev ? "development" : "production";
   let sourceMapUrl = args.sourcemapOutput;
-  if (sourceMapUrl && !args.sourcemapUseAbsolutePath) {
+  if (sourceMapUrl != null && !args.sourcemapUseAbsolutePath) {
     sourceMapUrl = _path.default.basename(sourceMapUrl);
   }
 
@@ -71,11 +78,13 @@ async function buildBundleWithConfig(args, config, output = outputBundle) {
   };
   const server = new _Server.default(config);
   try {
-    const bundle = await output.build(server, requestOpts);
+    const bundle = await bundleImpl.build(server, requestOpts);
 
     // $FlowIgnore[class-object-subtyping]
     // $FlowIgnore[incompatible-call]
-    await output.save(bundle, args, _cliTools.logger.info);
+    // $FlowIgnore[prop-missing]
+    // $FlowIgnore[incompatible-exact]
+    await bundleImpl.save(bundle, args, _cliTools.logger.info);
 
     // Save the assets of the bundle
     const outputAssets = await server.getAssets({

package/dist/commands/bundle/buildBundle.js.flow

@@ -4,106 +4,50 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
 
-import type {Config} from '@react-native-community/cli-types';
-import type {RequestOptions} from 'metro/src/shared/types.flow';
-import type {ConfigT} from 'metro-config';
-import type {CommandLineArgs} from './bundleCommandLineArgs';
-
-import Server from 'metro/src/Server';
-const outputBundle = require('metro/src/shared/output/bundle');
-import path from 'path';
-import chalk from 'chalk';
-import saveAssets from './saveAssets';
-import {default as loadMetroConfig} from '../../utils/loadMetroConfig';
-import {logger} from '@react-native-community/cli-tools';
-
-async function buildBundle(
-  args: CommandLineArgs,
+import type { Config } from "@react-native-community/cli-types";
+import type { ConfigT } from "metro-config";
+
+import metroBundle from "metro/src/shared/output/bundle";
+import metroRamBundle from "metro/src/shared/output/RamBundle";
+export type BundleCommandArgs = {
+  assetsDest?: string,
+  assetCatalogDest?: string,
+  entryFile: string,
+  resetCache: boolean,
+  resetGlobalCache: boolean,
+  transformer?: string,
+  minify?: boolean,
+  config?: string,
+  platform: string,
+  dev: boolean,
+  bundleOutput: string,
+  bundleEncoding?: "utf8" | "utf16le" | "ascii",
+  maxWorkers?: number,
+  sourcemapOutput?: string,
+  sourcemapSourcesRoot?: string,
+  sourcemapUseAbsolutePath: boolean,
+  verbose: boolean,
+  unstableTransformProfile: string,
+  indexedRamBundle?: boolean,
+};
+
+declare function buildBundle(
+  _argv: Array<string>,
   ctx: Config,
-  output: typeof outputBundle = outputBundle,
-): Promise<void> {
-  const config = await loadMetroConfig(ctx, {
-    maxWorkers: args.maxWorkers,
-    resetCache: args.resetCache,
-    config: args.config,
-  });
-
-  return buildBundleWithConfig(args, config, output);
-}
+  args: BundleCommandArgs,
+  bundleImpl: typeof metroBundle | typeof metroRamBundle
+): Promise<void>;
 
-async function buildBundleWithConfig(
-  args: CommandLineArgs,
+declare function buildBundleWithConfig(
+  args: BundleCommandArgs,
   config: ConfigT,
-  output: typeof outputBundle = outputBundle,
-): Promise<void> {
-  if (config.resolver.platforms.indexOf(args.platform) === -1) {
-    logger.error(
-      `Invalid platform ${
-        args.platform ? `"${chalk.bold(args.platform)}" ` : ''
-      }selected.`,
-    );
-
-    logger.info(
-      `Available platforms are: ${config.resolver.platforms
-        .map(x => `"${chalk.bold(x)}"`)
-        .join(
-          ', ',
-        )}. If you are trying to bundle for an out-of-tree platform, it may not be installed.`,
-    );
-
-    throw new Error('Bundling failed');
-  }
-
-  // This is used by a bazillion of npm modules we don't control so we don't
-  // have other choice than defining it as an env variable here.
-  process.env.NODE_ENV = args.dev ? 'development' : 'production';
-
-  let sourceMapUrl = args.sourcemapOutput;
-  if (sourceMapUrl && !args.sourcemapUseAbsolutePath) {
-    sourceMapUrl = path.basename(sourceMapUrl);
-  }
-
-  // $FlowIgnore[prop-missing]
-  const requestOpts: RequestOptions & {...} = {
-    entryFile: args.entryFile,
-    sourceMapUrl,
-    dev: args.dev,
-    minify: args.minify !== undefined ? args.minify : !args.dev,
-    platform: args.platform,
-    unstable_transformProfile: args.unstableTransformProfile,
-  };
-  const server = new Server(config);
-
-  try {
-    const bundle = await output.build(server, requestOpts);
-
-    // $FlowIgnore[class-object-subtyping]
-    // $FlowIgnore[incompatible-call]
-    await output.save(bundle, args, logger.info);
-
-    // Save the assets of the bundle
-    const outputAssets = await server.getAssets({
-      ...Server.DEFAULT_BUNDLE_OPTIONS,
-      ...requestOpts,
-      bundleType: 'todo',
-    });
-
-    // When we're done saving bundle output and the assets, we're done.
-    return await saveAssets(
-      outputAssets,
-      args.platform,
-      args.assetsDest,
-      args.assetCatalogDest,
-    );
-  } finally {
-    server.end();
-  }
-}
+  bundleImpl: typeof metroBundle | typeof metroRamBundle
+): Promise<void>;
 
 /**
  * UNSTABLE: This function is likely to be relocated and its API changed in
@@ -115,6 +59,6 @@ async function buildBundleWithConfig(
  * re-used for several bundling calls if multiple platforms are being
  * bundled.
  */
-export const unstable_buildBundleWithConfig = buildBundleWithConfig;
+declare export const unstable_buildBundleWithConfig: buildBundleWithConfig;
 
-export default buildBundle;
+declare export default buildBundle;

package/dist/commands/bundle/filterPlatformAssetScales.js.flow

@@ -4,42 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
 
-const ALLOWED_SCALES: {[key: string]: number[]} = {
-  ios: [1, 2, 3],
-};
-
-function filterPlatformAssetScales(
+declare function filterPlatformAssetScales(
   platform: string,
-  scales: $ReadOnlyArray<number>,
-): $ReadOnlyArray<number> {
-  const whitelist: number[] = ALLOWED_SCALES[platform];
-  if (!whitelist) {
-    return scales;
-  }
-  const result = scales.filter(scale => whitelist.indexOf(scale) > -1);
-  if (result.length === 0 && scales.length > 0) {
-    // No matching scale found, but there are some available. Ideally we don't
-    // want to be in this situation and should throw, but for now as a fallback
-    // let's just use the closest larger image
-    const maxScale = whitelist[whitelist.length - 1];
-    for (const scale of scales) {
-      if (scale > maxScale) {
-        result.push(scale);
-        break;
-      }
-    }
-
-    // There is no larger scales available, use the largest we have
-    if (result.length === 0) {
-      result.push(scales[scales.length - 1]);
-    }
-  }
-  return result;
-}
+  scales: $ReadOnlyArray<number>
+): $ReadOnlyArray<number>;
 
-export default filterPlatformAssetScales;
+declare export default filterPlatformAssetScales;

package/dist/commands/bundle/getAssetDestPathAndroid.js.flow

@@ -4,23 +4,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
 
-import type {PackagerAsset} from './assetPathUtils';
+import type { PackagerAsset } from "./assetPathUtils";
 
-import path from 'path';
-import assetPathUtils from './assetPathUtils';
+declare function getAssetDestPathAndroid(
+  asset: PackagerAsset,
+  scale: number
+): string;
 
-function getAssetDestPathAndroid(asset: PackagerAsset, scale: number): string {
-  const androidFolder = assetPathUtils.getAndroidResourceFolderName(
-    asset,
-    scale,
-  );
-  const fileName = assetPathUtils.getResourceIdentifier(asset);
-  return path.join(androidFolder, `${fileName}.${asset.type}`);
-}
-
-export default getAssetDestPathAndroid;
+declare export default getAssetDestPathAndroid;

package/dist/commands/bundle/getAssetDestPathIOS.js.flow

@@ -4,25 +4,16 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  *
- * @flow
+ * @flow strict-local
  * @format
  * @oncall react_native
  */
 
-import type {PackagerAsset} from './assetPathUtils';
+import type { PackagerAsset } from "./assetPathUtils";
 
-import path from 'path';
+declare function getAssetDestPathIOS(
+  asset: PackagerAsset,
+  scale: number
+): string;
 
-function getAssetDestPathIOS(asset: PackagerAsset, scale: number): string {
-  const suffix = scale === 1 ? '' : `@${scale}x`;
-  const fileName = `${asset.name + suffix}.${asset.type}`;
-  return path.join(
-    // Assets can have relative paths outside of the project root.
-    // Replace `../` with `_` to make sure they don't end up outside of
-    // the expected assets directory.
-    asset.httpServerLocation.substr(1).replace(/\.\.\//g, '_'),
-    fileName,
-  );
-}
-
-export default getAssetDestPathIOS;
+declare export default getAssetDestPathIOS;

package/dist/commands/bundle/index.js

@@ -0,0 +1,124 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = void 0;
+var _path = _interopRequireDefault(require("path"));
+var _buildBundle = _interopRequireDefault(require("./buildBundle"));
+function _interopRequireDefault(obj) {
+  return obj && obj.__esModule ? obj : { default: obj };
+}
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ *
+ * @format
+ * @oncall react_native
+ */
+
+const bundleCommand = {
+  name: "bundle",
+  description: "Build the bundle for the provided JavaScript entry file.",
+  func: _buildBundle.default,
+  options: [
+    {
+      name: "--entry-file <path>",
+      description:
+        "Path to the root JS file, either absolute or relative to JS root",
+    },
+    {
+      name: "--platform <string>",
+      description: 'Either "ios" or "android"',
+      default: "ios",
+    },
+    {
+      name: "--transformer <string>",
+      description: "Specify a custom transformer to be used",
+    },
+    {
+      name: "--dev [boolean]",
+      description: "If false, warnings are disabled and the bundle is minified",
+      parse: (val) => val !== "false",
+      default: true,
+    },
+    {
+      name: "--minify [boolean]",
+      description:
+        "Allows overriding whether bundle is minified. This defaults to " +
+        "false if dev is true, and true if dev is false. Disabling minification " +
+        "can be useful for speeding up production builds for testing purposes.",
+      parse: (val) => val !== "false",
+    },
+    {
+      name: "--bundle-output <string>",
+      description:
+        "File name where to store the resulting bundle, ex. /tmp/groups.bundle",
+    },
+    {
+      name: "--bundle-encoding <string>",
+      description:
+        "Encoding the bundle should be written in (https://nodejs.org/api/buffer.html#buffer_buffer).",
+      default: "utf8",
+    },
+    {
+      name: "--max-workers <number>",
+      description:
+        "Specifies the maximum number of workers the worker-pool " +
+        "will spawn for transforming files. This defaults to the number of the " +
+        "cores available on your machine.",
+      parse: (workers) => Number(workers),
+    },
+    {
+      name: "--sourcemap-output <string>",
+      description:
+        "File name where to store the sourcemap file for resulting bundle, ex. /tmp/groups.map",
+    },
+    {
+      name: "--sourcemap-sources-root <string>",
+      description:
+        "Path to make sourcemap's sources entries relative to, ex. /root/dir",
+    },
+    {
+      name: "--sourcemap-use-absolute-path",
+      description: "Report SourceMapURL using its full path",
+      default: false,
+    },
+    {
+      name: "--assets-dest <string>",
+      description:
+        "Directory name where to store assets referenced in the bundle",
+    },
+    {
+      name: "--unstable-transform-profile <string>",
+      description:
+        "Experimental, transform JS for a specific JS engine. Currently supported: hermes, hermes-canary, default",
+      default: "default",
+    },
+    {
+      name: "--asset-catalog-dest [string]",
+      description: "Path where to create an iOS Asset Catalog for images",
+    },
+    {
+      name: "--reset-cache",
+      description: "Removes cached files",
+      default: false,
+    },
+    {
+      name: "--read-global-cache",
+      description:
+        "Try to fetch transformed JS code from the global cache, if configured.",
+      default: false,
+    },
+    {
+      name: "--config <string>",
+      description: "Path to the CLI configuration file",
+      parse: (val) => _path.default.resolve(val),
+    },
+  ],
+};
+var _default = bundleCommand;
+exports.default = _default;

package/dist/commands/bundle/index.js.flow

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @flow strict-local
+ * @format
+ * @oncall react_native
+ */
+
+import type { Command } from "@react-native-community/cli-types";
+
+export type { BundleCommandArgs } from "./buildBundle";
+
+declare const bundleCommand: Command;
+
+declare export default bundleCommand;