Merge pull request #2129 from Automattic/update/format-option

fix: make the help text for the `format` option consistent for all commands

src/bin/vip-app.js

@@ -6,7 +6,7 @@ import app from '../lib/api/app';
 import command, { getEnvIdentifier } from '../lib/cli/command';
 import { trackEvent } from '../lib/tracker';
 
-command( { requiredArgs: 1, format: true } )
+command( { requiredArgs: 1 } )
 	.example(
 		'vip app list',
 		'Retrieve a list of applications that can be accessed by the current authenticated VIP-CLI user.'

src/bin/vip-logs.js

@@ -251,8 +251,7 @@ command( {
 	.option( 'follow', 'Output new entries as they are generated.' )
 	.option(
 		'format',
-		'Render output in a particular format. Accepts “csv”, “json”, and “text”.',
-		'table'
+		'Render output in a particular format. Accepts “table“ (default), “csv“, “json“, and “text”.'
 	)
 	.examples( [
 		{

src/bin/vip-slowlogs.ts

@@ -190,7 +190,7 @@ void command( {
 	appContext: true,
 	appQuery,
 	envContext: true,
-	format: false,
+	format: true,
 	module: 'slowlogs',
 	usage: baseUsage,
 } )
@@ -199,7 +199,6 @@ void command( {
 		'Set the maximum number of log entries. Accepts an integer value between 1 and 500.',
 		500
 	)
-	.option( 'format', 'Render output in a particular format. Accepts “csv”, and “json”.', 'table' )
 	.examples( [
 		{
 			description:

src/bin/vip-validate-preflight.js

@@ -560,6 +560,7 @@ function sanitizeArgsForTracking( args ) {
 
 let commandOpts = {
 	module: 'harmonia',
+	format: true,
 };
 
 // The @app.env selector is optional, so we need to check if it was passed
@@ -601,7 +602,6 @@ command( commandOpts )
 		[ 'p', 'port' ],
 		'Configure the port to use for the app (defaults to a random port between 3001 and 3999)'
 	)
-	.option( 'format', 'Output the log lines in CSV or JSON format', 'table' )
 	.option( [ 'P', 'path' ], 'Path to the app to be tested', process.cwd() )
 	.examples( [
 		{

src/lib/cli/command.js

@@ -67,6 +67,10 @@ args.argv = async function ( argv, cb ) {
 		debug: false,
 	} );
 
+	if ( _opts.format && ! options.format ) {
+		options.format = 'table';
+	}
+
 	if ( options.h || options.help ) {
 		this.showHelp();
 	}
@@ -603,8 +607,7 @@ export default function ( opts ) {
 	if ( _opts.format ) {
 		args.option(
 			'format',
-			'Render output in a particular format. Accepts “csv”, and “json”.',
-			'table'
+			'Render output in a particular format. Accepts “table“ (default), “csv“, and “json“.'
 		);
 	}