Merge pull request #2559 from alexissellier/list-port-json-output

feat: add a json output for list port command

Author: FabianKramm

cmd/list/ports.go

@@ -2,6 +2,8 @@ package list
 
 import (
 	"context"
+	"encoding/json"
+	"fmt"
 
 	"github.com/loft-sh/devspace/cmd/flags"
 	"github.com/loft-sh/devspace/pkg/util/factory"
@@ -13,6 +15,14 @@ import (
 
 type portsCmd struct {
 	*flags.GlobalFlags
+
+	Output string
+}
+
+type jsonOutput struct {
+	ImageSelector string `json:"imageSelector"`
+	LabelSelector string `json:"labelSelector"`
+	Port          string `json:"port"`
 }
 
 func newPortsCmd(f factory.Factory, globalFlags *flags.GlobalFlags) *cobra.Command {
@@ -33,6 +43,7 @@ Lists the port forwarding configurations
 			return cmd.RunListPort(f, cobraCmd, args)
 		}}
 
+	portsCmd.Flags().StringVarP(&cmd.Output, "output", "o", "", "The output format of the command. Can be either empty or json")
 	return portsCmd
 }
 
@@ -80,11 +91,30 @@ func (cmd *portsCmd) RunListPort(f factory.Factory, cobraCmd *cobra.Command, arg
 		logger.Info("No ports are forwarded.\n")
 		return nil
 	}
-	headerColumnNames := []string{
-		"ImageSelector",
-		"LabelSelector",
-		"Ports (Local:Remote)",
+
+	switch cmd.Output {
+	case "":
+		headerColumnNames := []string{
+			"ImageSelector",
+			"LabelSelector",
+			"Ports (Local:Remote)",
+		}
+		log.PrintTable(logger, headerColumnNames, portForwards)
+	case "json":
+		output := make([]jsonOutput, 0)
+		for _, portFoward := range portForwards {
+			output = append(output, jsonOutput{
+				ImageSelector: portFoward[0],
+				LabelSelector: portFoward[1],
+				Port:          portFoward[2],
+			})
+		}
+
+		out, err := json.MarshalIndent(output, "", "  ")
+		if err != nil {
+			return err
+		}
+		fmt.Print(string(out))
 	}
-	log.PrintTable(logger, headerColumnNames, portForwards)
 	return nil
 }