Add custom color theme support (#57)

* Add custom color theme support

* fix hex regex casing

* update README

Author: tjblackheart

README.md

@@ -51,6 +51,10 @@ By default andcli will choose the first system clipboard tool found. For Linux,
 
 The configuration will get persisted in the default user home config directory. For Linux, this is `$HOME/.config/andcli`. For MacOS, it's `$HOME/Library/Application Support/andcli` and for Windows it should be in `C:\Users\$USER\AppData\Roaming\andcli`.
 
+## Theming
+
+It's possible to adapt the application colors to your preferred color scheme. To do that, update the values in the config file found under `theme`. Each color has to be a valid hexadecimal string (i.e. `#cc0000`). If there are errors parsing your custom colors on application startup, default values will be used instead.
+
 ## Options
 
 ```text

internal/config/config.go

@@ -19,6 +19,7 @@ type (
 		Type         vaults.Type `yaml:"type"`
 		ClipboardCmd string      `yaml:"clipboard_cmd"`
 		Options      *Opts       `yaml:"options"`
+		Theme        *Theme      `yaml:"theme"`
 		//
 		path              string
 		passwordFromStdin bool
@@ -53,6 +54,7 @@ func create(dir string) (*Config, error) {
 			ShowUsernames: true,
 			ShowTokens:    false,
 		},
+		Theme: &DefaultTheme,
 	}
 
 	if err := cfg.mergeExisting(); err != nil {
@@ -110,6 +112,11 @@ func (cfg *Config) mergeExisting() error {
 		cfg.Options = existing.Options
 	}
 
+	if existing.Theme != nil {
+		cfg.Theme = existing.Theme
+		cfg.Theme.validate()
+	}
+
 	return nil
 }
 

internal/config/config_test.go

@@ -218,7 +218,8 @@ func Test_create(t *testing.T) {
 			ShowUsernames: true,
 			ShowTokens:    false,
 		},
-		path: filepath.Join(cfgDir, buildinfo.AppName, "config.yaml"),
+		Theme: &DefaultTheme,
+		path:  filepath.Join(cfgDir, buildinfo.AppName, "config.yaml"),
 	}
 
 	if !reflect.DeepEqual(cfg, want) {

internal/config/theme.go

@@ -0,0 +1,73 @@
+package config
+
+import (
+	"log"
+	"regexp"
+	"strings"
+)
+
+type Theme struct {
+	Base   string `yaml:"base"`
+	Green  string `yaml:"green"`
+	Yellow string `yaml:"yellow"`
+	Red    string `yaml:"red"`
+	Grey   string `yaml:"grey"`
+	Black  string `yaml:"black"`
+	White  string `yaml:"white"`
+}
+
+var DefaultTheme = Theme{
+	Base:   "#39A02E",
+	Green:  "#39A02E",
+	Yellow: "#DB9F1F",
+	Red:    "#f10000",
+	Grey:   "#424242",
+	Black:  "#000000",
+	White:  "#FFFFFF",
+}
+
+var hexRx = regexp.MustCompile(`^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$`)
+
+func (t *Theme) validate() {
+	invalid := []string{}
+
+	if !hexRx.MatchString(t.Base) {
+		t.Base = DefaultTheme.Base
+		invalid = append(invalid, "base")
+	}
+
+	if !hexRx.MatchString(t.Green) {
+		t.Green = DefaultTheme.Green
+		invalid = append(invalid, "green")
+	}
+
+	if !hexRx.MatchString(t.Yellow) {
+		t.Yellow = DefaultTheme.Yellow
+		invalid = append(invalid, "yellow")
+	}
+
+	if !hexRx.MatchString(t.Red) {
+		t.Red = DefaultTheme.Red
+		invalid = append(invalid, "red")
+	}
+
+	if !hexRx.MatchString(t.Grey) {
+		t.Grey = DefaultTheme.Grey
+		invalid = append(invalid, "grey")
+	}
+
+	if !hexRx.MatchString(t.Black) {
+		t.Black = DefaultTheme.Black
+		invalid = append(invalid, "black")
+	}
+
+	if !hexRx.MatchString(t.White) {
+		t.White = DefaultTheme.White
+		invalid = append(invalid, "white")
+	}
+
+	if len(invalid) > 0 {
+		msg := "Theme errors where found and substituted by fallbacks"
+		log.Printf("andcli: config: %s. Invalid fields: %s\n", msg, strings.Join(invalid, ", "))
+	}
+}

internal/config/theme_test.go

@@ -0,0 +1,51 @@
+package config
+
+import (
+	"bytes"
+	"log"
+	"strings"
+	"testing"
+)
+
+func TestTheme_validate(t *testing.T) {
+	tests := []struct {
+		name         string
+		theme        *Theme
+		expectedLogs string
+		fails        bool
+	}{
+		{
+			"valid theme",
+			&DefaultTheme,
+			"",
+			false,
+		},
+		{
+			"invalid theme",
+			&Theme{
+				Base:   "xxx",
+				Green:  "yyy",
+				Yellow: "",
+				Red:    "#ff0000",
+				White:  "#fff",
+				Grey:   "§$%a",
+				Black:  "000",
+			},
+			"Invalid fields: base, green, yellow, grey",
+			true,
+		},
+	}
+
+	buf := new(bytes.Buffer)
+	log.SetOutput(buf)
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tt.theme.validate()
+			if tt.fails && !strings.Contains(buf.String(), tt.expectedLogs) {
+				t.Errorf("theme.validate(): want %q, got %q", tt.expectedLogs, buf.String())
+			}
+		})
+		buf.Reset()
+	}
+}

internal/model/delegate.go

@@ -10,14 +10,13 @@ import (
 	"github.com/tjblackheart/andcli/v2/internal/vaults"
 )
 
-type itemDelegate struct{ style *defaultStyle }
+type itemDelegate struct{ style *appStyle }
 
 func (d itemDelegate) Height() int                         { return 1 }
 func (d itemDelegate) Spacing() int                        { return 0 }
 func (d itemDelegate) Update(tea.Msg, *list.Model) tea.Cmd { return nil }
 
 func (d itemDelegate) Render(w io.Writer, m list.Model, idx int, li list.Item) {
-
 	entry, _ := li.(vaults.Entry)
 	text := d.style.listItem.Render(entry.Title())
 

internal/model/model.go

@@ -17,7 +17,6 @@ import (
 )
 
 type (
-	// tea.Model implementation
 	Model struct {
 		list  list.Model
 		style lipgloss.Style
@@ -33,14 +32,16 @@ type (
 )
 
 var (
-	style   = newDefaultStyle()
+	style   = new(appStyle)
 	state   = new(appState)
 	cb      = new(clipboard.Clipboard)
-	copyOK  = ns().Foreground(green).Render(`✓`)
-	copyErr = ns().Foreground(red).Render(`✕`)
+	copyOK  = lipgloss.NewStyle().Foreground(green).Render(`✓`)
+	copyErr = lipgloss.NewStyle().Foreground(red).Render(`✕`)
 )
 
 func New(entries []vaults.Entry, cfg *config.Config) Model {
+	style = newThemedStyle(cfg.Theme)
+
 	state.showToken = cfg.Options.ShowTokens
 	state.showUsernames = cfg.Options.ShowUsernames
 

internal/model/style.go

@@ -1,40 +1,52 @@
 package model
 
-import "github.com/charmbracelet/lipgloss"
-
-// TODO: configurable colors via config file
-var (
-	base   = lipgloss.Color("#39A02E")
-	green  = lipgloss.Color("#39A02E")
-	yellow = lipgloss.Color("#DB9F1F")
-	red    = lipgloss.Color("#f10000")
-	grey   = lipgloss.Color("#424242")
-	black  = lipgloss.Color("#000000")
-	white  = lipgloss.Color("#ffffff")
+import (
+	"github.com/charmbracelet/lipgloss"
+	"github.com/tjblackheart/andcli/v2/internal/config"
 )
 
-type defaultStyle struct {
+type appStyle struct {
 	title, listItem, activeItem lipgloss.Style
 	username, filterCursor      lipgloss.Style
 	filterPrompt, token, until  lipgloss.Style
 }
 
-var ns = lipgloss.NewStyle
+var (
+	base   = lipgloss.Color(config.DefaultTheme.Base)
+	green  = lipgloss.Color(config.DefaultTheme.Green)
+	yellow = lipgloss.Color(config.DefaultTheme.Yellow)
+	red    = lipgloss.Color(config.DefaultTheme.Red)
+	grey   = lipgloss.Color(config.DefaultTheme.Grey)
+	black  = lipgloss.Color(config.DefaultTheme.Black)
+	white  = lipgloss.Color(config.DefaultTheme.White)
+)
 
-func newDefaultStyle() *defaultStyle {
-	return &defaultStyle{
-		title:        ns().Background(base).Padding(0, 1),
-		listItem:     ns().PaddingLeft(2).Faint(true),
-		username:     ns().Background(grey),
-		filterPrompt: ns().Foreground(base),
-		filterCursor: ns().Background(base),
-		token:        ns().Bold(true).Padding(0, 1, 0, 1),
-		until:        ns().Bold(true),
-		activeItem: ns().
+func newStyle() *appStyle {
+	return &appStyle{
+		title:        lipgloss.NewStyle().Background(base).Padding(0, 1),
+		listItem:     lipgloss.NewStyle().PaddingLeft(2).Faint(true),
+		username:     lipgloss.NewStyle().Background(grey),
+		filterPrompt: lipgloss.NewStyle().Foreground(base),
+		filterCursor: lipgloss.NewStyle().Background(base),
+		token:        lipgloss.NewStyle().Bold(true).Padding(0, 1, 0, 1),
+		until:        lipgloss.NewStyle().Bold(true),
+		activeItem: lipgloss.NewStyle().
 			Padding(0, 1).
 			Bold(true).
 			Background(grey).
 			Border(lipgloss.ThickBorder(), false, false, false, true).
 			Faint(false),
 	}
 }
+
+func newThemedStyle(theme *config.Theme) *appStyle {
+	base = lipgloss.Color(theme.Base)
+	green = lipgloss.Color(theme.Green)
+	yellow = lipgloss.Color(theme.Yellow)
+	red = lipgloss.Color(theme.Red)
+	grey = lipgloss.Color(theme.Grey)
+	black = lipgloss.Color(theme.Black)
+	white = lipgloss.Color(theme.White)
+
+	return newStyle()
+}