@callstack/react-native-brownfield 2.2.0 → 3.0.0-rc.2

package/src/expo-config-plugin/ios/podfileHelpers.ts

@@ -0,0 +1,107 @@
+import { SourceModificationError } from '../errors/SourceModificationError';
+import { Logger } from '../logging';
+import { renderTemplate } from '../template/engine';
+
+const BROWNFIELD_POD_HOOK_MARKER_START =
+  '# >>> react-native-brownfield expo phase ordering >>>';
+const BROWNFIELD_POD_HOOK_MARKER_END =
+  '# <<< react-native-brownfield expo phase ordering <<<';
+const BROWNFIELD_POST_INTEGRATE_REQUIRE = `require File.join(File.dirname(\`node --print "require.resolve('@callstack/react-native-brownfield/package.json')"\`), "scripts/react_native_brownfield_post_integrate")`;
+const REACT_NATIVE_PODS_REQUIRE_REGEX =
+  /^require File\.join\(File\.dirname\(`node --print "require\.resolve\('react-native\/package\.json'\)"`\), "scripts\/react_native_pods"\)\s*$/m;
+
+function ensureBrownfieldPostIntegrateRequire(podfile: string): string {
+  if (podfile.includes('scripts/react_native_brownfield_post_integrate')) {
+    return podfile;
+  }
+
+  const reactNativePodsRequireMatch = podfile.match(
+    REACT_NATIVE_PODS_REQUIRE_REGEX
+  );
+  if (reactNativePodsRequireMatch) {
+    const requireLine = reactNativePodsRequireMatch[0];
+    return podfile.replace(
+      requireLine,
+      `${requireLine}\n${BROWNFIELD_POST_INTEGRATE_REQUIRE}\n`
+    );
+  }
+
+  return `${BROWNFIELD_POST_INTEGRATE_REQUIRE}\n\n${podfile}`;
+}
+
+function ensureExpoPhaseOrderingHook(podfile: string): string {
+  let modifiedPodfile = ensureBrownfieldPostIntegrateRequire(podfile);
+
+  if (modifiedPodfile.includes(BROWNFIELD_POD_HOOK_MARKER_START)) {
+    return modifiedPodfile;
+  }
+
+  const hook = `
+${BROWNFIELD_POD_HOOK_MARKER_START}
+post_integrate do |installer|
+  react_native_brownfield_post_integrate(installer)
+end
+${BROWNFIELD_POD_HOOK_MARKER_END}
+`;
+
+  modifiedPodfile = `${modifiedPodfile.trimEnd()}\n\n${hook}\n`;
+
+  return modifiedPodfile;
+}
+
+/**
+ * Modifies the Podfile to include the Brownfield framework target
+ * @param podfile The original Podfile content
+ * @param frameworkName The name of the framework target to add
+ * @returns The modified Podfile content
+ */
+export function modifyPodfile(
+  podfile: string,
+  frameworkName: string,
+  isExpoPre55: boolean
+): string {
+  // check if the framework target is already included
+  if (podfile.includes(`target '${frameworkName}'`)) {
+    Logger.logDebug(
+      `Framework target "${frameworkName}" already in Podfile, skipping modification`
+    );
+    return podfile;
+  }
+
+  Logger.logDebug(`Modifying Podfile for framework: ${frameworkName}`);
+
+  // insert the framework target after the main target's "do"
+  const frameworkTargetBlock = renderTemplate('ios', 'PodfileTargetBlock.rb', {
+    '{{FRAMEWORK_NAME}}': frameworkName,
+  });
+
+  // find insertion point after the first target's content begins, before the end of the target block
+  const mainTargetMatch = podfile.match(
+    /(target\s+['"][^'"]+['"]\s+do\s*\n)([\s\S]*?)(^end\s*$)/m
+  );
+
+  if (!mainTargetMatch) {
+    throw new SourceModificationError(
+      'Could not find main target in Podfile. Please manually add the framework target.'
+    );
+  }
+
+  const [, targetStart, targetContent] = mainTargetMatch;
+  const insertIndex =
+    podfile.indexOf(mainTargetMatch[0]) +
+    targetStart.length +
+    targetContent.length;
+
+  let modifiedPodfile =
+    podfile.slice(0, insertIndex) +
+    frameworkTargetBlock +
+    podfile.slice(insertIndex);
+
+  Logger.logDebug(`Added framework target "${frameworkName}" to Podfile`);
+
+  if (isExpoPre55) {
+    modifiedPodfile = ensureExpoPhaseOrderingHook(modifiedPodfile);
+  }
+
+  return modifiedPodfile;
+}

package/src/expo-config-plugin/ios/withBrownfieldIos.ts

@@ -0,0 +1,94 @@
+import {
+  withXcodeProject,
+  withPodfile,
+  type ConfigPlugin,
+} from '@expo/config-plugins';
+
+import {
+  addExpoPre55ShellPatchScriptPhase,
+  addFrameworkTarget,
+  addSourceFilesBuildPhase,
+  copyBundleReactNativePhase,
+} from './xcodeHelpers';
+import { modifyPodfile } from './podfileHelpers';
+import { withIosFrameworkFiles } from './withIosFrameworkFiles';
+import type { ResolvedBrownfieldPluginConfigWithIos } from '../types';
+import { Logger } from '../logging';
+
+/**
+ * iOS Config Plugin for integration with @callstack/react-native-brownfield.
+ *
+ * This plugin:
+ * 1. Creates a new Framework target in the Xcode project
+ * 2. Configures the Podfile to include the framework target
+ * 3. Adds necessary build configuration
+ * 4. Adds script phase to patch `ExpoModulesProvider.swift`
+ * 5. Adds the "Bundle React Native code and images" phase of Expo app target to the framework target
+ */
+export const withBrownfieldIos: ConfigPlugin<
+  ResolvedBrownfieldPluginConfigWithIos
+> = (config, props) => {
+  const expoMajor = config.sdkVersion
+    ? parseInt(config.sdkVersion.split('.')[0], 10)
+    : -1;
+  const isExpoPre55 = expoMajor < 55;
+  // Step 1: modify the Xcode project to add framework target &
+  config = withXcodeProject(config, (xcodeConfig) => {
+    const { modResults: project, modRequest } = xcodeConfig;
+
+    const { frameworkTargetUUID, targetAlreadyExists } = addFrameworkTarget(
+      project,
+      modRequest,
+      props.ios
+    );
+
+    if (targetAlreadyExists) {
+      Logger.logDebug(
+        `Skipping further Xcode modifications as framework target was already present`
+      );
+
+      return xcodeConfig;
+    }
+
+    // copy the "Bundle React Native code and images" build phase from the main target to the framework target
+    copyBundleReactNativePhase(project, frameworkTargetUUID);
+
+    // for Expo SDK versions < 55, add a script phase to patch ExpoModulesProvider.swift
+    if (isExpoPre55) {
+      Logger.logDebug(
+        `Adding ExpoModulesProvider patch phase for Expo SDK ${config.sdkVersion}`
+      );
+
+      addExpoPre55ShellPatchScriptPhase(modRequest, project, {
+        frameworkName: props.ios.frameworkName,
+        frameworkTargetUUID: frameworkTargetUUID,
+      });
+    } else {
+      Logger.logDebug(
+        `Skipping ExpoModulesProvider patch phase for Expo SDK ${config.sdkVersion}`
+      );
+    }
+
+    addSourceFilesBuildPhase(project, frameworkTargetUUID, props.ios);
+
+    return xcodeConfig;
+  });
+
+  // Step 2: modify Podfile to include the framework target
+  config = withPodfile(config, (podfileConfig) => {
+    const { frameworkName } = props.ios;
+
+    podfileConfig.modResults.contents = modifyPodfile(
+      podfileConfig.modResults.contents,
+      frameworkName,
+      isExpoPre55
+    );
+
+    return podfileConfig;
+  });
+
+  // Step 3: create the iOS framework files using dangerous mod
+  config = withIosFrameworkFiles(config, props);
+
+  return config;
+};

package/src/expo-config-plugin/ios/withIosFrameworkFiles.ts

@@ -0,0 +1,91 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+
+import { withDangerousMod, type ConfigPlugin } from '@expo/config-plugins';
+
+import type {
+  RenderedTemplateFile,
+  ResolvedBrownfieldPluginConfigWithIos,
+} from '../types';
+import { Logger } from '../logging';
+import { renderTemplate } from '../template/engine';
+
+/**
+ * Returns rendered source files for the iOS framework
+ * @param ios The iOS Brownfield plugin configuration
+ * @returns The list of framework source files
+ */
+export function getFrameworkSourceFiles(
+  ios: ResolvedBrownfieldPluginConfigWithIos['ios']
+): RenderedTemplateFile[] {
+  return [
+    {
+      relativePath: `${ios.frameworkName}.swift`,
+      content: renderTemplate('ios', 'FrameworkInterface.swift', {}),
+    },
+    {
+      relativePath: 'Info.plist',
+      content: renderTemplate('ios', 'Info.plist', {
+        '{{BUNDLE_IDENTIFIER}}': ios.bundleIdentifier,
+      }),
+    },
+  ];
+}
+
+/**
+ * Creates the iOS framework directory structure and files
+ * @param iosDir The root iOS directory path
+ * @param config The resolved Brownfield plugin configuration
+ */
+export function createIosFramework(
+  iosDir: string,
+  config: ResolvedBrownfieldPluginConfigWithIos
+) {
+  const { ios } = config;
+  const frameworkDir = path.join(iosDir, ios.frameworkName);
+
+  // check if framework directory if it exists
+  if (fs.existsSync(frameworkDir)) {
+    Logger.logDebug(`Framework directory already exists: ${frameworkDir}`);
+
+    return;
+  }
+
+  Logger.logDebug(`Creating iOS framework in: ${frameworkDir}`);
+
+  // create framework directory
+  if (!fs.existsSync(frameworkDir)) {
+    fs.mkdirSync(frameworkDir, { recursive: true });
+
+    Logger.logDebug(`Created directory: ${frameworkDir}`);
+  }
+
+  // write files
+  for (const file of getFrameworkSourceFiles(ios)) {
+    const filePath = path.join(frameworkDir, file.relativePath);
+
+    fs.writeFileSync(filePath, file.content, 'utf8');
+  }
+
+  Logger.logDebug(
+    `iOS framework "${ios.frameworkName}" files created at ${frameworkDir}`
+  );
+}
+
+/**
+ * Dangerous mod that creates the iOS framework directory and files
+ */
+export const withIosFrameworkFiles: ConfigPlugin<
+  ResolvedBrownfieldPluginConfigWithIos
+> = (config, props) => {
+  return withDangerousMod(config, [
+    'ios',
+    async (dangerousConfig) => {
+      const iosDir = path.join(dangerousConfig.modRequest.projectRoot, 'ios');
+
+      createIosFramework(iosDir, props);
+
+      return dangerousConfig;
+    },
+  ]);
+};