Make structured/json output opt-in instead of opt-out.

ActiveState · Oct 30, 2023 · 6be6751 · 6be6751
1 parent 4dcb93d
commit 6be6751
Show file tree

Hide file tree

Showing 40 changed files with 83 additions and 84 deletions.
diff --git a/cmd/state/internal/cmdtree/activate.go b/cmd/state/internal/cmdtree/activate.go
@@ -87,6 +87,5 @@ func newActivateCommand(prime *primer.Values) *captain.Command {
 		},
 	)
 	cmd.SetGroup(EnvironmentUsageGroup)
-	cmd.SetDoesNotSupportStructuredOutput()
 	return cmd
 }
diff --git a/cmd/state/internal/cmdtree/auth.go b/cmd/state/internal/cmdtree/auth.go
@@ -54,7 +54,7 @@ func newAuthCommand(prime *primer.Values, globals *globalOptions) *captain.Comma
 			params.NonInteractive = globals.NonInteractive
 			return authRunner.Run(&params)
 		},
-	).SetGroup(PlatformGroup)
+	).SetGroup(PlatformGroup).SetSupportsStructuredOutput()
 }
 
 func newSignupCommand(prime *primer.Values) *captain.Command {
@@ -70,7 +70,7 @@ func newSignupCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, args []string) error {
 			return signupRunner.Run(&params)
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
 
 func newLogoutCommand(prime *primer.Values) *captain.Command {
@@ -85,5 +85,5 @@ func newLogoutCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, args []string) error {
 			return logoutRunner.Run()
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
diff --git a/cmd/state/internal/cmdtree/branch.go b/cmd/state/internal/cmdtree/branch.go
@@ -20,7 +20,7 @@ func newBranchCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run()
-		}).SetGroup(PlatformGroup).SetUnstable(true)
+		}).SetGroup(PlatformGroup).SetSupportsStructuredOutput().SetUnstable(true)
 }
 
 func newBranchAddCommand(prime *primer.Values) *captain.Command {
@@ -44,7 +44,7 @@ func newBranchAddCommand(prime *primer.Values) *captain.Command {
 		},
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params)
-		})
+		}).SetSupportsStructuredOutput()
 }
 
 func newBranchSwitchCommand(prime *primer.Values) *captain.Command {
@@ -69,6 +69,7 @@ func newBranchSwitchCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params)
 		})
+	cmd.SetSupportsStructuredOutput()
 	// We set this command to hidden for backwards compatibility as we cannot
 	// alias `state switch` to `state branch switch`
 	cmd.SetHidden(true)

diff --git a/cmd/state/internal/cmdtree/bundles.go b/cmd/state/internal/cmdtree/bundles.go
@@ -39,7 +39,7 @@ func newBundlesCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params, model.NamespaceBundle)
 		},
-	).SetGroup(PackagesGroup).SetUnstable(true)
+	).SetGroup(PackagesGroup).SetSupportsStructuredOutput().SetUnstable(true)
 }
 
 func newBundleInstallCommand(prime *primer.Values) *captain.Command {
@@ -64,7 +64,7 @@ func newBundleInstallCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params, model.NamespaceBundle)
 		},
-	)
+	).SetSupportsStructuredOutput()
 }
 
 func newBundleUninstallCommand(prime *primer.Values) *captain.Command {
@@ -89,7 +89,7 @@ func newBundleUninstallCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params, model.NamespaceBundle)
 		},
-	)
+	).SetSupportsStructuredOutput()
 }
 
 func newBundlesSearchCommand(prime *primer.Values) *captain.Command {
@@ -125,5 +125,5 @@ func newBundlesSearchCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return runner.Run(params, model.NamespaceBundle)
 		},
-	)
+	).SetSupportsStructuredOutput()
 }
diff --git a/cmd/state/internal/cmdtree/checkout.go b/cmd/state/internal/cmdtree/checkout.go
@@ -53,5 +53,6 @@ func newCheckoutCommand(prime *primer.Values) *captain.Command {
 		},
 	)
 	cmd.SetGroup(EnvironmentSetupGroup)
+	cmd.SetSupportsStructuredOutput()
 	return cmd
 }
diff --git a/cmd/state/internal/cmdtree/clean.go b/cmd/state/internal/cmdtree/clean.go
@@ -19,7 +19,7 @@ func newCleanCommand(prime *primer.Values) *captain.Command {
 			prime.Output().Print(ccmd.Help())
 			return nil
 		},
-	).SetGroup(UtilsGroup)
+	).SetGroup(UtilsGroup).SetSupportsStructuredOutput()
 }
 
 func newCleanUninstallCommand(prime *primer.Values, globals *globalOptions) *captain.Command {
@@ -62,7 +62,7 @@ func newCleanUninstallCommand(prime *primer.Values, globals *globalOptions) *cap
 			params.NonInteractive = globals.NonInteractive // distinct from --force
 			return runner.Run(&params)
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
 
 func newCleanCacheCommand(prime *primer.Values, globals *globalOptions) *captain.Command {
@@ -86,7 +86,7 @@ func newCleanCacheCommand(prime *primer.Values, globals *globalOptions) *captain
 			params.Force = globals.NonInteractive
 			return runner.Run(&params)
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
 
 func newCleanConfigCommand(prime *primer.Values) *captain.Command {
@@ -109,5 +109,5 @@ func newCleanConfigCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, _ []string) error {
 			return runner.Run(&params)
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
diff --git a/cmd/state/internal/cmdtree/commit.go b/cmd/state/internal/cmdtree/commit.go
@@ -22,7 +22,9 @@ func newCommitCommand(prime *primer.Values) *captain.Command {
 		},
 	)
 
-	cmd.SetGroup(EnvironmentSetupGroup).SetUnstable(true)
+	cmd.SetGroup(EnvironmentSetupGroup)
+	cmd.SetSupportsStructuredOutput()
+	cmd.SetUnstable(true)
 
 	return cmd
 }
diff --git a/cmd/state/internal/cmdtree/config.go b/cmd/state/internal/cmdtree/config.go
@@ -21,7 +21,7 @@ func newConfigCommand(prime *primer.Values) *captain.Command {
 				return err
 			}
 			return runner.Run(ccmd.Usage)
-		}).SetGroup(UtilsGroup)
+		}).SetGroup(UtilsGroup).SetSupportsStructuredOutput()
 }
 
 func newConfigGetCommand(prime *primer.Values) *captain.Command {
@@ -43,7 +43,7 @@ func newConfigGetCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, args []string) error {
 			runner := config.NewGet(prime)
 			return runner.Run(params)
-		})
+		}).SetSupportsStructuredOutput()
 }
 
 func newConfigSetCommand(prime *primer.Values) *captain.Command {
@@ -71,5 +71,5 @@ func newConfigSetCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, args []string) error {
 			runner := config.NewSet(prime)
 			return runner.Run(params)
-		})
+		}).SetSupportsStructuredOutput()
 }
diff --git a/cmd/state/internal/cmdtree/cve.go b/cmd/state/internal/cmdtree/cve.go
@@ -24,6 +24,7 @@ func newCveCommand(prime *primer.Values) *captain.Command {
 	)
 	cmd.SetGroup(PlatformGroup)
 	cmd.SetAliases("cve")
+	cmd.SetSupportsStructuredOutput()
 	cmd.SetUnstable(true)
 	return cmd
 }
@@ -50,7 +51,7 @@ func newReportCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return report.Run(&params)
 		},
-	)
+	).SetSupportsStructuredOutput()
 }
 
 func newOpenCommand(prime *primer.Values) *captain.Command {
@@ -73,5 +74,5 @@ func newOpenCommand(prime *primer.Values) *captain.Command {
 		func(_ *captain.Command, _ []string) error {
 			return open.Run(params)
 		},
-	).SetDoesNotSupportStructuredOutput()
+	)
 }
diff --git a/cmd/state/internal/cmdtree/deploy.go b/cmd/state/internal/cmdtree/deploy.go
@@ -54,7 +54,6 @@ func newDeployCommand(prime *primer.Values) *captain.Command {
 		})
 	cmd.SetGroup(EnvironmentSetupGroup)
 	cmd.SetHidden(true)
-	cmd.SetDoesNotSupportStructuredOutput()
 	return cmd
 }
 
@@ -85,7 +84,7 @@ func newDeployInstallCommand(prime *primer.Values) *captain.Command {
 		},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
 
 func newDeployConfigureCommand(prime *primer.Values) *captain.Command {
@@ -124,7 +123,7 @@ func newDeployConfigureCommand(prime *primer.Values) *captain.Command {
 		},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
 
 func newDeploySymlinkCommand(prime *primer.Values) *captain.Command {
@@ -159,7 +158,7 @@ func newDeploySymlinkCommand(prime *primer.Values) *captain.Command {
 		},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
 
 func newDeployReportCommand(prime *primer.Values) *captain.Command {
@@ -189,7 +188,7 @@ func newDeployReportCommand(prime *primer.Values) *captain.Command {
 		},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
 
 func newDeployUninstallCommand(prime *primer.Values) *captain.Command {
@@ -221,5 +220,5 @@ func newDeployUninstallCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
diff --git a/cmd/state/internal/cmdtree/events.go b/cmd/state/internal/cmdtree/events.go
@@ -19,7 +19,7 @@ func newEventsCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run()
-		}).SetGroup(AutomationGroup).SetUnstable(true)
+		}).SetGroup(AutomationGroup).SetSupportsStructuredOutput().SetUnstable(true)
 }
 
 func newEventsLogCommand(prime *primer.Values) *captain.Command {
@@ -42,5 +42,5 @@ func newEventsLogCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(&params)
-		}).SetDoesNotSupportStructuredOutput()
+		})
 }
diff --git a/cmd/state/internal/cmdtree/exec.go b/cmd/state/internal/cmdtree/exec.go
@@ -45,7 +45,6 @@ func newExecCommand(prime *primer.Values, args ...string) *captain.Command {
 
 	cmd.SetGroup(EnvironmentUsageGroup)
 	cmd.SetHasVariableArguments()
-	cmd.SetDoesNotSupportStructuredOutput()
 
 	return cmd
 }
diff --git a/cmd/state/internal/cmdtree/export.go b/cmd/state/internal/cmdtree/export.go
@@ -24,7 +24,7 @@ func newExportCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(ccmd *captain.Command, args []string) error {
 			return runner.Run(ccmd)
-		}).SetGroup(UtilsGroup)
+		}).SetGroup(UtilsGroup).SetSupportsStructuredOutput()
 }
 
 func newRecipeCommand(prime *primer.Values) *captain.Command {
@@ -59,7 +59,7 @@ func newRecipeCommand(prime *primer.Values) *captain.Command {
 		},
 		func(_ *captain.Command, _ []string) error {
 			return recipe.Run(&params)
-		}).SetUnstable(true)
+		}).SetSupportsStructuredOutput().SetUnstable(true)
 }
 
 func newJWTCommand(prime *primer.Values) *captain.Command {
@@ -76,7 +76,7 @@ func newJWTCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(ccmd *captain.Command, args []string) error {
 			return jwt.Run(&params)
-		})
+		}).SetSupportsStructuredOutput()
 }
 
 func newPrivateKeyCommand(prime *primer.Values) *captain.Command {
@@ -93,7 +93,7 @@ func newPrivateKeyCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(ccmd *captain.Command, args []string) error {
 			return privateKey.Run(&params)
-		})
+		}).SetSupportsStructuredOutput()
 }
 
 func newAPIKeyCommand(prime *primer.Values) *captain.Command {
@@ -117,7 +117,7 @@ func newAPIKeyCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, args []string) error {
 			params.IsAuthed = prime.Auth().Authenticated
 			return apikey.Run(params)
-		})
+		}).SetSupportsStructuredOutput()
 }
 
 func newExportConfigCommand(prime *primer.Values) *captain.Command {
@@ -142,7 +142,7 @@ func newExportConfigCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(ccmd *captain.Command, _ []string) error {
 			return runner.Run(ccmd, &params)
-		}).SetUnstable(true)
+		}).SetSupportsStructuredOutput().SetUnstable(true)
 }
 
 func newExportGithubActionCommand(prime *primer.Values) *captain.Command {
@@ -158,7 +158,7 @@ func newExportGithubActionCommand(prime *primer.Values) *captain.Command {
 		[]*captain.Argument{},
 		func(ccmd *captain.Command, _ []string) error {
 			return runner.Run(&params)
-		}).SetUnstable(true).SetDoesNotSupportStructuredOutput()
+		}).SetUnstable(true)
 }
 
 func newExportDocsCommand(prime *primer.Values) *captain.Command {
@@ -177,7 +177,6 @@ func newExportDocsCommand(prime *primer.Values) *captain.Command {
 		})
 
 	cmd.SetHidden(true)
-	cmd.SetDoesNotSupportStructuredOutput()
 
 	return cmd
 }
@@ -196,6 +195,7 @@ func newExportEnvCommand(prime *primer.Values) *captain.Command {
 			return runner.Run()
 		})
 
+	cmd.SetSupportsStructuredOutput()
 	cmd.SetUnstable(true)
 
 	return cmd

diff --git a/cmd/state/internal/cmdtree/fork.go b/cmd/state/internal/cmdtree/fork.go
@@ -43,5 +43,5 @@ func newForkCommand(prime *primer.Values) *captain.Command {
 		},
 		func(cmd *captain.Command, args []string) error {
 			return runner.Run(params)
-		}).SetGroup(VCSGroup)
+		}).SetGroup(VCSGroup).SetSupportsStructuredOutput()
 }
diff --git a/cmd/state/internal/cmdtree/hello_example.go b/cmd/state/internal/cmdtree/hello_example.go
@@ -56,6 +56,8 @@ func newHelloCommand(prime *primer.Values) *captain.Command {
 
 	// The group is used to group together commands in the --help output
 	cmd.SetGroup(UtilsGroup)
+	// Commands should support structured (JSON) output whenever possible.
+	cmd.SetSupportsStructuredOutput()
 	// Any new command should be marked unstable for the first release it goes out in.
 	cmd.SetUnstable(true)
 	// Certain commands like `state deploy` are there for backwards compatibility, but we don't want to show them in the --help output as they are not part of the happy path or our long term goals.

diff --git a/cmd/state/internal/cmdtree/history.go b/cmd/state/internal/cmdtree/history.go
@@ -21,5 +21,5 @@ func newHistoryCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, _ []string) error {
 			return initRunner.Run(&params)
 		},
-	).SetGroup(VCSGroup)
+	).SetGroup(VCSGroup).SetSupportsStructuredOutput()
 }
diff --git a/cmd/state/internal/cmdtree/init.go b/cmd/state/internal/cmdtree/init.go
@@ -48,5 +48,5 @@ func newInitCommand(prime *primer.Values) *captain.Command {
 		func(ccmd *captain.Command, _ []string) error {
 			return initRunner.Run(&params)
 		},
-	).SetGroup(EnvironmentSetupGroup)
+	).SetGroup(EnvironmentSetupGroup).SetSupportsStructuredOutput()
 }
diff --git a/cmd/state/internal/cmdtree/invite.go b/cmd/state/internal/cmdtree/invite.go
@@ -44,7 +44,6 @@ func newInviteCommand(prime *primer.Values) *captain.Command {
 	cmd.SetGroup(PlatformGroup)
 	cmd.SetUnstable(true)
 	cmd.SetHasVariableArguments()
-	cmd.SetDoesNotSupportStructuredOutput()
 
 	return cmd
 }