feat(twilio-run): adds json output to twilio-run list

Author: philnash

packages/twilio-run/src/commands/list.ts

@@ -71,7 +71,7 @@ export async function handler(
   try {
     const client = new TwilioServerlessApiClient(config);
     const result = await client.list({ ...config });
-    printListResult(result, config);
+    printListResult(result, config, config.outputFormat);
   } catch (err) {
     handleError(err);
   }
@@ -89,6 +89,7 @@ export const cliInfo: CliInfo = {
       'properties',
       'extended-output',
       'service-sid',
+      'output-format',
     ]),
     environment: {
       ...ALL_FLAGS['environment'],

packages/twilio-run/src/config/list.ts

@@ -26,6 +26,7 @@ export type ListConfig = ApiListConfig & {
   cwd: string;
   properties?: string[];
   extendedOutput: boolean;
+  outputFormat?: string;
 };
 
 export type ConfigurableListCliFlags = Pick<
@@ -36,6 +37,7 @@ export type ConfigurableListCliFlags = Pick<
   | 'extendedOutput'
   | 'environment'
   | 'serviceSid'
+  | 'outputFormat'
 >;
 export type ListCliFlags = Arguments<
   ConfigurableListCliFlags & {
@@ -91,6 +93,7 @@ export async function getConfigFromFlags(
   const types = flags.types.split(',').map(trim) as ListOptions[];
   const region = flags.region;
   const edge = flags.edge;
+  const outputFormat = flags.outputFormat || externalCliOptions?.outputFormat;
 
   return {
     cwd,
@@ -106,6 +109,7 @@ export async function getConfigFromFlags(
     types,
     region,
     edge,
+    outputFormat,
     userAgentExtensions: getUserAgentExtensions('list', externalCliOptions),
   };
 }

packages/twilio-run/src/flags.ts

@@ -159,7 +159,7 @@ export const ALL_FLAGS = {
     type: 'string',
     alias: 'o',
     default: '',
-    describe: 'Output the log in a different format',
+    describe: 'Output the results in a different format',
     choices: ['', 'json'],
   } as Options,
   'log-cache-size': {
@@ -251,9 +251,9 @@ export const ALL_FLAGS = {
 export type AvailableFlags = typeof ALL_FLAGS;
 export type FlagNames = keyof AvailableFlags;
 
-export function getRelevantFlags(
-  flags: FlagNames[]
-): { [flagName: string]: Options } {
+export function getRelevantFlags(flags: FlagNames[]): {
+  [flagName: string]: Options;
+} {
   return flags.reduce((current: { [flagName: string]: Options }, flagName) => {
     return { ...current, [flagName]: { ...ALL_FLAGS[flagName] } };
   }, {});

packages/twilio-run/src/printers/list.ts

@@ -14,9 +14,10 @@ import { stripIndent } from 'common-tags';
 import startCase from 'lodash.startcase';
 import logSymbols from 'log-symbols';
 import title from 'title';
+import { OutputFormat } from '../commands/shared';
 import { ListConfig } from '../config/list';
 import { logger } from '../utils/logger';
-import { writeOutput } from '../utils/output';
+import { writeJSONOutput, writeOutput } from '../utils/output';
 import { redactPartOfString, shouldPrettyPrint, windowSize } from './utils';
 
 type KeyMaps = {
@@ -292,7 +293,7 @@ function prettyPrintSection<T extends ListOptions>(
 function printListResultTerminal(result: ListResult, config: ListConfig): void {
   const sections = Object.keys(result) as ListOptions[];
   const output = sections
-    .map(section => prettyPrintSection(section, result[section]))
+    .map((section) => prettyPrintSection(section, result[section]))
     .join(`\n\n${chalk.dim(LONG_LINE)}\n\n`);
 
   let metaInfo = stripIndent(chalk`
@@ -301,8 +302,9 @@ function printListResultTerminal(result: ListResult, config: ListConfig): void {
   `);
 
   if (config.serviceSid || config.serviceName) {
-    metaInfo += chalk`\n{cyan.bold Service}      ${config.serviceSid ||
-      config.serviceName}`;
+    metaInfo += chalk`\n{cyan.bold Service}      ${
+      config.serviceSid || config.serviceName
+    }`;
   }
 
   if (config.environment) {
@@ -313,7 +315,15 @@ function printListResultTerminal(result: ListResult, config: ListConfig): void {
   writeOutput(output);
 }
 
-export function printListResult(result: ListResult, config: ListConfig): void {
+export function printListResult(
+  result: ListResult,
+  config: ListConfig,
+  outputFormat: OutputFormat
+): void {
+  if (outputFormat === 'json') {
+    writeJSONOutput(result);
+    return;
+  }
   if (shouldPrettyPrint && !config.properties && !config.extendedOutput) {
     printListResultTerminal(result, config);
   } else {