feat: improved --json output from devices

[rigor789]

PR Checklist

• The PR title follows our guidelines: https://github.com/NativeScript/NativeScript/blob/master/CONTRIBUTING.md#commit-messages.
• There is an issue for the bug/feature this PR is for. To avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it.
• You have signed the CLA.
• All existing tests are passing: https://github.com/NativeScript/nativescript-cli/blob/master/CONTRIBUTING.md#contribute-to-the-code-base
• Tests for the changes are included.

What is the current behavior?

ns device --json

Connected devices & emulators
Searching for devices...
{"imageIdentifier":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","identifier":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","displayName":"iPhone 12 Pro Max","model":"iPhone 12 Pro Max","version":"15.0","vendor":"Apple","platform":"iOS","status":"Connected","errorHelp":null,"isTablet":false,"type":"Emulator","connectionTypes":[10]}

ns device --available-devices --json

Available emulators
┌───────────────────────────────────────┬──────────┬───────────┬──────────────────────────────────────┬──────────────────────────────────────┬────────────┐
│ Device Name                           │ Platform │ Version   │ Device Identifier                    │ Image Identifier                     │ Error Help │
│ iPhone 5s                             │ iOS      │ 12.4      │ XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX │ XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX │            │
│ Pixel_3_XL_API_31                     │ Android  │           │                                      │ Pixel_3_XL_API_31                    │            │
│ ...                                   │          │           │                                      │                                      │            │
└───────────────────────────────────────┴──────────┴───────────┴──────────────────────────────────────┴──────────────────────────────────────┴────────────┘

Connected devices & emulators
Searching for devices...
{"imageIdentifier":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","identifier":"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","displayName":"iPhone 12 Pro Max","model":"iPhone 12 Pro Max","version":"15.0","vendor":"Apple","platform":"iOS","status":"Connected","errorHelp":null,"isTablet":false,"type":"Emulator","connectionTypes":[10]}

What is the new behavior?

ns device --json
Searching for devices...
{
  "devices": [
    {
      "imageIdentifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "identifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "displayName": "iPhone 12 Pro Max",
      "model": "iPhone 12 Pro Max",
      "version": "15.0",
      "vendor": "Apple",
      "platform": "iOS",
      "status": "Connected",
      "errorHelp": null,
      "isTablet": false,
      "type": "Emulator",
      "connectionTypes": [
        10
      ]
    }
  ]
}

ns device --json --available-devices
Searching for devices...
{
  "devices": [
    {
      "imageIdentifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "identifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "displayName": "iPhone 12 Pro Max",
      "model": "iPhone 12 Pro Max",
      "version": "15.0",
      "vendor": "Apple",
      "platform": "iOS",
      "status": "Connected",
      "errorHelp": null,
      "isTablet": false,
      "type": "Emulator",
      "connectionTypes": [
        10
      ]
    }
  ],
  "available": [
    {
      "imageIdentifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "identifier": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
      "displayName": "iPhone 5s",
      "model": "iPhone 5s",
      "version": "12.4",
      "vendor": "Apple",
      "status": "Not running",
      "errorHelp": null,
      "isTablet": false,
      "type": "Emulator",
      "connectionTypes": [
        10
      ],
      "platform": "iOS"
    },
    {
      "identifier": null,
      "imageIdentifier": "Pixel_3_XL_API_31",
      "displayName": "Pixel_3_XL_API_31",
      "vendor": "Avd",
      "status": "Not running",
      "errorHelp": null,
      "isTablet": false,
      "type": "Emulator",
      "connectionTypes": [
        10
      ],
      "platform": "Android"
    },
    ...
  ]
}

---

BREAKING CHANGES:

ns devices --json now prints a JSON object containing a devices key with an array of all devices.
ns devices --available-devices --json now properly prints available devices as JSON.

Migration steps:
update how parsing of the output is handled to use the new schema

{
  available?: any[];
  devices: any[];
}

[pekevski]

Hi @rigor789, could we also add a --json option for ns device list-applications?

[rigor789]

Hi @rigor789, could we also add a --json option for ns device list-applications?

I've never used that command! Where would you use the output?

What json schema would work best?

Maybe this:

{
  [deviceId: string]: Array<string>
}

example:

{
  "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX": [
    "org.nativescript.myApp",
    "org.nativescript.myOtherApp"
  ]
}

[pekevski]

Not sure but there was another command that took an application ID as input. So using this command would help find the ID I suppose. I guess we could leverage this command in fig so that applications IDs are autocompleted to the user.

I like that json structure!