@callstack/brownfield-cli 1.0.3 → 2.0.0-rc.1

package/src/brownfield/commands/packageIos.ts

@@ -15,14 +15,15 @@ import {
 
 import { Command } from 'commander';
 
-import { isBrownieInstalled } from '../../brownie/config.js';
-import { runCodegen } from '../../brownie/commands/codegen.js';
-import { getProjectInfo, stripFrameworkBinary } from '../utils/index.js';
+import { runExpoPrebuildIfNeeded } from '../utils/expo.js';
+import { getProjectInfo } from '../utils/project.js';
 import {
   actionRunner,
   curryOptions,
   ExampleUsage,
 } from '../../shared/index.js';
+import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
+import { stripFrameworkBinary } from '../utils/stripFrameworkBinary.js';
 
 export const packageIosCommand = curryOptions(
   new Command('package:ios').description('Build iOS XCFramework'),
@@ -32,13 +33,14 @@ export const packageIosCommand = curryOptions(
           ...option,
           description:
             option.description +
-            " By default, the '<iOS project folder>/build' path will be used.",
+            " By default, the '.brownfield/build' path will be used.",
         }
       : option
   )
 ).action(
   actionRunner(async (options: AppleBuildFlags) => {
     const { projectRoot, platformConfig, userConfig } = getProjectInfo('ios');
+    await runExpoPrebuildIfNeeded({ projectRoot, platform: 'ios' });
 
     if (!userConfig.project.ios) {
       throw new Error('iOS project not found.');
@@ -48,19 +50,32 @@ export const packageIosCommand = curryOptions(
       throw new Error('iOS Xcode project not found in the configuration.');
     }
 
-    const brownieCacheDir = path.join(
-      userConfig.project.ios.sourceDir,
+    let dotBrownfieldDir = path.join(
+      // for Expo projects, platformConfig?.sourceDir == "", but for non-Expo projects, it's "ios"
+      ...(userConfig.project.ios.sourceDir.trim().length > 0
+        ? [userConfig.project.ios.sourceDir]
+        : [projectRoot, 'ios']),
       '.brownfield'
     );
 
-    options.buildFolder ??= path.join(brownieCacheDir, 'build');
-    const packageDir = path.join(brownieCacheDir, 'package');
+    // non-Expo projects have a relative sourceDir path, so we need to make it absolute
+    if (!path.isAbsolute(dotBrownfieldDir)) {
+      dotBrownfieldDir = path.join(projectRoot, dotBrownfieldDir);
+    }
+
+    options.buildFolder ??= path.join(dotBrownfieldDir, 'build');
+
+    // The new_architecture.rb script scans Info.plist and fails on binary plist files,
+    // which is the case for our XCFrameworks.
+    // We're reusing the "build" directory which is excluded from the scan.
+    // Reference: https://github.com/facebook/react-native/blob/490c5e8dcc6cdb19c334cc39e93a39a48ba71e96/packages/react-native/scripts/cocoapods/new_architecture.rb#L171
+    const packageDir = path.join(dotBrownfieldDir, 'package', 'build');
     const configuration = options.configuration ?? 'Debug';
 
-    const hasBrownie = isBrownieInstalled(projectRoot);
-    if (hasBrownie) {
-      await runCodegen({ platform: 'swift' });
-    }
+    const { hasBrownie } = await runBrownieCodegenIfApplicable(
+      projectRoot,
+      'swift'
+    );
 
     await packageIosAction(
       options,
@@ -104,7 +119,7 @@ export const packageIosCommand = curryOptions(
       // Strip the binary from Brownie.xcframework to make it interface-only.
       // This avoids duplicate symbols when consumer apps embed both BrownfieldLib
       // (which contains Brownie symbols) and Brownie.xcframework.
-      await stripFrameworkBinary(brownieOutputPath);
+      stripFrameworkBinary(brownieOutputPath);
 
       logger.success(
         `Brownie.xcframework created at ${colorLink(relativeToCwd(brownieOutputPath))}`

package/src/brownfield/commands/publishAndroid.ts

@@ -6,12 +6,14 @@ import {
 
 import { Command } from 'commander';
 
-import { getProjectInfo } from '../utils/index.js';
 import {
   actionRunner,
   curryOptions,
   ExampleUsage,
 } from '../../shared/index.js';
+import { getProjectInfo } from '../utils/project.js';
+import { runExpoPrebuildIfNeeded } from '../utils/expo.js';
+import { runBrownieCodegenIfApplicable } from '../../brownie/helpers/runBrownieCodegenIfApplicable.js';
 
 export const publishAndroidCommand = curryOptions(
   new Command('publish:android').description(
@@ -21,6 +23,12 @@ export const publishAndroidCommand = curryOptions(
 ).action(
   actionRunner(async (options: PublishLocalAarFlags) => {
     const { projectRoot, platformConfig } = getProjectInfo('android');
+    await runExpoPrebuildIfNeeded({
+      projectRoot,
+      platform: 'android',
+    });
+
+    await runBrownieCodegenIfApplicable(projectRoot, 'kotlin');
 
     await publishLocalAarAction({
       projectRoot,

package/src/brownfield/index.ts

@@ -9,8 +9,6 @@ import {
 } from './commands/publishAndroid.js';
 import { packageIosCommand, packageIosExample } from './commands/packageIos.js';
 
-export * from './utils/index.js';
-
 export const groupName = `${styleText(['bold', 'blueBright'], '@callstack/react-native-brownfield')}${styleText('whiteBright', ' - utilities for React Native Brownfield projects')}`;
 
 export const Commands = {

package/src/brownfield/utils/expo.ts

@@ -0,0 +1,71 @@
+import { spawn } from 'node:child_process';
+
+import { logger } from '@rock-js/tools';
+
+import { isExpoProject } from './project.js';
+
+type ExpoPlatform = 'ios' | 'android';
+
+async function spawnCommand({
+  command,
+  args,
+  cwd,
+}: {
+  command: string;
+  args: string[];
+  cwd: string;
+}) {
+  await new Promise<void>((resolve, reject) => {
+    const child = spawn(command, args, {
+      cwd,
+      env: process.env,
+      stdio: 'inherit',
+    });
+
+    child.on('error', reject);
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(
+          new Error(
+            `Command "${command} ${args.join(' ')}" failed with exit code ${code ?? 'unknown'}.`
+          )
+        );
+      }
+    });
+  });
+}
+
+function getNpxCommand() {
+  return process.platform === 'win32' ? 'npx.cmd' : 'npx';
+}
+
+export async function runExpoPrebuildIfNeeded({
+  projectRoot,
+  platform,
+}: {
+  projectRoot: string;
+  platform: ExpoPlatform;
+}) {
+  if (!isExpoProject(projectRoot)) {
+    return false;
+  }
+
+  logger.info(
+    `Expo project detected. Running expo prebuild for ${platform}...`
+  );
+
+  const args = ['expo', 'prebuild', '--platform', platform];
+  if (platform === 'ios') {
+    args.push('--no-install');
+  }
+
+  await spawnCommand({
+    command: getNpxCommand(),
+    args,
+    cwd: projectRoot,
+  });
+
+  return true;
+}

package/src/brownfield/utils/paths.ts

@@ -5,21 +5,18 @@ import type {
   AndroidProjectConfig,
   IOSProjectConfig,
 } from '@react-native-community/cli-types';
-import cloneDeep from 'lodash.clonedeep';
 
+/**
+ * Helper function to mutate the user config paths in place to be relative to the project root
+ * @param projectRoot The path to the project root directory
+ * @param userConfig User configuration from the RNC CLI
+ */
 export function makeRelativeProjectConfigPaths<
   UserConfig extends AndroidProjectConfig | IOSProjectConfig | undefined,
->(projectRoot: string, userConfig: UserConfig): UserConfig {
-  const relativeConfig = cloneDeep(userConfig);
-
+>(projectRoot: string, userConfig: UserConfig) {
   if (userConfig?.sourceDir) {
-    relativeConfig!.sourceDir = path.relative(
-      projectRoot,
-      userConfig.sourceDir
-    );
+    userConfig.sourceDir = path.relative(projectRoot, userConfig.sourceDir);
   }
-
-  return relativeConfig;
 }
 
 /**

package/src/brownfield/utils/project.ts

@@ -0,0 +1,174 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import type {
+  AndroidProjectConfig,
+  ProjectConfig,
+  UserConfig,
+} from '@react-native-community/cli-types';
+import type { PackageAarFlags } from '@rock-js/platform-android';
+
+import cliConfigImport from '@react-native-community/cli-config';
+
+import { findProjectRoot, makeRelativeProjectConfigPaths } from './paths.js';
+import {
+  getConfig,
+  type ProjectConfig as ExpoProjectConfig,
+} from '@expo/config';
+
+const cliConfig: typeof cliConfigImport =
+  typeof cliConfigImport === 'function'
+    ? cliConfigImport
+    : // @ts-expect-error: interop default
+      cliConfigImport.default;
+
+/**
+ * Gets the Expo config if the project is an Expo project
+ * @param projectRoot The project root path
+ * @returns The Expo config if the project is an Expo project, null otherwise
+ */
+export function getExpoConfigIfIsExpo(projectRoot: string) {
+  try {
+    return getConfig(projectRoot, { skipSDKVersionRequirement: true });
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Checks if the project is an Expo project; checks both if installed and explicitly listed
+ * in the project's package.json to prevent false positives in a monorepo setup
+ * @param projectRoot The project root path
+ * @returns Whether the project is an Expo project
+ */
+export function isExpoProject(projectRoot: string): boolean {
+  const hasExpoConfig = getExpoConfigIfIsExpo(projectRoot) !== null;
+
+  // additionally, it is needed to check if the project depends on Expo packages explicitly
+  // to prevent false positives in a monorepo setup
+  const rnProjectRoot = findProjectRoot();
+  const packageJsonPath = path.join(rnProjectRoot, 'package.json');
+  const dependsOnExpo =
+    fs.existsSync(packageJsonPath) &&
+    ['dependencies', 'peerDependencies', 'devDependencies'].some(
+      (key) => JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'))[key]?.expo
+    );
+
+  return hasExpoConfig && dependsOnExpo;
+}
+
+/**
+ * Fills the RNC CLI project config from the Expo config by mutating the passed in `options.projectConfig` object in place
+ */
+export function fillProjectConfigFromExpoConfig({
+  projectConfig,
+  expoConfig: { exp },
+  projectRoot,
+}: {
+  /** The RNC CLI project config to be filled */
+  projectConfig: ProjectConfig;
+
+  /** The Expo project config */
+  expoConfig: ExpoProjectConfig;
+
+  /** The project root path */
+  projectRoot: string;
+}) {
+  if (exp.android) {
+    projectConfig['android'] = {
+      applicationId: exp.android.package!,
+      packageName: exp.android.package!,
+      appName: exp.name!,
+      assets: [],
+      mainActivity: 'MainActivity',
+      sourceDir: 'android',
+    };
+  }
+
+  if (exp.ios) {
+    projectConfig['ios'] = {
+      assets: [],
+      sourceDir: projectRoot,
+      xcodeProject: {
+        path: '.',
+        name: `${exp.name}.xcworkspace`,
+        isWorkspace: true,
+      },
+    };
+  }
+}
+
+/**
+ * Gets the project info for the given platform from the current working directory
+ * @param platform the platform for which to get project info
+ * @returns project root and android project config
+ */
+export function getProjectInfo<Platform extends 'ios' | 'android'>(
+  platform: Platform
+): {
+  projectRoot: string;
+  userConfig: UserConfig;
+  platformConfig: ProjectConfig[Platform];
+} {
+  const projectRoot = findProjectRoot();
+
+  const userConfig = getUserConfig({ projectRoot, platform });
+  const platformConfig = userConfig.project[platform as Platform];
+
+  if (!platformConfig) {
+    throw new Error(`${platform} project not found.`);
+  }
+
+  return {
+    projectRoot,
+    userConfig,
+    platformConfig: platformConfig,
+  };
+}
+
+export function getUserConfig({
+  projectRoot,
+  platform,
+}: {
+  projectRoot: string;
+  platform: 'ios' | 'android';
+}): UserConfig {
+  // resolve the config using RNC CLI
+  const userConfig = cliConfig({
+    projectRoot,
+    selectedPlatform: platform,
+  });
+
+  let projectConfig = userConfig.project;
+
+  // below: try augmenting the config with values for Expo projects, if applicable
+  const maybeExpoConfig = getExpoConfigIfIsExpo(projectRoot);
+  if (maybeExpoConfig) {
+    fillProjectConfigFromExpoConfig({
+      projectConfig,
+      expoConfig: maybeExpoConfig,
+      projectRoot,
+    });
+  }
+
+  // below: relative sourceDir path is required by RN CLI's API
+  makeRelativeProjectConfigPaths(projectRoot, projectConfig[platform]);
+
+  return userConfig;
+}
+
+/**
+ * Gets the AAR packaging configuration for the given Android project
+ * @param args The AAR packaging flags
+ * @param androidConfig The Android project config
+ */
+export function getAarConfig(
+  args: PackageAarFlags,
+  androidConfig: AndroidProjectConfig
+) {
+  const config = {
+    sourceDir: androidConfig.sourceDir,
+    moduleName: args.moduleName ?? '',
+  };
+
+  return config;
+}

package/src/brownie/commands/codegen.ts

@@ -15,6 +15,7 @@ import { generateSwift } from '../generators/swift.js';
 import { generateKotlin } from '../generators/kotlin.js';
 import { discoverStores, type DiscoveredStore } from '../store-discovery.js';
 import type { Platform } from '../types.js';
+import { NoBrownieStoresError } from '../errors/NoBrownieStoresError.js';
 
 function getOutputPath(dir: string, name: string, ext: string): string {
   return path.join(dir, `${name}.${ext}`);
@@ -100,25 +101,37 @@ export async function runCodegen({ platform }: RunCodegenOptions) {
     process.exit(1);
   }
 
-  const stores = discoverStores();
-  const isMultipleStores = stores.length > 1;
-  const schemaList = stores.map((s) => path.basename(s.schemaPath)).join(', ');
+  try {
+    const stores = discoverStores();
+    const isMultipleStores = stores.length > 1;
+    const schemaList = stores
+      .map((s) => path.basename(s.schemaPath))
+      .join(', ');
 
-  logger.info(
-    styleText('cyan', `Generating store types from ${schemaList}...`)
-  );
+    logger.info(
+      styleText('cyan', `Generating store types from ${schemaList}...`)
+    );
+
+    for (const store of stores) {
+      let platforms: Platform[];
 
-  for (const store of stores) {
-    let platforms: Platform[];
+      if (platform) {
+        platforms = [platform];
+      } else {
+        // Only generate Swift by default (Kotlin not yet released)
+        platforms = ['swift'];
+      }
 
-    if (platform) {
-      platforms = [platform];
+      await generateForStore(store, config, platforms, isMultipleStores);
+    }
+  } catch (error) {
+    if (error instanceof NoBrownieStoresError) {
+      logger.error(error.message);
+      outro('No brownie stores found, nothing was generated.');
+      return;
     } else {
-      // Only generate Swift by default (Kotlin not yet released)
-      platforms = ['swift'];
+      throw error;
     }
-
-    await generateForStore(store, config, platforms, isMultipleStores);
   }
 
   outro('Done!');

package/src/brownie/errors/NoBrownieStoresError.ts

@@ -0,0 +1,6 @@
+export class NoBrownieStoresError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = 'NoBrownieStoresError';
+  }
+}

package/src/brownie/helpers/runBrownieCodegenIfApplicable.ts

@@ -0,0 +1,16 @@
+import { runCodegen } from '../commands/codegen.js';
+import { isBrownieInstalled } from '../config.js';
+
+import type { Platform } from '../types.js';
+
+export async function runBrownieCodegenIfApplicable(
+  projectRoot: string,
+  platform: Platform
+) {
+  const hasBrownie = isBrownieInstalled(projectRoot);
+  if (hasBrownie) {
+    await runCodegen({ platform });
+  }
+
+  return { hasBrownie };
+}

package/src/brownie/store-discovery.ts

@@ -2,6 +2,8 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { Project } from 'ts-morph';
 
+import { NoBrownieStoresError } from './errors/NoBrownieStoresError.js';
+
 export interface DiscoveredStore {
   name: string;
   schemaPath: string;
@@ -75,7 +77,7 @@ export function discoverStores(
   const brownieFiles = findBrownieFiles(rootDir);
 
   if (brownieFiles.length === 0) {
-    throw new Error(
+    throw new NoBrownieStoresError(
       'No brownie store files found. Create a file ending with .brownie.ts ' +
         '(e.g., MyStore.brownie.ts)'
     );

package/dist/brownfield/utils/index.d.ts

@@ -1,4 +0,0 @@
-export * from './paths.js';
-export * from './rn-cli.js';
-export * from './stripFrameworkBinary.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/brownfield/utils/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,2BAA2B,CAAC"}

package/dist/brownfield/utils/index.js

@@ -1,3 +0,0 @@
-export * from './paths.js';
-export * from './rn-cli.js';
-export * from './stripFrameworkBinary.js';

package/dist/brownfield/utils/rn-cli.d.ts

@@ -1,17 +0,0 @@
-import type { PackageAarFlags } from '@rock-js/platform-android';
-import type { AndroidProjectConfig, Config as UserConfig, ProjectConfig } from '@react-native-community/cli-types';
-/**
- * Gets the project info for the given platform from the current working directory
- * @param platform the platform for which to get project info
- * @returns project root and android project config
- */
-export declare function getProjectInfo<Platform extends 'ios' | 'android'>(platform: Platform): {
-    projectRoot: string;
-    userConfig: UserConfig;
-    platformConfig: ProjectConfig[Platform];
-};
-export declare const getAarConfig: (args: PackageAarFlags, androidConfig: AndroidProjectConfig) => {
-    sourceDir: string;
-    moduleName: string;
-};
-//# sourceMappingURL=rn-cli.d.ts.map

package/dist/brownfield/utils/rn-cli.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"rn-cli.d.ts","sourceRoot":"","sources":["../../../src/brownfield/utils/rn-cli.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EACV,oBAAoB,EACpB,MAAM,IAAI,UAAU,EACpB,aAAa,EACd,MAAM,mCAAmC,CAAC;AAW3C;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,QAAQ,SAAS,KAAK,GAAG,SAAS,EAC/D,QAAQ,EAAE,QAAQ,GACjB;IACD,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,UAAU,CAAC;IACvB,cAAc,EAAE,aAAa,CAAC,QAAQ,CAAC,CAAC;CACzC,CAmBA;AAED,eAAO,MAAM,YAAY,GACvB,MAAM,eAAe,EACrB,eAAe,oBAAoB;;;CAOpC,CAAC"}

package/dist/brownfield/utils/rn-cli.js

@@ -1,31 +0,0 @@
-import cliConfigImport from '@react-native-community/cli-config';
-const cliConfig = typeof cliConfigImport === 'function'
-    ? cliConfigImport
-    : // @ts-expect-error: interop default
-        cliConfigImport.default;
-import { findProjectRoot, makeRelativeProjectConfigPaths } from './paths.js';
-/**
- * Gets the project info for the given platform from the current working directory
- * @param platform the platform for which to get project info
- * @returns project root and android project config
- */
-export function getProjectInfo(platform) {
-    const projectRoot = findProjectRoot();
-    const userConfig = cliConfig({
-        projectRoot,
-        selectedPlatform: platform,
-    });
-    // below: relative sourceDir path is required by RN CLI's API
-    const platformConfig = makeRelativeProjectConfigPaths(projectRoot, userConfig.project[platform]);
-    if (!platformConfig) {
-        throw new Error(`${platform} project not found.`);
-    }
-    return { projectRoot, userConfig, platformConfig };
-}
-export const getAarConfig = (args, androidConfig) => {
-    const config = {
-        sourceDir: androidConfig.sourceDir,
-        moduleName: args.moduleName ?? '',
-    };
-    return config;
-};

package/src/brownfield/utils/index.ts

@@ -1,3 +0,0 @@
-export * from './paths.js';
-export * from './rn-cli.js';
-export * from './stripFrameworkBinary.js';

package/src/brownfield/utils/rn-cli.ts

@@ -1,58 +0,0 @@
-import type { PackageAarFlags } from '@rock-js/platform-android';
-import type {
-  AndroidProjectConfig,
-  Config as UserConfig,
-  ProjectConfig,
-} from '@react-native-community/cli-types';
-import cliConfigImport from '@react-native-community/cli-config';
-
-const cliConfig: typeof cliConfigImport =
-  typeof cliConfigImport === 'function'
-    ? cliConfigImport
-    : // @ts-expect-error: interop default
-      cliConfigImport.default;
-
-import { findProjectRoot, makeRelativeProjectConfigPaths } from './paths.js';
-
-/**
- * Gets the project info for the given platform from the current working directory
- * @param platform the platform for which to get project info
- * @returns project root and android project config
- */
-export function getProjectInfo<Platform extends 'ios' | 'android'>(
-  platform: Platform
-): {
-  projectRoot: string;
-  userConfig: UserConfig;
-  platformConfig: ProjectConfig[Platform];
-} {
-  const projectRoot = findProjectRoot();
-
-  const userConfig = cliConfig({
-    projectRoot,
-    selectedPlatform: platform,
-  });
-
-  // below: relative sourceDir path is required by RN CLI's API
-  const platformConfig = makeRelativeProjectConfigPaths(
-    projectRoot,
-    userConfig.project[platform]
-  );
-
-  if (!platformConfig) {
-    throw new Error(`${platform} project not found.`);
-  }
-
-  return { projectRoot, userConfig, platformConfig };
-}
-
-export const getAarConfig = (
-  args: PackageAarFlags,
-  androidConfig: AndroidProjectConfig
-) => {
-  const config = {
-    sourceDir: androidConfig.sourceDir,
-    moduleName: args.moduleName ?? '',
-  };
-  return config;
-};