@react-native/community-cli-plugin 0.73.0

package/README.md

@@ -0,0 +1,87 @@
+# @react-native/community-cli-plugin
+
+> This is an internal dependency of React Native. **Please don't depend on it directly.**
+
+CLI entry points supporting core React Native development features.
+
+Formerly [@react-native-community/cli-plugin-metro](https://www.npmjs.com/package/@react-native-community/cli-plugin-metro).
+
+## Commands
+
+### `start`
+
+Start the React Native development server.
+
+#### Usage
+
+```sh
+react-native start [options]
+```
+
+#### Options
+
+| Option | Description |
+| - | - |
+| `--port <number>` | Set the server port. |
+| `--host <string>` | Set the server host. |
+| `--projectRoot <path>` | Set the path to the project root. |
+| `--watchFolders <list>` | Specify additional folders to be added to the watch list. |
+| `--assetPlugins <list>` | Specify additional asset plugins. |
+| `--sourceExts <list>` | Specify additional source extensions to bundle. |
+| `--max-workers <number>` | Set the maximum number of workers the worker-pool will spawn for transforming files. Defaults to the number of the cores available on your machine. |
+| `--transformer <string>` | Specify a custom transformer. |
+| `--reset-cache` | Remove cached files. |
+| `--custom-log-reporter-path <string>` | Specify a module path exporting a replacement for `TerminalReporter`. |
+| `--https` | Enable HTTPS connections. |
+| `--key <path>`| Specify path to a custom SSL key. |
+| `--cert <path>` | Specify path to a custom SSL cert. |
+| `--config <string>` | Path to the CLI configuration file. |
+| `--no-interactive` | Disable interactive mode. |
+
+### `bundle`
+
+Build the bundle for the provided JavaScript entry file.
+
+#### Usage
+
+```sh
+react-native bundle --entry-file <path> [options]
+```
+
+#### Options
+
+| Option | Description |
+| - | - |
+| `--entry-file <path>` | Set the path to the root JavaScript entry file. |
+| `--platform <string>` | Set the target platform (either `"android"` or `"ios"`). Defaults to `"ios"`. |
+| `--transformer <string>` | Specify a custom transformer. |
+| `--dev [boolean]` | If `false`, warnings are disabled and the bundle is minified. Defaults to `true`. |
+| `--minify [boolean]` | Allows overriding whether bundle is minified. Defaults to `false` if `--dev` is set. Disabling minification can be useful for speeding up production builds for testing purposes. |
+| `--bundle-output <string>` | Specify the path to store the resulting bundle. |
+| `--bundle-encoding <string>` | Specify the encoding for writing the bundle (<https://nodejs.org/api/buffer.html#buffer_buffer>). |
+| `--sourcemap-output <string>` | Specify the path to store the source map file for the resulting bundle. |
+| `--sourcemap-sources-root <string>` | Set the root path for source map entries. |
+| `--sourcemap-use-absolute-path` | Report `SourceMapURL` using its full path. |
+| `--max-workers <number>` | Set the maximum number of workers the worker-pool will spawn for transforming files. Defaults to the number of the cores available on your machine. |
+| `--assets-dest <string>` | Specify the directory path for storing assets referenced in the bundle. |
+| `--reset-cache` | Remove cached files. |
+| `--read-global-cache` | Attempt to fetch transformed JS code from the global cache, if configured. Defaults to `false`. |
+| `--config <string>` | Path to the CLI configuration file. |
+
+### `ram-bundle`
+
+Build the [RAM bundle](https://reactnative.dev/docs/ram-bundles-inline-requires) for the provided JavaScript entry file.
+
+#### Usage
+
+```sh
+react-native ram-bundle --entry-file <path> [options]
+```
+
+#### Options
+
+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. |

package/dist/commands/bundle/assetCatalogIOS.js

@@ -0,0 +1,74 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.cleanAssetCatalog = cleanAssetCatalog;
+exports.getImageSet = getImageSet;
+exports.isCatalogAsset = isCatalogAsset;
+exports.writeImageSet = writeImageSet;
+var _path = _interopRequireDefault(require("path"));
+var _fs = _interopRequireDefault(require("fs"));
+var _assetPathUtils = _interopRequireDefault(require("./assetPathUtils"));
+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
+ */
+
+function cleanAssetCatalog(catalogDir) {
+  const files = _fs.default
+    .readdirSync(catalogDir)
+    .filter((file) => file.endsWith(".imageset"));
+  for (const file of files) {
+    _fs.default.rmSync(_path.default.join(catalogDir, file));
+  }
+}
+function getImageSet(catalogDir, asset, scales) {
+  const fileName = _assetPathUtils.default.getResourceIdentifier(asset);
+  return {
+    basePath: _path.default.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],
+      };
+    }),
+  };
+}
+function isCatalogAsset(asset) {
+  return asset.type === "png" || asset.type === "jpg" || asset.type === "jpeg";
+}
+function writeImageSet(imageSet) {
+  _fs.default.mkdirSync(imageSet.basePath, {
+    recursive: true,
+  });
+  for (const file of imageSet.files) {
+    const dest = _path.default.join(imageSet.basePath, file.name);
+    _fs.default.copyFileSync(file.src, dest);
+  }
+  _fs.default.writeFileSync(
+    _path.default.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,
+      },
+    })
+  );
+}

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

@@ -0,0 +1,77 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */
+
+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));
+  }
+}
+
+type ImageSet = {
+  basePath: string,
+  files: {name: string, src: string, scale: number}[],
+};
+
+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});
+
+  for (const file of imageSet.files) {
+    const dest = path.join(imageSet.basePath, file.name);
+    fs.copyFileSync(file.src, dest);
+  }
+
+  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,
+      },
+    }),
+  );
+}

package/dist/commands/bundle/assetPathUtils.js

@@ -0,0 +1,79 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.default = void 0;
+/**
+ * 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
+ */
+
+/**
+ * FIXME: using number to represent discrete scale numbers is fragile in essence because of
+ * floating point numbers imprecision.
+ */
+function getAndroidAssetSuffix(scale) {
+  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 "";
+  }
+}
+
+// See https://developer.android.com/guide/topics/resources/drawable-resource.html
+const drawableFileTypes = new Set(["gif", "jpeg", "jpg", "png", "webp", "xml"]);
+function getAndroidResourceFolderName(asset, scale) {
+  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
+      )}`
+    );
+  }
+  return `drawable-${suffix}`;
+}
+function getResourceIdentifier(asset) {
+  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
+}
+
+function getBasePath(asset) {
+  let basePath = asset.httpServerLocation;
+  if (basePath[0] === "/") {
+    basePath = basePath.substr(1);
+  }
+  return basePath;
+}
+var _default = {
+  getAndroidAssetSuffix,
+  getAndroidResourceFolderName,
+  getResourceIdentifier,
+  getBasePath,
+};
+exports.default = _default;

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

@@ -0,0 +1,93 @@
+/**
+ * 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
+ * @format
+ * @oncall react_native
+ */
+
+export type PackagerAsset = $ReadOnly<{
+  httpServerLocation: string,
+  name: string,
+  type: string,
+  ...
+}>;
+
+/**
+ * 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 '';
+  }
+}
+
+// See https://developer.android.com/guide/topics/resources/drawable-resource.html
+const drawableFileTypes = new Set<string>([
+  'gif',
+  'jpeg',
+  'jpg',
+  'png',
+  'webp',
+  'xml',
+]);
+
+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;
+}
+
+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
+}
+
+function getBasePath(asset: PackagerAsset): string {
+  let basePath = asset.httpServerLocation;
+  if (basePath[0] === '/') {
+    basePath = basePath.substr(1);
+  }
+  return basePath;
+}
+
+export default {
+  getAndroidAssetSuffix,
+  getAndroidResourceFolderName,
+  getResourceIdentifier,
+  getBasePath,
+};

package/dist/commands/bundle/buildBundle.js

@@ -0,0 +1,112 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.unstable_buildBundleWithConfig = exports.default = void 0;
+var _Server = _interopRequireDefault(require("metro/src/Server"));
+var _path = _interopRequireDefault(require("path"));
+var _chalk = _interopRequireDefault(require("chalk"));
+var _saveAssets = _interopRequireDefault(require("./saveAssets"));
+var _loadMetroConfig = _interopRequireDefault(
+  require("../../utils/loadMetroConfig")
+);
+var _cliTools = require("@react-native-community/cli-tools");
+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 outputBundle = require("metro/src/shared/output/bundle");
+async function buildBundle(args, ctx, output = outputBundle) {
+  const config = await (0, _loadMetroConfig.default)(ctx, {
+    maxWorkers: args.maxWorkers,
+    resetCache: args.resetCache,
+    config: args.config,
+  });
+  return buildBundleWithConfig(args, config, output);
+}
+async function buildBundleWithConfig(args, config, output = outputBundle) {
+  if (config.resolver.platforms.indexOf(args.platform) === -1) {
+    _cliTools.logger.error(
+      `Invalid platform ${
+        args.platform ? `"${_chalk.default.bold(args.platform)}" ` : ""
+      }selected.`
+    );
+    _cliTools.logger.info(
+      `Available platforms are: ${config.resolver.platforms
+        .map((x) => `"${_chalk.default.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.default.basename(sourceMapUrl);
+  }
+
+  // $FlowIgnore[prop-missing]
+  const requestOpts = {
+    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.default(config);
+  try {
+    const bundle = await output.build(server, requestOpts);
+
+    // $FlowIgnore[class-object-subtyping]
+    // $FlowIgnore[incompatible-call]
+    await output.save(bundle, args, _cliTools.logger.info);
+
+    // Save the assets of the bundle
+    const outputAssets = await server.getAssets({
+      ..._Server.default.DEFAULT_BUNDLE_OPTIONS,
+      ...requestOpts,
+      bundleType: "todo",
+    });
+
+    // When we're done saving bundle output and the assets, we're done.
+    return await (0, _saveAssets.default)(
+      outputAssets,
+      args.platform,
+      args.assetsDest,
+      args.assetCatalogDest
+    );
+  } finally {
+    server.end();
+  }
+}
+
+/**
+ * UNSTABLE: This function is likely to be relocated and its API changed in
+ * the near future. `@react-native/community-cli-plugin` should not be directly
+ * depended on by projects or integrators -- this is exported for legacy
+ * compatibility.
+ *
+ * Create a bundle using a pre-loaded Metro config. The config can be
+ * re-used for several bundling calls if multiple platforms are being
+ * bundled.
+ */
+const unstable_buildBundleWithConfig = buildBundleWithConfig;
+exports.unstable_buildBundleWithConfig = unstable_buildBundleWithConfig;
+var _default = buildBundle;
+exports.default = _default;

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

@@ -0,0 +1,120 @@
+/**
+ * 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
+ * @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,
+  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);
+}
+
+async function buildBundleWithConfig(
+  args: CommandLineArgs,
+  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();
+  }
+}
+
+/**
+ * UNSTABLE: This function is likely to be relocated and its API changed in
+ * the near future. `@react-native/community-cli-plugin` should not be directly
+ * depended on by projects or integrators -- this is exported for legacy
+ * compatibility.
+ *
+ * Create a bundle using a pre-loaded Metro config. The config can be
+ * re-used for several bundling calls if multiple platforms are being
+ * bundled.
+ */
+export const unstable_buildBundleWithConfig = buildBundleWithConfig;
+
+export default buildBundle;

package/dist/commands/bundle/bundle.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true,
+});
+exports.bundleWithOutput = bundleWithOutput;
+exports.default = void 0;
+var _buildBundle = _interopRequireDefault(require("./buildBundle"));
+var _bundleCommandLineArgs = _interopRequireDefault(
+  require("./bundleCommandLineArgs")
+);
+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
+ */
+
+/**
+ * Builds the bundle starting to look for dependencies at the given entry path.
+ */
+function bundleWithOutput(
+  _,
+  config,
+  args,
+  output // untyped metro/src/shared/output/bundle or metro/src/shared/output/RamBundle
+) {
+  return (0, _buildBundle.default)(args, config, output);
+}
+const bundleCommand = {
+  name: "bundle",
+  description: "Build the bundle for the provided JavaScript entry file.",
+  func: bundleWithOutput,
+  options: _bundleCommandLineArgs.default,
+};
+var _default = bundleCommand;
+exports.default = _default;