refactor(cmd): unify CLI output format under --result-format

cmd/build.go

@@ -226,7 +226,11 @@ func (cmd *BuildCmd) build(
 		log.Debugf("done building devcontainer")
 		log.Infof("cleaning up temporary workspace")
 	}()
-	emitJSON := output.ResolveMode(cmd.ResultFormat) == output.ModeJSON
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	emitJSON := mode == output.ModeJSON
 
 	result, err := clientimplementation.BuildAgentClient(
 		ctx,

cmd/context/list.go

@@ -9,15 +9,14 @@ import (
 
 	"github.com/devsy-org/devsy/cmd/flags"
 	"github.com/devsy-org/devsy/pkg/config"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/devsy-org/devsy/pkg/table"
 	"github.com/spf13/cobra"
 )
 
 // ListCmd holds the list cmd flags.
 type ListCmd struct {
 	*flags.GlobalFlags
-
-	Output string
 }
 
 // NewListCmd creates a new command.
@@ -34,8 +33,6 @@ func NewListCmd(flags *flags.GlobalFlags) *cobra.Command {
 		},
 	}
 
-	listCmd.Flags().
-		StringVar(&cmd.Output, "output", "plain", "The output format to use. Can be json or plain")
 	return listCmd
 }
 
@@ -52,8 +49,12 @@ func (cmd *ListCmd) Run(ctx context.Context) error {
 		return err
 	}
 
-	switch cmd.Output {
-	case "plain":
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	switch mode {
+	case output.ModePlain:
 		tableEntries := [][]string{}
 		for contextName := range devsyConfig.Contexts {
 			tableEntries = append(tableEntries, []string{
@@ -69,7 +70,7 @@ func (cmd *ListCmd) Run(ctx context.Context) error {
 			"Name",
 			"Default",
 		}, tableEntries)
-	case "json":
+	case output.ModeJSON:
 		ides := []ContextWithDefault{}
 		for contextName := range devsyConfig.Contexts {
 			ides = append(ides, ContextWithDefault{
@@ -83,11 +84,6 @@ func (cmd *ListCmd) Run(ctx context.Context) error {
 			return err
 		}
 		fmt.Print(string(out))
-	default:
-		return fmt.Errorf(
-			"unexpected output format, choose either json or plain. Got %s",
-			cmd.Output,
-		)
 	}
 
 	return nil

cmd/context/options.go

@@ -8,15 +8,14 @@ import (
 
 	"github.com/devsy-org/devsy/cmd/flags"
 	"github.com/devsy-org/devsy/pkg/config"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/devsy-org/devsy/pkg/table"
 	"github.com/spf13/cobra"
 )
 
 // OptionsCmd holds the options cmd flags.
 type OptionsCmd struct {
 	*flags.GlobalFlags
-
-	Output string
 }
 
 // NewOptionsCmd creates a new command.
@@ -32,8 +31,6 @@ func NewOptionsCmd(flags *flags.GlobalFlags) *cobra.Command {
 		},
 	}
 
-	optionsCmd.Flags().
-		StringVar(&cmd.Output, "output", "plain", "The output format to use. Can be json or plain")
 	return optionsCmd
 }
 
@@ -55,8 +52,12 @@ func (cmd *OptionsCmd) Run(ctx context.Context, args []string) error {
 		entryOptions = map[string]config.OptionValue{}
 	}
 
-	switch cmd.Output {
-	case "plain":
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	switch mode {
+	case output.ModePlain:
 		tableEntries := [][]string{}
 		for _, entry := range config.ContextOptions {
 			value := entryOptions[entry.Name].Value
@@ -78,7 +79,7 @@ func (cmd *OptionsCmd) Run(ctx context.Context, args []string) error {
 			"Default",
 			"Value",
 		}, tableEntries)
-	case "json":
+	case output.ModeJSON:
 		options := map[string]optionWithValue{}
 		for _, entry := range config.ContextOptions {
 			options[entry.Name] = optionWithValue{
@@ -92,11 +93,6 @@ func (cmd *OptionsCmd) Run(ctx context.Context, args []string) error {
 			return err
 		}
 		fmt.Print(string(out))
-	default:
-		return fmt.Errorf(
-			"unexpected output format, choose either json or plain. Got %s",
-			cmd.Output,
-		)
 	}
 
 	return nil

cmd/exec.go

@@ -173,7 +173,11 @@ func (cmd *ExecCmd) Run(ctx context.Context, args []string) error {
 	probedEnv := probeContainerEnv(ctx, target, userEnvProbe)
 	envMap := buildExecEnv(result, cmd.RemoteEnv, probedEnv)
 
-	emitJSON := output.ResolveMode(cmd.ResultFormat) == output.ModeJSON
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	emitJSON := mode == output.ModeJSON
 
 	err = cmd.execInContainer(ctx, execOpts{
 		target:  target,
@@ -228,7 +232,11 @@ func (cmd *ExecCmd) runWithContainerID(ctx context.Context, args []string) error
 
 	workdir := containerDetails.Config.WorkingDir
 
-	emitJSON := output.ResolveMode(cmd.ResultFormat) == output.ModeJSON
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	emitJSON := mode == output.ModeJSON
 
 	err = cmd.execInContainer(ctx, execOpts{
 		target:  target,

cmd/features/generatedocs.go

@@ -9,6 +9,7 @@ import (
 
 	"github.com/devsy-org/devsy/cmd/flags"
 	"github.com/devsy-org/devsy/pkg/devcontainer/config"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/spf13/cobra"
 )
 
@@ -18,7 +19,6 @@ type GenerateDocsCmd struct {
 	ProjectFolder string
 	OutputFolder  string
 	Namespace     string
-	Output        string
 }
 
 func NewGenerateDocsCmd(globalFlags *flags.GlobalFlags) *cobra.Command {
@@ -44,16 +44,14 @@ documentation for each feature based on its devcontainer-feature.json.`,
 	generateDocsCmd.Flags().StringVar(
 		&cmd.Namespace, "namespace", "", "Registry namespace for linking (e.g. ghcr.io/myorg/features)",
 	)
-	generateDocsCmd.Flags().StringVar(
-		&cmd.Output, "output", "text", "Output format (text or json)",
-	)
 	_ = generateDocsCmd.MarkFlagRequired("project-folder")
 
 	return generateDocsCmd
 }
 
 func (cmd *GenerateDocsCmd) Run() error {
-	if err := validateOutputFormat(cmd.Output); err != nil {
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
 		return err
 	}
 
@@ -72,11 +70,13 @@ func (cmd *GenerateDocsCmd) Run() error {
 		return err
 	}
 
-	if cmd.Output == outputJSON {
+	switch mode {
+	case output.ModeJSON:
 		return cmd.writeJSON(features)
+	case output.ModePlain:
+		return cmd.writeDocs(features, outputFolder)
 	}
-
-	return cmd.writeDocs(features, outputFolder)
+	return nil
 }
 
 func (cmd *GenerateDocsCmd) resolveOutputFolder(

cmd/features/generatedocs_test.go

@@ -5,6 +5,8 @@ import (
 	"path/filepath"
 	"testing"
 
+	"github.com/devsy-org/devsy/cmd/flags"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
@@ -40,7 +42,7 @@ func TestGenerateDocsCmd_Run(t *testing.T) {
 		ProjectFolder: projectDir,
 		OutputFolder:  outputDir,
 		Namespace:     "ghcr.io/test/features",
-		Output:        "text",
+		GlobalFlags:   &flags.GlobalFlags{ResultFormat: output.ModePlain},
 	}
 
 	err := cmd.Run()
@@ -78,7 +80,7 @@ func TestGenerateDocsCmd_NoFeatures(t *testing.T) {
 
 	cmd := &GenerateDocsCmd{
 		ProjectFolder: projectDir,
-		Output:        "text",
+		GlobalFlags:   &flags.GlobalFlags{ResultFormat: output.ModePlain},
 	}
 
 	err := cmd.Run()
@@ -110,7 +112,7 @@ func TestGenerateDocsCmd_MultipleFeatures(t *testing.T) {
 	cmd := &GenerateDocsCmd{
 		ProjectFolder: projectDir,
 		OutputFolder:  outputDir,
-		Output:        "text",
+		GlobalFlags:   &flags.GlobalFlags{ResultFormat: output.ModePlain},
 	}
 
 	err := cmd.Run()

cmd/features/info.go

@@ -7,6 +7,7 @@ import (
 	"github.com/devsy-org/devsy/cmd/flags"
 	"github.com/devsy-org/devsy/pkg/devcontainer/config"
 	"github.com/devsy-org/devsy/pkg/devcontainer/feature"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/devsy-org/devsy/pkg/table"
 	"github.com/google/go-containerregistry/pkg/authn"
 	"github.com/google/go-containerregistry/pkg/name"
@@ -17,7 +18,6 @@ import (
 type InfoCmd struct {
 	*flags.GlobalFlags
 
-	Output           string
 	ShowTags         bool
 	ShowDependencies bool
 }
@@ -55,7 +55,6 @@ to display metadata.`,
 		},
 	}
 
-	infoCmd.Flags().StringVar(&cmd.Output, "output", "text", "Output format (text or json)")
 	infoCmd.Flags().BoolVar(
 		&cmd.ShowTags, "show-tags", false, "List available tags from the registry",
 	)
@@ -70,10 +69,6 @@ to display metadata.`,
 }
 
 func (cmd *InfoCmd) Run(featureID string) error {
-	if err := validateOutputFormat(cmd.Output); err != nil {
-		return err
-	}
-
 	ref, err := name.ParseReference(featureID)
 	if err != nil {
 		return fmt.Errorf("invalid feature reference %q: %w", featureID, err)
@@ -92,10 +87,17 @@ func (cmd *InfoCmd) Run(featureID string) error {
 		info.Tags = tags
 	}
 
-	if cmd.Output == outputJSON {
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	switch mode {
+	case output.ModeJSON:
 		return writeJSON(os.Stdout, info)
+	case output.ModePlain:
+		return cmd.printText(info)
 	}
-	return cmd.printText(info)
+	return nil
 }
 
 func (cmd *InfoCmd) fetchInfo(

cmd/features/info_manifest.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/devsy-org/devsy/cmd/flags"
 	"github.com/devsy-org/devsy/pkg/devcontainer/feature"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/devsy-org/devsy/pkg/table"
 	"github.com/google/go-containerregistry/pkg/name"
 	v1 "github.com/google/go-containerregistry/pkg/v1"
@@ -15,8 +16,6 @@ import (
 
 type InfoManifestCmd struct {
 	*flags.GlobalFlags
-
-	Output string
 }
 
 func NewInfoManifestCmd(globalFlags *flags.GlobalFlags) *cobra.Command {
@@ -36,16 +35,10 @@ ghcr.io/devcontainers/features/go:1 and outputs the OCI image manifest.`,
 		},
 	}
 
-	manifestCmd.Flags().StringVar(&cmd.Output, "output", "json", "Output format (text or json)")
-
 	return manifestCmd
 }
 
 func (cmd *InfoManifestCmd) Run(featureID string) error {
-	if err := validateOutputFormat(cmd.Output); err != nil {
-		return err
-	}
-
 	ref, err := name.ParseReference(featureID)
 	if err != nil {
 		return fmt.Errorf("invalid feature reference %q: %w", featureID, err)
@@ -56,10 +49,17 @@ func (cmd *InfoManifestCmd) Run(featureID string) error {
 		return fmt.Errorf("fetch manifest: %w", err)
 	}
 
-	if cmd.Output == outputJSON {
+	mode, err := output.ResolveMode(cmd.ResultFormat)
+	if err != nil {
+		return err
+	}
+	switch mode {
+	case output.ModeJSON:
 		return writeJSON(os.Stdout, manifest)
+	case output.ModePlain:
+		return cmd.printText(manifest)
 	}
-	return cmd.printText(manifest)
+	return nil
 }
 
 func (cmd *InfoManifestCmd) printText(manifest *v1.Manifest) error {

cmd/features/info_manifest_test.go

@@ -3,18 +3,12 @@ package features
 import (
 	"testing"
 
+	"github.com/devsy-org/devsy/cmd/flags"
+	"github.com/devsy-org/devsy/pkg/output"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
-func TestInfoManifestCmd_FlagDefaults(t *testing.T) {
-	cmd := NewInfoManifestCmd(nil)
-
-	outputFlag := cmd.Flags().Lookup("output")
-	require.NotNil(t, outputFlag)
-	assert.Equal(t, "json", outputFlag.DefValue)
-}
-
 func TestInfoManifestCmd_RequiresExactlyOneArg(t *testing.T) {
 	cmd := NewInfoManifestCmd(nil)
 	assert.NotNil(t, cmd.Args)
@@ -40,15 +34,8 @@ func TestInfoManifestCmd_RequiresExactlyOneArg(t *testing.T) {
 	}
 }
 
-func TestInfoManifestCmd_InvalidOutputFormat(t *testing.T) {
-	cmd := &InfoManifestCmd{Output: "xml"}
-	err := cmd.Run("ghcr.io/devcontainers/features/go:1")
-	require.Error(t, err)
-	assert.Contains(t, err.Error(), "invalid output format")
-}
-
 func TestInfoManifestCmd_InvalidFeatureReference(t *testing.T) {
-	cmd := &InfoManifestCmd{Output: outputJSON}
+	cmd := &InfoManifestCmd{GlobalFlags: &flags.GlobalFlags{ResultFormat: output.ModeJSON}}
 	err := cmd.Run("not a valid reference!!!")
 	require.Error(t, err)
 	assert.Contains(t, err.Error(), "invalid feature reference")