react-native-macos/react-native.config.js

React Native for macOS

/**
 * 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
 */

'use strict';

/*::
import type {Command} from '@react-native-community/cli-types';
 */

// React Native shouldn't be exporting itself like this, the Community Template should be be directly
// depending on and injecting:
// - @react-native-community/cli-platform-android
// - @react-native-community/cli-platform-ios
// - @react-native/community-cli-plugin (via the @react-native/core-cli-utils package)
// - codegen command should be inhoused into @react-native-community/cli
//
// This is a temporary workaround.

const verbose = Boolean(process.env.DEBUG?.includes('react-native'));

function findCommunityPlatformPackage(
  spec /*: string */,
  startDir /*: string */ = process.cwd(),
) {
  // In monorepos, we cannot make any assumptions on where
  // `@react-native-community/*` gets installed. The safest way to find it
  // (barring adding an optional peer dependency) is to start from the project
  // root.
  //
  // Note that we're assuming that the current working directory is the project
  // root. This is also what `@react-native-community/cli` assumes (see
  // https://github.com/react-native-community/cli/blob/14.x/packages/cli-tools/src/findProjectRoot.ts).
  const main = require.resolve(spec, {paths: [startDir]});
  // $FlowIgnore[unsupported-syntax]
  return require(main);
}

let android;
try {
  android = findCommunityPlatformPackage(
    '@react-native-community/cli-platform-android',
  );
} catch {
  if (verbose) {
    console.warn(
      '@react-native-community/cli-platform-android not found, the react-native.config.js may be unusable.',
    );
  }
}

let ios;
try {
  ios = findCommunityPlatformPackage(
    '@react-native-community/cli-platform-ios',
  );
} catch {
  if (verbose) {
    console.warn(
      '@react-native-community/cli-platform-ios not found, the react-native.config.js may be unusable.',
    );
  }
}

// [macOS
let apple;
try {
  const iosPath = require.resolve('@react-native-community/cli-platform-ios', {
    paths: [process.cwd()],
  });
  // $FlowFixMe[untyped-import]
  apple = findCommunityPlatformPackage(
    '@react-native-community/cli-platform-apple',
    iosPath,
  );
} catch {
  if (verbose) {
    console.warn(
      '@react-native-community/cli-platform-apple not found, the react-native.config.js may be unusable.',
    );
  }
}

// $FlowFixMe[untyped-import]
const macosCommands = require('./local-cli/runMacOS/runMacOS');
const {
  bundleCommand,
  startCommand,
} = require('@react-native/community-cli-plugin');

// macOS]
const commands /*: Array<Command> */ = [];

commands.push(bundleCommand, startCommand);

const codegenCommand /*: Command */ = {
  name: 'codegen',
  options: [
    {
      name: '--path <path>',
      description: 'Path to the React Native project root.',
      default: process.cwd(),
    },
    {
      name: '--platform <string>',
      description:
        'Target platform. Supported values: "android", "ios", "all".',
      default: 'all',
    },
    {
      name: '--outputPath <path>',
      description: 'Path where generated artifacts will be output to.',
    },
    {
      name: '--source <string>',
      description: 'Whether the script is invoked from an `app` or a `library`',
      default: 'app',
    },
  ],
  func: (argv, config, args) =>
    require('./scripts/codegen/generate-artifacts-executor').execute(
      args.path,
      args.platform,
      args.outputPath,
      args.source,
    ),
};

commands.push(codegenCommand);

const config = {
  commands,
  platforms: {} /*:: as {[string]: $ReadOnly<{
      projectConfig: mixed,
      dependencyConfig: mixed,
      linkConfig?: mixed,
      npmPackageName?: mixed,
    }>} */,
};

if (ios != null) {
  config.commands.push(...ios.commands);
  config.platforms.ios = {
    projectConfig: ios.projectConfig,
    dependencyConfig: ios.dependencyConfig,
  };
}

if (android != null) {
  config.commands.push(...android.commands);
  config.platforms.android = {
    projectConfig: android.projectConfig,
    dependencyConfig: android.dependencyConfig,
  };
}

// [macOS
config.commands.push(...macosCommands);
if (apple) {
  config.platforms.macos = {
    linkConfig: () => {
      return {
        isInstalled: (
          _projectConfig /*: mixed */,
          _package /*: mixed */,
          _dependencyConfig /*: mixed */,
        ) => false,
        register: (
          _package /*: mixed */,
          _dependencyConfig /*: mixed */,
          _obj /*: mixed */,
          _projectConfig /*: mixed */,
        ) => {},
        unregister: (
          _package /*: mixed */,
          _dependencyConfig /*: mixed */,
          _projectConfig /*: mixed */,
          _dependencyConfigs /*: mixed */,
        ) => {},
        copyAssets: (_assets /*: mixed */, _projectConfig /*: mixed */) => {},
        unlinkAssets: (_assets /*: mixed */, _projectConfig /*: mixed */) => {},
      };
    },
    projectConfig: apple.getProjectConfig({platformName: 'macos'}),
    dependencyConfig: apple.getProjectConfig({platformName: 'macos'}),
    npmPackageName: 'react-native-macos',
  };
}
// macOS]

module.exports = config;