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

Author: philnash

packages/runtime-handler/src/dev-runtime/server.ts

@@ -1,6 +1,6 @@
 import { ServerlessFunctionSignature } from '@twilio-labs/serverless-runtime-types/types';
 import bodyParser from 'body-parser';
-import EventEmitter from 'events';
+import { EventEmitter } from 'events';
 import express, {
   Express,
   NextFunction,

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

@@ -115,7 +115,7 @@ export async function handler(
 
   checkConfigForCredentials(config);
 
-  printConfigInfo(config);
+  printConfigInfo(config, config.outputFormat);
 
   const spinner = getOraSpinner('Deploying Function').start();
   try {
@@ -126,7 +126,7 @@ export async function handler(
     const result = await client.deployLocalProject(config);
     spinner.text = 'Serverless project successfully deployed\n';
     spinner.succeed();
-    printDeployedResources(config, result);
+    printDeployedResources(config, result, config.outputFormat);
     const { serviceSid, buildSid } = result;
     await saveLatestDeploymentData(
       config.cwd,
@@ -156,6 +156,7 @@ export const cliInfo: CliInfo = {
       'assets-folder',
       'functions-folder',
       'runtime',
+      'output-format',
     ]),
     production: {
       ...ALL_FLAGS['production'],

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

@@ -11,3 +11,5 @@ export type ExternalCliOptions = {
     version: string;
   };
 };
+
+export type OutputFormat = string | undefined;

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

@@ -23,6 +23,7 @@ import { getUserAgentExtensions } from './utils/userAgentExtensions';
 export type DeployLocalProjectConfig = ApiDeployLocalProjectConfig & {
   username: string;
   password: string;
+  outputFormat?: string;
 };
 
 export type ConfigurableDeployCliFlags = Pick<
@@ -39,6 +40,7 @@ export type ConfigurableDeployCliFlags = Pick<
   | 'assetsFolder'
   | 'functionsFolder'
   | 'runtime'
+  | 'outputFormat'
 >;
 export type DeployCliFlags = Arguments<
   ConfigurableDeployCliFlags & {
@@ -112,6 +114,7 @@ export async function getConfigFromFlags(
   }
 
   const { region, edge, runtime } = flags;
+  const outputFormat = flags.outputFormat || externalCliOptions?.outputFormat;
 
   return {
     cwd,
@@ -133,5 +136,6 @@ export async function getConfigFromFlags(
     edge,
     runtime,
     userAgentExtensions: getUserAgentExtensions('deploy', externalCliOptions),
+    outputFormat,
   };
 }

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

@@ -8,9 +8,10 @@ import columnify from 'columnify';
 import { stripIndent } from 'common-tags';
 import terminalLink from 'terminal-link';
 import { MergeExclusive } from 'type-fest';
+import { OutputFormat } from '../commands/shared';
 import { DeployLocalProjectConfig } from '../config/deploy';
 import { logger } from '../utils/logger';
-import { writeOutput } from '../utils/output';
+import { writeJSONOutput, writeOutput } from '../utils/output';
 import {
   getTwilioConsoleDeploymentUrl,
   printObjectWithoutHeaders,
@@ -186,7 +187,13 @@ function prettyPrintDeployedResources(
   }
 }
 
-export function printConfigInfo(config: DeployLocalProjectConfig) {
+export function printConfigInfo(
+  config: DeployLocalProjectConfig,
+  outputFormat: OutputFormat
+) {
+  if (outputFormat === 'json') {
+    return;
+  }
   if (shouldPrettyPrint) {
     prettyPrintConfigInfo(config);
   } else {
@@ -196,8 +203,13 @@ export function printConfigInfo(config: DeployLocalProjectConfig) {
 
 export function printDeployedResources(
   config: DeployLocalProjectConfig,
-  result: DeployResult
+  result: DeployResult,
+  outputFormat: OutputFormat
 ) {
+  if (outputFormat === 'json') {
+    writeJSONOutput(result);
+    return;
+  }
   if (shouldPrettyPrint) {
     prettyPrintDeployedResources(config, result);
   } else {

packages/twilio-run/src/utils/output.ts

@@ -1,3 +1,7 @@
 export function writeOutput(...args: any[]) {
   console.log(...args);
 }
+
+export function writeJSONOutput(...args: any[]) {
+  writeOutput(JSON.stringify(args, null, '\t'));
+}