refactor: extract duplicate outputformat code to a shared package

Author: Callum0x50

pkg/commands/cluster/list.go

@@ -2,7 +2,6 @@ package cluster
 
 import (
 	"encoding/json"
-	"errors"
 	"fmt"
 	"io"
 
@@ -14,12 +13,11 @@ import (
 	"github.com/intility/indev/internal/ux"
 	"github.com/intility/indev/pkg/client"
 	"github.com/intility/indev/pkg/clientset"
+	"github.com/intility/indev/pkg/outputformat"
 )
 
-var errInvalidOutputFormat = errors.New(`must be one of "wide", "json", "yaml"`)
-
 func NewListCommand(set clientset.ClientSet) *cobra.Command {
-	output := outputFormat("")
+	output := outputformat.Format("")
 	// clusterListCmd represents the list command.
 	cmd := &cobra.Command{
 		Use:     "list",
@@ -55,7 +53,7 @@ func NewListCommand(set clientset.ClientSet) *cobra.Command {
 	return cmd
 }
 
-func printClusterList(writer io.Writer, format outputFormat, clusters client.ClusterList) error {
+func printClusterList(writer io.Writer, format outputformat.Format, clusters client.ClusterList) error {
 	var err error
 
 	switch format {
@@ -126,32 +124,6 @@ func statusMessage(cluster client.Cluster) string {
 	return cluster.Status.Ready.Message
 }
 
-type OutputFormat interface {
-	String() string
-	Set(val string) error
-	Type() string
-}
-
-type outputFormat string
-
-func (o *outputFormat) String() string {
-	return string(*o)
-}
-
-func (o *outputFormat) Set(value string) error {
-	switch value {
-	case "wide", "json", "yaml":
-		*o = outputFormat(value)
-		return nil
-	default:
-		return errInvalidOutputFormat
-	}
-}
-
-func (o *outputFormat) Type() string {
-	return "outputFormat"
-}
-
 func nodePoolSummary(cluster client.Cluster) string {
 	if len(cluster.NodePools) == 0 {
 		return "0"

pkg/commands/teams/list.go

@@ -2,7 +2,6 @@ package teams
 
 import (
 	"encoding/json"
-	"errors"
 	"io"
 	"sort"
 	"strings"
@@ -15,12 +14,11 @@ import (
 	"github.com/intility/indev/internal/ux"
 	"github.com/intility/indev/pkg/client"
 	"github.com/intility/indev/pkg/clientset"
+	"github.com/intility/indev/pkg/outputformat"
 )
 
-var errInvalidOutputFormat = errors.New(`must be one of "wide", "json", "yaml"`)
-
 func NewListCommand(set clientset.ClientSet) *cobra.Command {
-	output := outputFormat("")
+	output := outputformat.Format("")
 	cmd := &cobra.Command{
 		Use:     "list",
 		Short:   "List all teams",
@@ -55,7 +53,7 @@ func NewListCommand(set clientset.ClientSet) *cobra.Command {
 	return cmd
 }
 
-func printTeamsList(writer io.Writer, format outputFormat, teams []client.Team) error {
+func printTeamsList(writer io.Writer, format outputformat.Format, teams []client.Team) error {
 	var err error
 
 	sort.Slice(teams, func(i, j int) bool {
@@ -102,29 +100,3 @@ func printTeamsList(writer io.Writer, format outputFormat, teams []client.Team)
 
 	return nil
 }
-
-type OutputFormat interface {
-	String() string
-	Set(val string) error
-	Type() string
-}
-
-type outputFormat string
-
-func (o *outputFormat) String() string {
-	return string(*o)
-}
-
-func (o *outputFormat) Set(value string) error {
-	switch value {
-	case "wide", "json", "yaml":
-		*o = outputFormat(value)
-		return nil
-	default:
-		return errInvalidOutputFormat
-	}
-}
-
-func (o *outputFormat) Type() string {
-	return "outputFormat"
-}

pkg/outputformat/outputformat.go

@@ -0,0 +1,25 @@
+package outputformat
+
+import "errors"
+
+var ErrInvalidOutputFormat = errors.New(`must be one of "wide", "json", "yaml"`)
+
+type Format string
+
+func (o *Format) String() string {
+	return string(*o)
+}
+
+func (o *Format) Set(value string) error {
+	switch value {
+	case "wide", "json", "yaml":
+		*o = Format(value)
+		return nil
+	default:
+		return ErrInvalidOutputFormat
+	}
+}
+
+func (o *Format) Type() string {
+	return "outputFormat"
+}