feat: enable table output format by default (#393)

Author: reubeno

internal/app/azldev/app.go

@@ -91,8 +91,8 @@ func getDisplayVersion() string {
 // Constructs a new CLI application instance.
 func NewApp(fsFactory opctx.FileSystemFactory, osEnvFactory opctx.OSEnvFactory) *App {
 	app := &App{
-		colorMode:    ColorModeAuto,    // Default to auto-colorization.
-		reportFormat: ReportFormatJSON, // Default to JSON format for reports.
+		colorMode:    ColorModeAuto,     // Default to auto-colorization.
+		reportFormat: ReportFormatTable, // Default to table format for reports.
 		fsFactory:    fsFactory,
 		osEnvFactory: osEnvFactory,
 	}

internal/app/azldev/command.go

@@ -170,12 +170,12 @@ func reportResults(env *Env, results interface{}) error {
 		return reportResultsViaReflectable(env, results, reflectable.FormatMarkdown)
 	case ReportFormatCSV:
 		return reportResultsViaReflectable(env, results, reflectable.FormatCSV)
-	case ReportFormatTable:
-		return reportResultsViaReflectable(env, results, reflectable.FormatTable)
 	case ReportFormatJSON:
+		return reportResultsAsJSON(env, results)
+	case ReportFormatTable:
 		fallthrough
 	default:
-		return reportResultsAsJSON(env, results)
+		return reportResultsViaReflectable(env, results, reflectable.FormatTable)
 	}
 }
 

internal/app/azldev/env.go

@@ -123,7 +123,7 @@ func NewEnv(ctx context.Context, options EnvOptions) *Env {
 		osEnvFactory:  options.Interfaces.OSEnvFactory,
 
 		// Tool behavior/preferences
-		defaultReportFormat: ReportFormatJSON,
+		defaultReportFormat: ReportFormatTable,
 		colorMode:           ColorModeAuto,
 		reportFile:          os.Stdout,
 		verbose:             false,

internal/app/azldev/env_test.go

@@ -47,10 +47,9 @@ func TestNewEnv(t *testing.T) {
 	env := azldev.NewEnv(ctx, options)
 
 	// Pin defaults.
-	// NOTE: When table reporting is available, that will become the new default.
 	assert.False(t, env.AllPromptsAccepted())
 	assert.False(t, env.PromptsAllowed())
-	assert.Equal(t, azldev.ReportFormatJSON, env.DefaultReportFormat())
+	assert.Equal(t, azldev.ReportFormatTable, env.DefaultReportFormat())
 	assert.False(t, env.DryRun())
 	assert.Equal(t, env.ReportFile(), os.Stdout)
 	assert.False(t, env.Quiet())

scenario/__snapshots__/TestAzlDevConfigDump_stdout_1.snap

@@ -9,4 +9,3 @@ output-dir = '/workdir/out'
 specs = ['/workdir/**/*.spec']
 excluded-paths = ['/workdir/build/**', '/workdir/out/**']
 
-""

scenario/__snapshots__/TestSnapshotsContainer_--bogus-flag_stderr_1.snap

@@ -20,7 +20,7 @@ Flags:
   -n, --dry-run             dry run only (do not take action)
   -h, --help                help for azldev
       --no-default-config   disable default configuration
-  -O, --output-format fmt   output format {csv, json, markdown, table} (default json)
+  -O, --output-format fmt   output format {csv, json, markdown, table} (default table)
   -C, --project string      path to Azure Linux project
   -q, --quiet               only enable minimal output
   -v, --verbose             enable verbose output

scenario/__snapshots__/TestSnapshotsContainer_--help_stdout_1.snap

@@ -21,7 +21,7 @@ Flags:
   -n, --dry-run             dry run only (do not take action)
   -h, --help                help for azldev
       --no-default-config   disable default configuration
-  -O, --output-format fmt   output format {csv, json, markdown, table} (default json)
+  -O, --output-format fmt   output format {csv, json, markdown, table} (default table)
   -C, --project string      path to Azure Linux project
   -q, --quiet               only enable minimal output
   -v, --verbose             enable verbose output

scenario/__snapshots__/TestSnapshotsContainer_help_stdout_1.snap

@@ -21,7 +21,7 @@ Flags:
   -n, --dry-run             dry run only (do not take action)
   -h, --help                help for azldev
       --no-default-config   disable default configuration
-  -O, --output-format fmt   output format {csv, json, markdown, table} (default json)
+  -O, --output-format fmt   output format {csv, json, markdown, table} (default table)
   -C, --project string      path to Azure Linux project
   -q, --quiet               only enable minimal output
   -v, --verbose             enable verbose output

scenario/__snapshots__/TestSnapshots_--bogus-flag_stderr_1.snap

@@ -20,7 +20,7 @@ Flags:
   -n, --dry-run             dry run only (do not take action)
   -h, --help                help for azldev
       --no-default-config   disable default configuration
-  -O, --output-format fmt   output format {csv, json, markdown, table} (default json)
+  -O, --output-format fmt   output format {csv, json, markdown, table} (default table)
   -C, --project string      path to Azure Linux project
   -q, --quiet               only enable minimal output
   -v, --verbose             enable verbose output

scenario/__snapshots__/TestSnapshots_--help_stdout_1.snap

@@ -21,7 +21,7 @@ Flags:
   -n, --dry-run             dry run only (do not take action)
   -h, --help                help for azldev
       --no-default-config   disable default configuration
-  -O, --output-format fmt   output format {csv, json, markdown, table} (default json)
+  -O, --output-format fmt   output format {csv, json, markdown, table} (default table)
   -C, --project string      path to Azure Linux project
   -q, --quiet               only enable minimal output
   -v, --verbose             enable verbose output