Compare commits

..

No commits in common. "7cd1c78f6a9f2f92787809edc3573b030a346dd0" and "bbc6aec2302d246cab7aaaf34a5023cccede9aa4" have entirely different histories.

14 changed files with 81 additions and 98 deletions

View File

@ -5,13 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
# [0.12.1] - 2025-06-21
# [0.12.0] - 2025-06-21
### Added
- Various colouring styles, see [Style](https://github.com/onyx-and-iris/gobs-cli/tree/main?tab=readme-ov-file#style)
- colouring is applied to list tables as well as highlighted information in stdout/stderr output.
- table border styling may be optionally disabled with the --no-border flag.
### Changed

View File

@ -608,14 +608,9 @@ gobs-cli screenshot save --width=2560 --height=1440 "Scene" "C:\Users\me\Videos\
## Style
By default styling is disabled but you may enable and configure it in the following ways:
By default styling is disabled but you may enable it with the --style/-s flag.
- --style/-s: Style used in output.
- GOBS_STYLE
- --no-border/-b: Disable table border styling in output.
- GOBS_STYLE_NO_BORDER
Available styles:
Available options are:
- red
- magenta
@ -630,9 +625,7 @@ Available styles:
- navy
- black
```console
gobs-cli --style=cyan --no-border scene list
```
Alternatively you may set the style with an environment variable `GOBS_STYLE`.
[userconfigdir]: https://pkg.go.dev/os#UserConfigDir

View File

@ -11,7 +11,7 @@ func TestFilterList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &FilterListCmd{
SourceName: "Mic/Aux",
@ -30,7 +30,7 @@ func TestFilterListScene(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &FilterListCmd{
SourceName: "gobs-test",
@ -49,7 +49,7 @@ func TestFilterListEmpty(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &FilterListCmd{
SourceName: "NonExistentSource",

View File

@ -11,7 +11,7 @@ func TestGroupList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &GroupListCmd{
SceneName: "Scene",
@ -30,7 +30,7 @@ func TestGroupShow(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &GroupShowCmd{
SceneName: "Scene",
@ -50,7 +50,7 @@ func TestGroupToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &GroupStatusCmd{
SceneName: "Scene",
@ -91,7 +91,7 @@ func TestGroupStatus(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdShow := &GroupShowCmd{
SceneName: "Scene",

View File

@ -11,7 +11,7 @@ func TestInputList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &InputListCmd{}
err := cmd.Run(context)
@ -39,7 +39,7 @@ func TestInputListFilterInput(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &InputListCmd{Input: true}
err := cmd.Run(context)
@ -73,7 +73,7 @@ func TestInputListFilterOutput(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &InputListCmd{Output: true}
err := cmd.Run(context)
@ -107,7 +107,7 @@ func TestInputListFilterColour(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &InputListCmd{Colour: true}
err := cmd.Run(context)

View File

@ -26,8 +26,7 @@ type ObsConfig struct {
// StyleConfig holds the configuration for styling the CLI output.
type StyleConfig struct {
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
NoBorder bool `help:"Disable table border styling in output." flag:"no-border" default:"false" env:"GOBS_STYLE_NO_BORDER" short:"b"`
Style string `help:"Style used in output." flag:"style" default:"" env:"GOBS_STYLE" short:"s" enum:",red,magenta,purple,blue,cyan,green,yellow,orange,white,grey,navy,black"`
}
// CLI is the main command line interface structure.
@ -63,11 +62,11 @@ type context struct {
Style *Style
}
func newContext(client *goobs.Client, out io.Writer, styleCfg StyleConfig) *context {
func newContext(client *goobs.Client, out io.Writer, styleName string) *context {
return &context{
Client: client,
Out: out,
Style: styleFromFlag(styleCfg),
Style: styleFromFlag(styleName),
}
}
@ -89,7 +88,7 @@ func main() {
client, err := connectObs(cli.ObsConfig)
ctx.FatalIfErrorf(err)
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig))
ctx.Bind(newContext(client, os.Stdout, cli.StyleConfig.Style))
ctx.FatalIfErrorf(run(ctx, client))
}

View File

@ -12,7 +12,7 @@ func TestRecordStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)
@ -52,7 +52,7 @@ func TestRecordStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)
@ -92,7 +92,7 @@ func TestRecordToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &RecordStatusCmd{}
err := cmdStatus.Run(context)

View File

@ -11,7 +11,7 @@ func TestReplayBufferStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &ReplayBufferStartCmd{}
err := cmd.Run(context)
@ -28,7 +28,7 @@ func TestReplayBufferStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &ReplayBufferStopCmd{}
err := cmd.Run(context)
@ -45,7 +45,7 @@ func TestReplayBufferToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &ReplayBufferStatusCmd{}
err := cmdStatus.Run(context)

View File

@ -10,7 +10,7 @@ func TestSceneList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &SceneListCmd{}
err := cmd.Run(context)
@ -27,7 +27,7 @@ func TestSceneCurrent(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
// Set the current scene to "gobs-test"
cmdSwitch := &SceneSwitchCmd{

View File

@ -11,7 +11,7 @@ func TestSceneItemList(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &SceneItemListCmd{
SceneName: "gobs-test",

View File

@ -12,7 +12,7 @@ func TestStreamStart(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)
@ -51,7 +51,7 @@ func TestStreamStop(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)
@ -90,7 +90,7 @@ func TestStreamToggle(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdStatus := &StreamStatusCmd{}
err := cmdStatus.Run(context)

View File

@ -10,7 +10,7 @@ func TestStudioModeEnable(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdEnable := &StudioModeEnableCmd{}
err := cmdEnable.Run(context)
@ -38,7 +38,7 @@ func TestStudioModeDisable(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmdDisable := &StudioModeDisableCmd{}
err := cmdDisable.Run(context)

102
style.go
View File

@ -26,88 +26,88 @@ func (s *Style) Error(text string) string {
return lipgloss.NewStyle().Foreground(lipgloss.Color("#FF0000")).Render(text) // Red for errors
}
func newRedStyle() Style {
return Style{
func newRedStyle() *Style {
return &Style{
name: "red",
border: lipgloss.Color("#D32F2F"), // Strong red for border
oddRows: lipgloss.Color("#FFCDD2"), // Very light red for odd rows
evenRows: lipgloss.Color("#EF9A9A"), // Light red for even rows
highlight: lipgloss.Color("#EF9A9A"), // Highlight in light red
highlight: lipgloss.Color("#EF9A9A"),
}
}
func newMagentaStyle() Style {
return Style{
func newMagentaStyle() *Style {
return &Style{
name: "magenta",
border: lipgloss.Color("#C2185B"), // Strong magenta for border
oddRows: lipgloss.Color("#F8BBD0"), // Very light magenta/pink for odd rows
evenRows: lipgloss.Color("#F48FB1"), // Light magenta/pink for even rows
highlight: lipgloss.Color("#F48FB1"), // Highlight in light magenta/pink
highlight: lipgloss.Color("#F48FB1"),
}
}
func newPurpleStyle() Style {
return Style{
func newPurpleStyle() *Style {
return &Style{
name: "purple",
border: lipgloss.Color("#7B1FA2"), // Strong purple for border
oddRows: lipgloss.Color("#E1BEE7"), // Very light purple for odd rows
evenRows: lipgloss.Color("#CE93D8"), // Light purple for even rows
highlight: lipgloss.Color("#CE93D8"), // Highlight in light purple
highlight: lipgloss.Color("#CE93D8"),
}
}
func newBlueStyle() Style {
return Style{
func newBlueStyle() *Style {
return &Style{
name: "blue",
border: lipgloss.Color("#1976D2"), // Medium blue for border
oddRows: lipgloss.Color("#E3F2FD"), // Very light blue for odd rows
evenRows: lipgloss.Color("#BBDEFB"), // Light blue for even rows
highlight: lipgloss.Color("#1976D2"), // Highlight in medium blue
highlight: lipgloss.Color("#1976D2"),
}
}
func newCyanStyle() Style {
return Style{
func newCyanStyle() *Style {
return &Style{
name: "cyan",
border: lipgloss.Color("#00BFCF"), // A strong cyan for border
oddRows: lipgloss.Color("#E0F7FA"), // Very light cyan for odd rows
evenRows: lipgloss.Color("#B2EBF2"), // Slightly darker light cyan for even rows
highlight: lipgloss.Color("#00BFCF"), // Highlight in strong cyan
highlight: lipgloss.Color("#00BFCF"),
}
}
func newGreenStyle() Style {
return Style{
func newGreenStyle() *Style {
return &Style{
name: "green",
border: lipgloss.Color("#43A047"), // Medium green for border
oddRows: lipgloss.Color("#E8F5E9"), // Very light green for odd rows
evenRows: lipgloss.Color("#C8E6C9"), // Light green for even rows
highlight: lipgloss.Color("#43A047"), // Highlight in medium green
highlight: lipgloss.Color("#43A047"),
}
}
func newYellowStyle() Style {
return Style{
func newYellowStyle() *Style {
return &Style{
name: "yellow",
border: lipgloss.Color("#FBC02D"), // Strong yellow for border
oddRows: lipgloss.Color("#FFF9C4"), // Very light yellow for odd rows
evenRows: lipgloss.Color("#FFF59D"), // Light yellow for even rows
highlight: lipgloss.Color("#FBC02D"), // Highlight in strong yellow
highlight: lipgloss.Color("#FBC02D"),
}
}
func newOrangeStyle() Style {
return Style{
func newOrangeStyle() *Style {
return &Style{
name: "orange",
border: lipgloss.Color("#F57C00"), // Strong orange for border
oddRows: lipgloss.Color("#FFF3E0"), // Very light orange for odd rows
evenRows: lipgloss.Color("#FFE0B2"), // Light orange for even rows
highlight: lipgloss.Color("#F57C00"), // Highlight in strong orange
highlight: lipgloss.Color("#F57C00"),
}
}
func newWhiteStyle() Style {
return Style{
func newWhiteStyle() *Style {
return &Style{
name: "white",
border: lipgloss.Color("#FFFFFF"), // White for border
oddRows: lipgloss.Color("#F0F0F0"), // Very light grey for odd rows
@ -116,8 +116,8 @@ func newWhiteStyle() Style {
}
}
func newGreyStyle() Style {
return Style{
func newGreyStyle() *Style {
return &Style{
name: "grey",
border: lipgloss.Color("#9E9E9E"), // Medium grey for border
oddRows: lipgloss.Color("#F5F5F5"), // Very light grey for odd rows
@ -126,8 +126,8 @@ func newGreyStyle() Style {
}
}
func newNavyBlueStyle() Style {
return Style{
func newNavyBlueStyle() *Style {
return &Style{
name: "navy",
border: lipgloss.Color("#001F3F"), // Navy blue for border
oddRows: lipgloss.Color("#CFE2F3"), // Very light blue for odd rows
@ -136,8 +136,8 @@ func newNavyBlueStyle() Style {
}
}
func newBlackStyle() Style {
return Style{
func newBlackStyle() *Style {
return &Style{
name: "black",
border: lipgloss.Color("#000000"), // Black for border
oddRows: lipgloss.Color("#333333"), // Dark grey for odd rows
@ -146,34 +146,32 @@ func newBlackStyle() Style {
}
}
func styleFromFlag(cfg StyleConfig) *Style {
var style Style
switch cfg.Style {
func styleFromFlag(colour string) *Style {
switch colour {
case "red":
style = newRedStyle()
return newRedStyle()
case "magenta":
style = newMagentaStyle()
return newMagentaStyle()
case "purple":
style = newPurpleStyle()
return newPurpleStyle()
case "blue":
style = newBlueStyle()
return newBlueStyle()
case "cyan":
style = newCyanStyle()
return newCyanStyle()
case "green":
style = newGreenStyle()
return newGreenStyle()
case "yellow":
style = newYellowStyle()
return newYellowStyle()
case "orange":
style = newOrangeStyle()
return newOrangeStyle()
case "white":
style = newWhiteStyle()
return newWhiteStyle()
case "grey":
style = newGreyStyle()
return newGreyStyle()
case "navy":
style = newNavyBlueStyle()
return newNavyBlueStyle()
case "black":
style = newBlackStyle()
return newBlackStyle()
default:
err := os.Setenv("NO_COLOR", "1") // nolint: misspell
if err != nil {
@ -181,12 +179,6 @@ func styleFromFlag(cfg StyleConfig) *Style {
// This is a fallback to ensure that the application can still run
fmt.Fprintf(os.Stderr, "Error setting NO_COLOR: %v\n", err)
}
return &Style{}
}
// If noBorder is true, we disable the border styling
if cfg.NoBorder {
style.border = ""
}
return &style
}

View File

@ -11,7 +11,7 @@ func TestVersion(t *testing.T) {
defer disconnect()
var out bytes.Buffer
context := newContext(client, &out, StyleConfig{})
context := newContext(client, &out, "")
cmd := &ObsVersionCmd{}
err := cmd.Run(context)