fix: pass user config to commands and config from rnccli (#265)

thymikee · web-flow · commit 4a3ca21eabec · 2025-04-18T12:13:33.000+02:00
* fix: pass user config to commands and config from rnccli

* changeset

* adjust comment

* update docs

* docs
diff --git a/.changeset/dirty-parents-repair.md b/.changeset/dirty-parents-repair.md
@@ -0,0 +1,11 @@
+---
+'@rnef/plugin-brownfield-android': patch
+'@rnef/platform-apple-helpers': patch
+'@rnef/plugin-brownfield-ios': patch
+'@rnef/platform-android': patch
+'@rnef/platform-ios': patch
+'@rnef/config': patch
+'@rnef/cli': patch
+---
+
+fix: pass user config to commands and config from rnccli
diff --git a/packages/cli/src/config.ts b/packages/cli/src/config.ts
@@ -2,6 +2,7 @@ import type {
   Config,
   DependencyConfig,
 } from '@react-native-community/cli-types';
+import type { ConfigOutput } from '@rnef/config';
 
 function isValidRNDependency(config: DependencyConfig) {
   return (
@@ -25,13 +26,29 @@ function filterConfig(config: Config) {
   return filtered;
 }
 
-export const logConfig = async (options: { platform?: string }) => {
+export const logConfig = async (
+  args: { platform?: string },
+  ownConfig: ConfigOutput
+) => {
   const { loadConfigAsync } = await import(
     '@react-native-community/cli-config'
   );
   const config = await loadConfigAsync({
-    selectedPlatform: options.platform,
+    selectedPlatform: args.platform,
   });
 
+  for (const platform in ownConfig.platforms) {
+    for (const projectEntry in config.project[platform]) {
+      if (
+        ownConfig.platforms[platform].autolinkingConfig &&
+        projectEntry in ownConfig.platforms[platform].autolinkingConfig
+      ) {
+        config.project[platform][projectEntry] =
+          // @ts-expect-error todo: type it better
+          ownConfig.platforms[platform].autolinkingConfig[projectEntry];
+      }
+    }
+  }
+
   console.log(JSON.stringify(filterConfig(config), null, 2));
 };
diff --git a/packages/cli/src/lib/cli.ts b/packages/cli/src/lib/cli.ts
@@ -31,13 +31,13 @@ export const cli = async ({ cwd, argv }: CliOptions = {}) => {
     .option('--verbose', 'enable verbose logging')
     .version(version);
 
+  // Register commands from the config
+  const config = await getConfig(cwd);
+
   program
     .command('config')
     .option('-p, --platform <string>', 'Select platform, e.g. ios or android')
-    .action(logConfig);
-
-  // Register commands from the config
-  const config = await getConfig(cwd);
+    .action((args) => logConfig(args, config));
 
   program
     .command('fingerprint [path]')
diff --git a/packages/config/src/lib/config.ts b/packages/config/src/lib/config.ts
@@ -11,6 +11,10 @@ export type PluginOutput = {
   description: string;
 };
 
+export type PlatformOutput = PluginOutput & {
+  autolinkingConfig: object | undefined;
+};
+
 export type PluginApi = {
   registerCommand: (command: CommandType) => void;
   getProjectRoot: () => string;
@@ -28,6 +32,8 @@ type SupportedRemoteCacheProviders = 'github-actions';
 
 type PluginType = (args: PluginApi) => PluginOutput;
 
+type PlatformType = (args: PluginApi) => PlatformOutput;
+
 type ArgValue = string | string[] | number | boolean;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -60,7 +66,7 @@ export type ConfigType = {
   reactNativePath?: string;
   bundler?: PluginType;
   plugins?: PluginType[];
-  platforms?: Record<string, PluginType>;
+  platforms?: Record<string, PlatformType>;
   commands?: Array<CommandType>;
   remoteCacheProvider?: SupportedRemoteCacheProviders;
   fingerprint?: {
@@ -69,8 +75,9 @@ export type ConfigType = {
   };
 };
 
-type ConfigOutput = {
+export type ConfigOutput = {
   commands?: Array<CommandType>;
+  platforms?: Record<string, PlatformOutput>;
 } & PluginApi;
 
 const extensions = ['.js', '.ts', '.mjs'];
@@ -147,10 +154,11 @@ export async function getConfig(
     getReactNativePath: () => config.reactNativePath as string,
     getPlatforms: () => config.platforms as { [platform: string]: object },
     getRemoteCacheProvider: () => config.remoteCacheProvider,
-    getFingerprintOptions: () => config.fingerprint as {
-      extraSources: string[];
-      ignorePaths: string[];
-    },
+    getFingerprintOptions: () =>
+      config.fingerprint as {
+        extraSources: string[];
+        ignorePaths: string[];
+      },
   };
 
   if (config.plugins) {
@@ -160,10 +168,12 @@ export async function getConfig(
     }
   }
 
+  const platforms: Record<string, PlatformOutput> = {};
   if (config.platforms) {
     // platforms register commands and custom platform functionality (TBD)
     for (const platform in config.platforms) {
-      config.platforms[platform](api);
+      const platformOutput = config.platforms[platform](api);
+      platforms[platform] = platformOutput;
     }
   }
 
@@ -173,6 +183,7 @@ export async function getConfig(
 
   const outputConfig: ConfigOutput = {
     commands: config.commands ?? [],
+    platforms: platforms ?? {},
     ...api,
   };
 
diff --git a/packages/platform-android/src/lib/commands/buildAndroid/command.ts b/packages/platform-android/src/lib/commands/buildAndroid/command.ts
@@ -1,16 +1,17 @@
 import { projectConfig } from '@react-native-community/cli-config-android';
+import type { AndroidProjectConfig } from '@react-native-community/cli-types';
 import type { PluginApi } from '@rnef/config';
 import { RnefError } from '@rnef/tools';
 import type { BuildFlags } from './buildAndroid.js';
 import { buildAndroid, options } from './buildAndroid.js';
 
-export function registerBuildCommand(api: PluginApi) {
+export function registerBuildCommand(api: PluginApi, pluginConfig?: AndroidProjectConfig) {
   api.registerCommand({
     name: 'build:android',
     description: 'Builds your app for Android platform.',
     action: async (args) => {
       const projectRoot = api.getProjectRoot();
-      const androidConfig = projectConfig(projectRoot);
+      const androidConfig = projectConfig(projectRoot, pluginConfig);
       if (androidConfig) {
         await buildAndroid(androidConfig, args as BuildFlags);
       } else {
diff --git a/packages/platform-android/src/lib/commands/generateKeystore.ts b/packages/platform-android/src/lib/commands/generateKeystore.ts
@@ -14,13 +14,13 @@ import {
   spawn,
 } from '@rnef/tools';
 
-export function registerCreateKeystoreCommand(api: PluginApi) {
+export function registerCreateKeystoreCommand(api: PluginApi, pluginConfig?: AndroidProjectConfig) {
   api.registerCommand({
     name: 'create-keystore:android',
     description: 'Creates a keystore file for signing Android release builds.',
     action: async (args) => {
       const projectRoot = api.getProjectRoot();
-      const androidConfig = projectConfig(projectRoot);
+      const androidConfig = projectConfig(projectRoot, pluginConfig);
       if (androidConfig) {
         await generateKeystore(androidConfig, args);
       } else {
diff --git a/packages/platform-android/src/lib/commands/runAndroid/command.ts b/packages/platform-android/src/lib/commands/runAndroid/command.ts
@@ -15,11 +15,11 @@ export function registerRunCommand(
       'Builds your app and starts it on a connected Android emulator or a device.',
     action: async (args) => {
       const projectRoot = api.getProjectRoot();
-      const androidConfig = projectConfig(projectRoot);
+      const androidConfig = projectConfig(projectRoot, pluginConfig);
       if (androidConfig) {
         await runAndroid(
           androidConfig,
-          { ...pluginConfig, ...(args as Flags) },
+          args as Flags,
           projectRoot,
           api.getRemoteCacheProvider(),
           api.getFingerprintOptions()
diff --git a/packages/platform-android/src/lib/platformAndroid.ts b/packages/platform-android/src/lib/platformAndroid.ts
@@ -1,5 +1,6 @@
+import path from 'node:path';
 import type { AndroidProjectConfig } from '@react-native-community/cli-types';
-import type { PluginApi, PluginOutput } from '@rnef/config';
+import type { PlatformOutput, PluginApi } from '@rnef/config';
 import { registerBuildCommand } from './commands/buildAndroid/command.js';
 import { registerCreateKeystoreCommand } from './commands/generateKeystore.js';
 import { registerRunCommand } from './commands/runAndroid/command.js';
@@ -9,15 +10,21 @@ type PluginConfig = AndroidProjectConfig;
 
 export const platformAndroid =
   (pluginConfig?: PluginConfig) =>
-  (api: PluginApi): PluginOutput => {
-    registerBuildCommand(api);
+  (api: PluginApi): PlatformOutput => {
+    registerBuildCommand(api, pluginConfig);
     registerRunCommand(api, pluginConfig);
-    registerCreateKeystoreCommand(api);
+    registerCreateKeystoreCommand(api, pluginConfig);
     registerSignCommand(api);
 
     return {
       name: '@rnef/platform-android',
       description: 'RNEF plugin for everything Android.',
+      autolinkingConfig: {
+        ...pluginConfig,
+        sourceDir: pluginConfig?.sourceDir
+          ? path.join(api.getProjectRoot(), pluginConfig.sourceDir)
+          : undefined,
+      },
     };
   };
 
diff --git a/packages/platform-apple-helpers/src/lib/utils/buildApp.ts b/packages/platform-apple-helpers/src/lib/utils/buildApp.ts
@@ -1,4 +1,5 @@
 import path from 'node:path';
+import type { IOSProjectConfig } from '@react-native-community/cli-types';
 import { RnefError } from '@rnef/tools';
 import type { BuildFlags } from '../commands/build/buildOptions.js';
 import { buildProject } from '../commands/build/buildProject.js';
@@ -15,13 +16,15 @@ import { installPodsIfNeeded } from './pods.js';
 export async function buildApp({
   args,
   projectConfig,
+  pluginConfig,
   platformName,
   platformSDK,
   udid,
   projectRoot,
 }: {
   args: RunFlags | BuildFlags;
   projectConfig: ProjectConfig;
+  pluginConfig?: IOSProjectConfig;
   platformName: ApplePlatform;
   platformSDK: PlatformSDK;
   udid?: string;
@@ -51,7 +54,7 @@ export async function buildApp({
     // because running pods install might have generated .xcworkspace project.
     // This should be only case in new project.
     if (xcodeProject.isWorkspace === false) {
-      const newProjectConfig = getValidProjectConfig(platformName, projectRoot);
+      const newProjectConfig = getValidProjectConfig(platformName, projectRoot, pluginConfig);
       xcodeProject = newProjectConfig.xcodeProject;
       sourceDir = newProjectConfig.sourceDir;
     }
diff --git a/packages/platform-ios/package.json b/packages/platform-ios/package.json
@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@react-native-community/cli-config-apple": "^16.0.2",
+    "@react-native-community/cli-types": "^16.0.2",
     "@rnef/platform-apple-helpers": "^0.6.0",
     "@rnef/tools": "^0.6.0",
     "tslib": "^2.3.0"
diff --git a/packages/platform-ios/src/lib/platformIOS.ts b/packages/platform-ios/src/lib/platformIOS.ts
@@ -1,4 +1,6 @@
-import type { PluginApi, PluginOutput } from '@rnef/config';
+import path from 'node:path';
+import type { IOSProjectConfig } from '@react-native-community/cli-types';
+import type { PlatformOutput, PluginApi } from '@rnef/config';
 import type { BuildFlags, RunFlags } from '@rnef/platform-apple-helpers';
 import {
   createBuild,
@@ -14,15 +16,19 @@ const buildOptions = getBuildOptions({ platformName: 'ios' });
 const runOptions = getRunOptions({ platformName: 'ios' });
 
 export const platformIOS =
-  () =>
-  (api: PluginApi): PluginOutput => {
+  (pluginConfig?: IOSProjectConfig) =>
+  (api: PluginApi): PlatformOutput => {
     api.registerCommand({
       name: 'build:ios',
       description: 'Build iOS app.',
       action: async (args) => {
         intro('Building iOS app');
         const projectRoot = api.getProjectRoot();
-        const iosConfig = getValidProjectConfig('ios', projectRoot, {});
+        const iosConfig = getValidProjectConfig(
+          'ios',
+          projectRoot,
+          pluginConfig
+        );
         await createBuild('ios', iosConfig, args as BuildFlags, projectRoot);
         outro('Success 🎉.');
       },
@@ -35,7 +41,11 @@ export const platformIOS =
       action: async (args) => {
         intro('Running iOS app');
         const projectRoot = api.getProjectRoot();
-        const iosConfig = getValidProjectConfig('ios', projectRoot, {});
+        const iosConfig = getValidProjectConfig(
+          'ios',
+          projectRoot,
+          pluginConfig
+        );
         await createRun(
           'ios',
           iosConfig,
@@ -55,6 +65,12 @@ export const platformIOS =
     return {
       name: '@rnef/platform-ios',
       description: 'RNEF plugin for everything iOS.',
+      autolinkingConfig: {
+        ...pluginConfig,
+        sourceDir: pluginConfig?.sourceDir
+          ? path.join(api.getProjectRoot(), pluginConfig.sourceDir)
+          : undefined,
+      },
     };
   };
 
diff --git a/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts b/packages/plugin-brownfield-android/src/lib/pluginBrownfieldAndroid.ts
@@ -13,7 +13,7 @@ import { intro, RnefError } from '@rnef/tools';
 
 const getAarConfig = (
   args: PackageAarFlags | PublishLocalAarFlags,
-  androidConfig: AndroidProjectConfig
+  androidConfig: AndroidProjectConfig,
 ) => {
   const config = {
     sourceDir: androidConfig.sourceDir,
@@ -22,7 +22,7 @@ const getAarConfig = (
   return config;
 };
 export const pluginBrownfieldAndroid =
-  () =>
+  (pluginConfig?: AndroidProjectConfig) =>
   (api: PluginApi): PluginOutput => {
     const projectRoot = api.getProjectRoot();
 
@@ -33,7 +33,7 @@ export const pluginBrownfieldAndroid =
       action: async (args: PackageAarFlags) => {
         intro('Creating an AAR file');
 
-        const androidConfig = projectConfig(projectRoot);
+        const androidConfig = projectConfig(projectRoot, pluginConfig);
 
         if (androidConfig) {
           const config = getAarConfig(args, androidConfig);
@@ -51,7 +51,7 @@ export const pluginBrownfieldAndroid =
       action: async (args: PublishLocalAarFlags) => {
         intro('Publishing AAR');
 
-        const androidConfig = projectConfig(projectRoot);
+        const androidConfig = projectConfig(projectRoot, pluginConfig);
 
         if (androidConfig) {
           const config = getAarConfig(args, androidConfig);
diff --git a/packages/plugin-brownfield-ios/package.json b/packages/plugin-brownfield-ios/package.json
@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "@react-native-community/cli-config-apple": "^16.0.2",
+    "@react-native-community/cli-types": "^16.0.2",
     "@rnef/tools": "^0.6.0",
     "@rnef/platform-apple-helpers": "^0.6.0",
     "tslib": "^2.3.0"
diff --git a/packages/plugin-brownfield-ios/src/lib/pluginBrownfieldIos.ts b/packages/plugin-brownfield-ios/src/lib/pluginBrownfieldIos.ts
@@ -1,3 +1,4 @@
+import type { IOSProjectConfig } from '@react-native-community/cli-types';
 import type { PluginApi, PluginOutput } from '@rnef/config';
 import {
   type BuildFlags,
@@ -8,11 +9,10 @@ import {
 } from '@rnef/platform-apple-helpers';
 import { intro, outro, RnefError } from '@rnef/tools';
 import { mergeFrameworks } from './mergeFrameworks.js';
-
 const buildOptions = getBuildOptions({ platformName: 'ios' });
 
 export const pluginBrownfieldIos =
-  () =>
+  (pluginConfig?: IOSProjectConfig) =>
   (api: PluginApi): PluginOutput => {
     api.registerCommand({
       name: 'package:ios',
@@ -21,7 +21,7 @@ export const pluginBrownfieldIos =
         intro('Packaging iOS project');
 
         const projectRoot = api.getProjectRoot();
-        const iosConfig = getValidProjectConfig('ios', projectRoot, {});
+        const iosConfig = getValidProjectConfig('ios', projectRoot, pluginConfig);
         const { derivedDataDir } = getBuildPaths('ios');
 
         const destinations = args.destinations ?? [
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/website/docs/docs/configuration/index.md b/website/docs/docs/configuration/index.md
diff --git a/website/docs/docs/getting-started/migrating-from-community-cli.mdx b/website/docs/docs/getting-started/migrating-from-community-cli.mdx
