fix: use variant arg in build-android command (#1798)

* fix: use variant arg in build-android command

* chore: extract toPascalCase

* chore: extract getTaskNames

Co-authored-by: Michał Pierzchała <[email protected]>

Author: adamTrz

docs/commands.md

@@ -323,6 +323,8 @@ Override the root directory for the Android build (which contains the android di
 
 #### `--variant <string>`
 
+> **DEPRECATED** – use "mode" instead
+
 > default: 'debug'
 
 Specify your app's build variant.

packages/cli-platform-android/src/commands/buildAndroid/index.ts

@@ -7,16 +7,16 @@ import {
 import {Config} from '@react-native-community/cli-types';
 import execa from 'execa';
 import {getAndroidProject} from '../../config/getAndroidProject';
-import {getTaskNames, toPascalCase} from '../runAndroid/runOnAllDevices';
 import adb from '../runAndroid/adb';
 import getAdbPath from '../runAndroid/getAdbPath';
 import {startServerInNewWindow} from './startServerInNewWindow';
+import {getTaskNames} from '../runAndroid/getTaskNames';
 
 export interface BuildFlags {
-  mode: string;
-  variant: string;
+  mode?: string;
+  variant?: string;
   activeArchOnly?: boolean;
-  packager: boolean;
+  packager?: boolean;
   port: number;
   terminal: string;
   tasks?: Array<string>;
@@ -58,17 +58,18 @@ async function buildAndroid(
     );
   }
 
-  const mode = args.variant || args.mode;
-
   if (args.tasks && args.mode) {
     logger.warn(
       'Both "tasks" and "mode" parameters were passed to "build" command. Using "tasks" for building the app.',
     );
   }
 
-  const tasks = args.tasks || ['assemble' + toPascalCase(mode)];
-
-  let gradleArgs = getTaskNames(androidProject.appName, tasks);
+  let gradleArgs = getTaskNames(
+    androidProject.appName,
+    args.mode || args.variant,
+    args.tasks,
+    'assemble',
+  );
 
   if (args.extraParams) {
     gradleArgs = [...gradleArgs, ...args.extraParams];
@@ -117,7 +118,6 @@ export const options = [
   {
     name: '--mode <string>',
     description: "Specify your app's build variant",
-    default: 'debug',
   },
   {
     name: '--variant <string>',

packages/cli-platform-android/src/commands/runAndroid/getTaskNames.ts

@@ -0,0 +1,15 @@
+import {toPascalCase} from './toPascalCase';
+import type {BuildFlags} from '../buildAndroid';
+
+export function getTaskNames(
+  appName: string,
+  mode: BuildFlags['mode'] = 'debug',
+  tasks: BuildFlags['tasks'],
+  taskPrefix: 'assemble' | 'install',
+): Array<string> {
+  const appTasks = tasks || [taskPrefix + toPascalCase(mode)];
+
+  return appName
+    ? appTasks.map((command) => `${appName}:${command}`)
+    : appTasks;
+}

packages/cli-platform-android/src/commands/runAndroid/listAndroidDevices.ts

@@ -2,6 +2,7 @@ import {execSync} from 'child_process';
 import adb from './adb';
 import getAdbPath from './getAdbPath';
 import {getEmulators} from './tryLaunchEmulator';
+import {toPascalCase} from './toPascalCase';
 import os from 'os';
 import prompts from 'prompts';
 import chalk from 'chalk';
@@ -14,10 +15,6 @@ type DeviceData = {
   type: 'emulator' | 'phone';
 };
 
-function toPascalCase(value: string) {
-  return value !== '' ? value[0].toUpperCase() + value.slice(1) : value;
-}
-
 /**
  *
  * @param deviceId string

packages/cli-platform-android/src/commands/runAndroid/runOnAllDevices.ts

@@ -15,20 +15,8 @@ import tryRunAdbReverse from './tryRunAdbReverse';
 import tryLaunchAppOnDevice from './tryLaunchAppOnDevice';
 import tryLaunchEmulator from './tryLaunchEmulator';
 import tryInstallAppOnDevice from './tryInstallAppOnDevice';
-import {Flags} from '.';
-
-export function getTaskNames(
-  appName: string,
-  commands: Array<string>,
-): Array<string> {
-  return appName
-    ? commands.map((command) => `${appName}:${command}`)
-    : commands;
-}
-
-export function toPascalCase(value: string) {
-  return value !== '' ? value[0].toUpperCase() + value.slice(1) : value;
-}
+import {getTaskNames} from './getTaskNames';
+import type {Flags} from '.';
 
 type AndroidProject = NonNullable<Config['project']['android']>;
 
@@ -54,13 +42,20 @@ async function runOnAllDevices(
       );
     }
   }
+  if (args.variant) {
+    logger.warn(
+      '"variant" flag is deprecated and will be removed in future release. Please switch to "mode" flag.',
+    );
+  }
 
   try {
     if (!args.binaryPath) {
-      const tasks = args.tasks || [
-        'install' + toPascalCase(args.mode ?? 'debug'),
-      ];
-      let gradleArgs = getTaskNames(androidProject.appName, tasks);
+      let gradleArgs = getTaskNames(
+        androidProject.appName,
+        args.mode || args.variant,
+        args.tasks,
+        'install',
+      );
 
       if (args.extraParams) {
         gradleArgs = [...gradleArgs, ...args.extraParams];

packages/cli-platform-android/src/commands/runAndroid/toPascalCase.ts

@@ -0,0 +1,3 @@
+export function toPascalCase(value: string) {
+  return value !== '' ? value[0].toUpperCase() + value.slice(1) : value;
+}