feat: Support detailed error objects in cli

package.json

@@ -35,6 +35,7 @@
     "columnify": "^1.5.4",
     "fs-extra": "^9.0.1",
     "inquirer": "^7.3.0",
+    "keytar": "^6.0.1",
     "qs": "^6.9.4",
     "semver": "^7.3.2",
     "tsv": "^0.2.0",

src/base-commands/base-command.js

@@ -62,8 +62,12 @@ class BaseCommand extends Command {
 
     if (instanceOf(error, TwilioCliError)) {
       // User/API errors
-      this.logger.error(error.message);
-      this.logger.debug(error.stack);
+      if (this.flags['cli-output-format'] === 'json') {
+        this.output(error);
+      } else {
+        this.logger.error(error.message);
+        this.logger.debug(error.stack);
+      }
       this.exit(error.exitCode || 1);
     } else {
       // System errors

src/services/cli-http-client.js

@@ -93,13 +93,16 @@ class CliRequestClient {
       this.logger.debug(`response.statusCode: ${response.status}`);
       this.logger.debug(`response.headers: ${JSON.stringify(response.headers)}`);
 
+      /* eslint-disable camelcase */
       if (response.status < 200 || response.status >= 400) {
-        const parsed = response.data;
+        const { code, message, more_info, details } = response.data;
         throw new TwilioCliError(
-          `Error code ${parsed.code} from Twilio: ${parsed.message}. See ${parsed.more_info} for more info.`,
-          parsed.code,
+          `Error code ${code} from Twilio: ${message}. See ${more_info} for more info.`,
+          code,
+          details,
         );
       }
+      /* eslint-enable camelcase */
 
       return {
         body: response.data,

src/services/error.js

@@ -1,8 +1,9 @@
 class TwilioCliError extends Error {
-  constructor(message, exitCode) {
+  constructor(message, exitCode, details) {
     super(message);
     this.name = this.constructor.name;
     this.exitCode = exitCode;
+    this.details = details;
   }
 }
 

test/base-commands/base-command.test.js

@@ -59,6 +59,19 @@ describe('base-commands', () => {
         expect(ctx.stderr).to.contain('oy!');
       });
 
+    test
+      .twilioCliEnv()
+      .stdout()
+      .do(async (ctx) => {
+        ctx.testCmd = new BaseCommand(['-o', 'json'], ctx.fakeConfig);
+        await ctx.testCmd.run();
+        await ctx.testCmd.catch(new TwilioCliError('oh no', 1, { errors: [{ message: 'oh no' }] }));
+      })
+      .exit(1)
+      .it('can correctly display error details', (ctx) => {
+        expect(ctx.stdout).to.contain(`"message": "oh no"`);
+      });
+
     test
       .twilioCliEnv()
       .do((ctx) => {