enhance: syntax highlighting for json/yaml (#558)

* enhance: add color options * chore: organize code * fix: import order * chore: go mod tidy * trigger rebuild --------- Co-authored-by: wass3rw3rk <49894298+wass3rw3rk@users.noreply.github.com>
go-vela · Jun 5, 2024 · b2c2c78 · b2c2c78
1 parent 88582e2
commit b2c2c78
Show file tree

Hide file tree

Showing 120 changed files with 484 additions and 112 deletions.
diff --git a/action/build/build.go b/action/build/build.go
@@ -2,6 +2,8 @@
 
 package build
 
+import "github.com/go-vela/cli/internal/output"
+
 // Config represents the configuration necessary
 // to perform build related requests with Vela.
 type Config struct {
@@ -17,4 +19,5 @@ type Config struct {
 	Page    int
 	PerPage int
 	Output  string
+	Color   output.ColorOptions
 }
diff --git a/action/build/cancel.go b/action/build/cancel.go
@@ -35,7 +35,7 @@ func (c *Config) Cancel(client *vela.Client) error {
 		// output the build in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(build)
+		return output.JSON(build, c.Color)
 	case output.DriverSpew:
 		// output the build in spew format
 		//
@@ -45,7 +45,7 @@ func (c *Config) Cancel(client *vela.Client) error {
 		// output the build in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(build)
+		return output.YAML(build, c.Color)
 	default:
 		// output the build in stdout format
 		//

diff --git a/action/build/get.go b/action/build/get.go
@@ -49,7 +49,7 @@ func (c *Config) Get(client *vela.Client) error {
 		// output the builds in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(builds)
+		return output.JSON(builds, c.Color)
 	case output.DriverSpew:
 		// output the builds in spew format
 		//
@@ -62,7 +62,7 @@ func (c *Config) Get(client *vela.Client) error {
 		// output the builds in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(builds)
+		return output.YAML(builds, c.Color)
 	default:
 		// output the builds in table format
 		return table(builds)

diff --git a/action/build/restart.go b/action/build/restart.go
@@ -35,7 +35,7 @@ func (c *Config) Restart(client *vela.Client) error {
 		// output the build in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(build)
+		return output.JSON(build, c.Color)
 	case output.DriverSpew:
 		// output the build in spew format
 		//
@@ -45,7 +45,7 @@ func (c *Config) Restart(client *vela.Client) error {
 		// output the build in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(build)
+		return output.YAML(build, c.Color)
 	default:
 		// output the build in stdout format
 		//

diff --git a/action/build/view.go b/action/build/view.go
@@ -35,7 +35,7 @@ func (c *Config) View(client *vela.Client) error {
 		// output the build in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(build)
+		return output.JSON(build, c.Color)
 	case output.DriverSpew:
 		// output the build in spew format
 		//
@@ -45,7 +45,7 @@ func (c *Config) View(client *vela.Client) error {
 		// output the build in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(build)
+		return output.YAML(build, c.Color)
 	default:
 		// output the build in stdout format
 		//

diff --git a/action/config/config.go b/action/config/config.go
@@ -2,6 +2,8 @@
 
 package config
 
+import "github.com/go-vela/cli/internal/output"
+
 // Config represents the configuration necessary
 // to perform config related quests with Vela.
 type Config struct {
@@ -22,4 +24,5 @@ type Config struct {
 	UpdateFlags  map[string]string
 	RemoveFlags  []string
 	Output       string
+	Color        output.ColorOptions
 }
diff --git a/action/config/empty.go b/action/config/empty.go
@@ -70,6 +70,21 @@ func (c *ConfigFile) Empty() bool {
 		return false
 	}
 
+	// check if the color is set
+	if c.Color != nil {
+		return false
+	}
+
+	// check if the color format is set
+	if len(c.ColorFormat) > 0 {
+		return false
+	}
+
+	// check if the color theme is set
+	if len(c.ColorTheme) > 0 {
+		return false
+	}
+
 	// check if the org is set
 	if len(c.Org) > 0 {
 		return false

diff --git a/action/config/file.go b/action/config/file.go
@@ -7,14 +7,17 @@ package config
 //
 //nolint:revive // ignore studder for package and struct name
 type ConfigFile struct {
-	API      *API      `yaml:"api,omitempty"`
-	Log      *Log      `yaml:"log,omitempty"`
-	NoGit    string    `yaml:"no-git,omitempty"`
-	Secret   *Secret   `yaml:"secret,omitempty"`
-	Compiler *Compiler `yaml:"compiler,omitempty"`
-	Output   string    `yaml:"output,omitempty"`
-	Org      string    `yaml:"org,omitempty"`
-	Repo     string    `yaml:"repo,omitempty"`
+	API         *API      `yaml:"api,omitempty"`
+	Log         *Log      `yaml:"log,omitempty"`
+	NoGit       string    `yaml:"no-git,omitempty"`
+	Secret      *Secret   `yaml:"secret,omitempty"`
+	Compiler    *Compiler `yaml:"compiler,omitempty"`
+	Output      string    `yaml:"output,omitempty"`
+	Color       *bool     `yaml:"color,omitempty"`
+	ColorFormat string    `yaml:"color_format,omitempty"`
+	ColorTheme  string    `yaml:"color_theme,omitempty"`
+	Org         string    `yaml:"org,omitempty"`
+	Repo        string    `yaml:"repo,omitempty"`
 }
 
 // API represents the API related configuration fields

diff --git a/action/config/generate.go b/action/config/generate.go
@@ -43,10 +43,13 @@ func (c *Config) Generate() error {
 				URL:   c.GitHub.URL,
 			},
 		},
-		Org:    c.Org,
-		Repo:   c.Repo,
-		Output: c.Output,
-		NoGit:  c.NoGit,
+		Org:         c.Org,
+		Repo:        c.Repo,
+		Output:      c.Output,
+		Color:       &c.Color.Enabled,
+		ColorFormat: c.Color.Format,
+		ColorTheme:  c.Color.Theme,
+		NoGit:       c.NoGit,
 	}
 
 	logrus.Trace("creating file content for config file")

diff --git a/action/config/load.go b/action/config/load.go
@@ -191,6 +191,51 @@ func (c *Config) Load(ctx *cli.Context) error {
 			continue
 		}
 
+		// check if the color flag is available
+		// and if it is set in the context
+		if strings.Contains(f, internal.FlagColor) &&
+			!ctx.IsSet(internal.FlagColor) {
+			// set the color field to value from config
+			c := "true"
+			if config.Color != nil && !*config.Color {
+				c = "false"
+			}
+			err = ctx.Set(internal.FlagColor, c)
+			if err != nil {
+				return err
+			}
+
+			continue
+		}
+
+		// check if the color format flag is available
+		// and if it is set in the context
+		if strings.Contains(f, internal.FlagColorFormat) &&
+			!ctx.IsSet(internal.FlagColorFormat) &&
+			len(config.ColorFormat) > 0 {
+			// set the color format field to value from config
+			err = ctx.Set(internal.FlagColorFormat, config.ColorFormat)
+			if err != nil {
+				return err
+			}
+
+			continue
+		}
+
+		// check if the color theme flag is available
+		// and if it is set in the context
+		if strings.Contains(f, internal.FlagColorTheme) &&
+			!ctx.IsSet(internal.FlagColorTheme) &&
+			len(config.ColorFormat) > 0 {
+			// set the color theme field to value from config
+			err = ctx.Set(internal.FlagColorTheme, config.ColorTheme)
+			if err != nil {
+				return err
+			}
+
+			continue
+		}
+
 		// check if the org flag is available
 		// and if it is set in the context
 		if strings.Contains(f, internal.FlagOrg) &&

diff --git a/action/config/remove.go b/action/config/remove.go
@@ -143,6 +143,24 @@ func (c *Config) Remove() error {
 			// set the output field to empty in config
 			config.Output = ""
 		}
+
+		// check if color flag should be removed
+		if strings.EqualFold(flag, internal.FlagColor) {
+			// set the color field to empty in config
+			config.Color = nil
+		}
+
+		// check if color format flag should be removed
+		if strings.EqualFold(flag, internal.FlagColorFormat) {
+			// set the color format field to empty in config
+			config.ColorFormat = ""
+		}
+
+		// check if color theme flag should be removed
+		if strings.EqualFold(flag, internal.FlagColorTheme) {
+			// set the color theme to empty in config
+			config.ColorTheme = ""
+		}
 	}
 
 	logrus.Trace("creating file content for config file")

diff --git a/action/config/update.go b/action/config/update.go
@@ -10,6 +10,7 @@ import (
 	yaml "gopkg.in/yaml.v3"
 
 	"github.com/go-vela/cli/internal"
+	"github.com/go-vela/sdk-go/vela"
 )
 
 // Update modifies one or more fields from the config file based off the provided configuration.
@@ -133,6 +134,28 @@ func (c *Config) Update() error {
 			// set the output field to value provided
 			config.Output = value
 		}
+
+		// check if color flag should be modified
+		if strings.EqualFold(key, internal.FlagColor) {
+			// set the color field to value provided
+			if value == "true" {
+				config.Color = vela.Bool(true)
+			} else {
+				config.Color = vela.Bool(false)
+			}
+		}
+
+		// check if color format flag should be modified
+		if strings.EqualFold(key, internal.FlagColorFormat) {
+			// set the color format to value provided
+			config.ColorFormat = value
+		}
+
+		// check if color theme flag should be modified
+		if strings.EqualFold(key, internal.FlagColorTheme) {
+			// set the color theme to value provided
+			config.ColorTheme = value
+		}
 	}
 
 	logrus.Trace("creating file content for config file")

diff --git a/action/dashboard/dashboard.go b/action/dashboard/dashboard.go
@@ -2,6 +2,8 @@
 
 package dashboard
 
+import "github.com/go-vela/cli/internal/output"
+
 // Config represents the configuration necessary
 // to perform dashboard related requests with Vela.
 type Config struct {
@@ -17,4 +19,5 @@ type Config struct {
 	DropAdmins  []string
 	Full        bool
 	Output      string
+	Color       output.ColorOptions
 }
diff --git a/action/dashboard/view.go b/action/dashboard/view.go
@@ -40,7 +40,7 @@ func outputDashboard(dashboard interface{}, c *Config) error {
 		// output the dashboard in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(dashboard)
+		return output.JSON(dashboard, c.Color)
 	case output.DriverSpew:
 		// output the dashboard in spew format
 		//
@@ -50,7 +50,7 @@ func outputDashboard(dashboard interface{}, c *Config) error {
 		// output the dashboard in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(dashboard)
+		return output.YAML(dashboard, c.Color)
 	default:
 		// output the dashboard in stdout format
 		//

diff --git a/action/deployment/add.go b/action/deployment/add.go
@@ -46,7 +46,7 @@ func (c *Config) Add(client *vela.Client) error {
 		// output the deployment in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(deployment)
+		return output.JSON(deployment, c.Color)
 	case output.DriverSpew:
 		// output the deployment in spew format
 		//
@@ -56,7 +56,7 @@ func (c *Config) Add(client *vela.Client) error {
 		// output the deployment in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(deployment)
+		return output.YAML(deployment, c.Color)
 	default:
 		// output the deployment in stdout format
 		//

diff --git a/action/deployment/deployment.go b/action/deployment/deployment.go
@@ -2,7 +2,10 @@
 
 package deployment
 
-import "github.com/go-vela/types/raw"
+import (
+	"github.com/go-vela/cli/internal/output"
+	"github.com/go-vela/types/raw"
+)
 
 // Config represents the configuration necessary
 // to perform deployment related quests with Vela.
@@ -18,5 +21,6 @@ type Config struct {
 	Page        int
 	PerPage     int
 	Output      string
+	Color       output.ColorOptions
 	Parameters  raw.StringSliceMap
 }
diff --git a/action/deployment/get.go b/action/deployment/get.go
@@ -42,7 +42,7 @@ func (c *Config) Get(client *vela.Client) error {
 		// output the deployments in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(deployments)
+		return output.JSON(deployments, c.Color)
 	case output.DriverSpew:
 		// output the deployments in spew format
 		//
@@ -55,7 +55,7 @@ func (c *Config) Get(client *vela.Client) error {
 		// output the deployments in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(deployments)
+		return output.YAML(deployments, c.Color)
 	default:
 		// output the deployments in table format
 		return table(deployments)

diff --git a/action/deployment/view.go b/action/deployment/view.go
@@ -34,7 +34,7 @@ func (c *Config) View(client *vela.Client) error {
 		// output the deployment in JSON format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#JSON
-		return output.JSON(deployment)
+		return output.JSON(deployment, c.Color)
 	case output.DriverSpew:
 		// output the deployment in spew format
 		//
@@ -44,7 +44,7 @@ func (c *Config) View(client *vela.Client) error {
 		// output the deployment in YAML format
 		//
 		// https://pkg.go.dev/github.com/go-vela/cli/internal/output?tab=doc#YAML
-		return output.YAML(deployment)
+		return output.YAML(deployment, c.Color)
 	default:
 		// output the deployment in stdout format
 		//