chore(run-android): deprecate --deviceId in favour of --device (#2377)

* chore(run-android): deprecate `--deviceId` in favour of `--device`

* fix: option should accept only strings

* Update packages/cli-platform-android/src/commands/runAndroid/index.ts

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

---------

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

Author: szymonrybczak

packages/cli-platform-android/README.md

@@ -36,9 +36,15 @@ Specify an `applicationIdSuffix` to launch after build.
 
 Name of the activity to start.
 
+#### `--device <string>`
+
+Explicitly set the device to use by name. The value is not required if you have a single device connected.
+
 #### `--deviceId <string>`
 
-builds your app and starts it on a specific device/simulator with the given device id (listed by running "adb devices" on the command line).
+> **DEPRECATED** - use `--device <string>` instead
+
+Builds your app and starts it on a specific device with the given device id (listed by running "adb devices" on the command line).
 
 #### `--no-packager`
 

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

@@ -38,6 +38,7 @@ export interface Flags extends BuildFlags {
   port: number;
   terminal?: string;
   packager?: boolean;
+  device?: string;
   deviceId?: string;
   listDevices?: boolean;
   binaryPath?: string;
@@ -122,6 +123,13 @@ async function getAvailableDevicePort(
 
 // Builds the app and runs it on a connected emulator / device.
 async function buildAndRun(args: Flags, androidProject: AndroidProject) {
+  if (args.deviceId) {
+    logger.warn(
+      'The `deviceId` parameter is renamed to `device`. Please use the new `device` argument next time to avoid this warning.',
+    );
+    args.device = args.deviceId;
+  }
+
   process.chdir(androidProject.sourceDir);
   const cmd = process.platform.startsWith('win') ? 'gradlew.bat' : './gradlew';
 
@@ -140,9 +148,11 @@ async function buildAndRun(args: Flags, androidProject: AndroidProject) {
   }
 
   if (args.listDevices || args.interactive) {
-    if (args.deviceId) {
+    if (args.device) {
       logger.warn(
-        'Both "deviceId" and "list-devices" parameters were passed to "run" command. We will list available devices and let you choose from one',
+        `Both ${
+          args.deviceId ? 'deviceId' : 'device'
+        } and "list-devices" parameters were passed to "run" command. We will list available devices and let you choose from one`,
       );
     }
 
@@ -193,7 +203,7 @@ async function buildAndRun(args: Flags, androidProject: AndroidProject) {
     );
   }
 
-  if (args.deviceId) {
+  if (args.device) {
     return runOnSpecificDevice(args, adbPath, androidProject, selectedTask);
   } else {
     return runOnAllDevices(args, cmd, adbPath, androidProject);
@@ -326,10 +336,16 @@ export default {
       name: '--main-activity <string>',
       description: 'Name of the activity to start',
     },
+    {
+      name: '--device <string>',
+      description:
+        'Explicitly set the device to use by name. The value is not required ' +
+        'if you have a single device connected.',
+    },
     {
       name: '--deviceId <string>',
       description:
-        'builds your app and starts it on a specific device/simulator with the ' +
+        '**DEPRECATED** Builds your app and starts it on a specific device/simulator with the ' +
         'given device id (listed by running "adb devices" on the command line).',
     },
     {