Issue #582: Add simplified badge colors (#669)

* add named colors map that includes shieldsio specific colors, semantic alias, and common css color names. add resolve color helper. update parse bade settings to use new helper. add tests for named color resolution

* update readme

Author: demarsdouglas

README.md

@@ -1084,20 +1084,38 @@ For `cocomo` you can also set the `avg-wage` value similar to `scc` itself. For
 
 Note that the avg-wage value must be a positive integer otherwise it will revert back to the default value of 56286.
 
-You can also configure the look and feel of the bad using the following parameters,
+You can also configure the look and feel of the badge using the following parameters,
 
 - ?lower=true will lower the title text, so "Total lines" would be "total lines"
-he below can control the colours of shadows, fonts and badges
+
+The below can control the colours of shadows, fonts and badges. Colors can be specified as either hex codes or named colors (similar to shields.io):
+
 - ?font-color=fff
 - ?font-shadow-color=010101
 - ?top-shadow-accent-color=bbb
 - ?title-bg-color=555
 - ?badge-bg-color=4c1
 
+##### Named Colors
+
+For convenience, you can use named colors instead of hex codes. The following named colors are supported:
+
+**Shields.io colors:** `brightgreen`, `green`, `yellowgreen`, `yellow`, `orange`, `red`, `blue`, `lightgrey`, `blueviolet`
+
+**Semantic aliases:** `success`, `important`, `critical`, `informational`, `inactive`
+
+**CSS colors:** `white`, `black`, `silver`, `gray`, `maroon`, `purple`, `fuchsia`, `lime`, `olive`, `navy`, `teal`, `aqua`, `cyan`, `magenta`, `pink`, `coral`, `salmon`, `gold`, `khaki`, `violet`, `indigo`, `crimson`, `turquoise`, `tan`, `brown`, and many more standard CSS color names.
+
+For example, instead of `?badge-bg-color=007ec6` you can use `?badge-bg-color=blue`.
+
 An example of using some of these parameters to produce an admittedly ugly result
 
 [![Scc Count Badge](https://sloc.xyz/github/boyter/scc?font-color=ff0000&badge-bg-color=0000ff&lower=true)](https://github.com/boyter/scc/)
 
+An example using named colors for as a slightly nicer result
+
+[![Scc Count Badge](https://sloc.xyz/github/boyter/scc?title-bg-color=navy&badge-bg-color=blue&font-color=white)](https://github.com/boyter/scc/)
+
 *NB* it may not work for VERY large repositories (has been tested on Apache hadoop/spark without issue).
 
 You can find the source code for badges in the repository at <https://github.com/boyter/scc/blob/master/cmd/badges/main.go>

cmd/badges/main.go

@@ -241,6 +241,157 @@ type badgeSettings struct {
 	BadgeBackgroundColor string
 }
 
+// namedColors maps color names to their hex values (without #).
+// Includes shields.io colors and common CSS color names for compatibility.
+var namedColors = map[string]string{
+	// shields.io specific colors
+	"brightgreen": "44cc11",
+	"green":       "97ca00",
+	"yellowgreen": "a4a61d",
+	"yellow":      "dfb317",
+	"orange":      "fe7d37",
+	"red":         "e05d44",
+	"blue":        "007ec6",
+	"lightgrey":   "9f9f9f",
+	"lightgray":   "9f9f9f",
+	"grey":        "555555",
+	"gray":        "555555",
+	"blueviolet":  "8a2be2",
+	// shields.io semantic aliases
+	"success":       "44cc11",
+	"important":     "fe7d37",
+	"critical":      "e05d44",
+	"informational": "007ec6",
+	"inactive":      "9f9f9f",
+	// Common CSS color names
+	"black":           "000000",
+	"white":           "ffffff",
+	"silver":          "c0c0c0",
+	"maroon":          "800000",
+	"purple":          "800080",
+	"fuchsia":         "ff00ff",
+	"lime":            "00ff00",
+	"olive":           "808000",
+	"navy":            "000080",
+	"teal":            "008080",
+	"aqua":            "00ffff",
+	"cyan":            "00ffff",
+	"magenta":         "ff00ff",
+	"pink":            "ffc0cb",
+	"coral":           "ff7f50",
+	"salmon":          "fa8072",
+	"gold":            "ffd700",
+	"khaki":           "f0e68c",
+	"violet":          "ee82ee",
+	"indigo":          "4b0082",
+	"crimson":         "dc143c",
+	"turquoise":       "40e0d0",
+	"tan":             "d2b48c",
+	"brown":           "a52a2a",
+	"chocolate":       "d2691e",
+	"tomato":          "ff6347",
+	"orchid":          "da70d6",
+	"plum":            "dda0dd",
+	"peru":            "cd853f",
+	"sienna":          "a0522d",
+	"beige":           "f5f5dc",
+	"ivory":           "fffff0",
+	"linen":           "faf0e6",
+	"azure":           "f0ffff",
+	"lavender":        "e6e6fa",
+	"wheat":           "f5deb3",
+	"snow":            "fffafa",
+	"seashell":        "fff5ee",
+	"honeydew":        "f0fff0",
+	"mintcream":       "f5fffa",
+	"aliceblue":       "f0f8ff",
+	"ghostwhite":      "f8f8ff",
+	"oldlace":         "fdf5e6",
+	"papayawhip":      "ffefd5",
+	"moccasin":        "ffe4b5",
+	"bisque":          "ffe4c4",
+	"mistyrose":       "ffe4e1",
+	"lemonchiffon":    "fffacd",
+	"cornsilk":        "fff8dc",
+	"antiquewhite":    "faebd7",
+	"floralwhite":     "fffaf0",
+	"steelblue":       "4682b4",
+	"royalblue":       "4169e1",
+	"skyblue":         "87ceeb",
+	"dodgerblue":      "1e90ff",
+	"deepskyblue":     "00bfff",
+	"cadetblue":       "5f9ea0",
+	"cornflowerblue":  "6495ed",
+	"mediumblue":      "0000cd",
+	"darkblue":        "00008b",
+	"midnightblue":    "191970",
+	"slateblue":       "6a5acd",
+	"darkslateblue":   "483d8b",
+	"mediumslateblue": "7b68ee",
+	"seagreen":        "2e8b57",
+	"mediumseagreen":  "3cb371",
+	"lightgreen":      "90ee90",
+	"darkgreen":       "006400",
+	"forestgreen":     "228b22",
+	"limegreen":       "32cd32",
+	"springgreen":     "00ff7f",
+	"palegreen":       "98fb98",
+	"darkseagreen":    "8fbc8f",
+	"olivedrab":       "6b8e23",
+	"darkolivegreen":  "556b2f",
+	"darkred":         "8b0000",
+	"firebrick":       "b22222",
+	"indianred":       "cd5c5c",
+	"lightsalmon":     "ffa07a",
+	"darksalmon":      "e9967a",
+	"lightcoral":      "f08080",
+	"rosybrown":       "bc8f8f",
+	"sandybrown":      "f4a460",
+	"goldenrod":       "daa520",
+	"darkgoldenrod":   "b8860b",
+	"darkorange":      "ff8c00",
+	"orangered":       "ff4500",
+	"hotpink":         "ff69b4",
+	"deeppink":        "ff1493",
+	"palevioletred":   "db7093",
+	"mediumvioletred": "c71585",
+	"mediumpurple":    "9370db",
+	"darkorchid":      "9932cc",
+	"darkviolet":      "9400d3",
+	"darkmagenta":     "8b008b",
+	"slategray":       "708090",
+	"slategrey":       "708090",
+	"lightslategray":  "778899",
+	"lightslategrey":  "778899",
+	"darkslategray":   "2f4f4f",
+	"darkslategrey":   "2f4f4f",
+	"dimgray":         "696969",
+	"dimgrey":         "696969",
+	"darkgray":        "a9a9a9",
+	"darkgrey":        "a9a9a9",
+	"gainsboro":       "dcdcdc",
+	"whitesmoke":      "f5f5f5",
+}
+
+// resolveColor converts a color input (name or hex) to a hex value without #.
+// Returns the hex value if valid, or empty string if invalid.
+func resolveColor(color string) string {
+	color = strings.ToLower(color)
+
+	// Check if it's a named color
+	if hex, ok := namedColors[color]; ok {
+		return hex
+	}
+
+	// Check if it's a valid hex color (3, 4, 6, or 8 digits)
+	hexRegex := regexp.MustCompile(`^(?:(?:[\da-f]{3}){1,2}|(?:[\da-f]{4}){1,2})$`)
+	if hexRegex.MatchString(color) {
+		return color
+	}
+
+	return ""
+}
+
 // Parses badge settings from url query params
 // if error, ignore and return default badge settings
 func parseBadgeSettings(values url.Values) *badgeSettings {
@@ -252,31 +403,27 @@ func parseBadgeSettings(values url.Values) *badgeSettings {
 		BadgeBackgroundColor: "4c1",
 	}
 
-	fontColor := strings.ToLower(values.Get("font-color"))
-	textShadowColor := strings.ToLower(values.Get("font-shadow-color"))
-	topShadowAccentColor := strings.ToLower(values.Get("top-shadow-accent-color"))
-	titleBackgroundColor := strings.ToLower(values.Get("title-bg-color"))
-	badgeBackgroundColor := strings.ToLower(values.Get("badge-bg-color"))
+	fontColor := values.Get("font-color")
+	textShadowColor := values.Get("font-shadow-color")
+	topShadowAccentColor := values.Get("top-shadow-accent-color")
+	titleBackgroundColor := values.Get("title-bg-color")
+	badgeBackgroundColor := values.Get("badge-bg-color")
 
-	// Ensure valid colors
-	r, err := regexp.Compile(`^(?:(?:[\da-f]{3}){1,2}|(?:[\da-f]{4}){1,2})$`)
-	if err != nil {
-		return &bs
-	}
-	if r.MatchString(fontColor) {
-		bs.FontColor = fontColor
+	// Resolve colors (supports both named colors and hex codes)
+	if resolved := resolveColor(fontColor); resolved != "" {
+		bs.FontColor = resolved
 	}
-	if r.MatchString(textShadowColor) {
-		bs.TextShadowColor = textShadowColor
+	if resolved := resolveColor(textShadowColor); resolved != "" {
+		bs.TextShadowColor = resolved
 	}
-	if r.MatchString(topShadowAccentColor) {
-		bs.TopShadowAccentColor = topShadowAccentColor
+	if resolved := resolveColor(topShadowAccentColor); resolved != "" {
+		bs.TopShadowAccentColor = resolved
 	}
-	if r.MatchString(titleBackgroundColor) {
-		bs.TitleBackgroundColor = titleBackgroundColor
+	if resolved := resolveColor(titleBackgroundColor); resolved != "" {
+		bs.TitleBackgroundColor = resolved
 	}
-	if r.MatchString(badgeBackgroundColor) {
-		bs.BadgeBackgroundColor = badgeBackgroundColor
+	if resolved := resolveColor(badgeBackgroundColor); resolved != "" {
+		bs.BadgeBackgroundColor = resolved
 	}
 
 	return &bs

cmd/badges/main_test.go

@@ -6,6 +6,62 @@ import (
 	"testing"
 )
 
+func Test_resolveColor(t *testing.T) {
+	tests := []struct {
+		name  string
+		color string
+		want  string
+	}{
+		// Named colors (shields.io)
+		{name: "blue", color: "blue", want: "007ec6"},
+		{name: "red", color: "red", want: "e05d44"},
+		{name: "green", color: "green", want: "97ca00"},
+		{name: "brightgreen", color: "brightgreen", want: "44cc11"},
+		{name: "yellowgreen", color: "yellowgreen", want: "a4a61d"},
+		{name: "orange", color: "orange", want: "fe7d37"},
+		{name: "yellow", color: "yellow", want: "dfb317"},
+		{name: "lightgrey", color: "lightgrey", want: "9f9f9f"},
+		{name: "lightgray", color: "lightgray", want: "9f9f9f"},
+		{name: "blueviolet", color: "blueviolet", want: "8a2be2"},
+		// Semantic aliases
+		{name: "success", color: "success", want: "44cc11"},
+		{name: "critical", color: "critical", want: "e05d44"},
+		{name: "informational", color: "informational", want: "007ec6"},
+		// CSS colors
+		{name: "white", color: "white", want: "ffffff"},
+		{name: "black", color: "black", want: "000000"},
+		{name: "navy", color: "navy", want: "000080"},
+		{name: "teal", color: "teal", want: "008080"},
+		// Case insensitivity
+		{name: "BLUE uppercase", color: "BLUE", want: "007ec6"},
+		{name: "Blue mixed case", color: "Blue", want: "007ec6"},
+		// Hex codes (3 digit)
+		{name: "hex 3 digit", color: "fff", want: "fff"},
+		{name: "hex 3 digit mixed", color: "a1b", want: "a1b"},
+		// Hex codes (6 digit)
+		{name: "hex 6 digit", color: "abcdef", want: "abcdef"},
+		{name: "hex 6 digit uppercase", color: "ABCDEF", want: "abcdef"},
+		// Hex codes (4 digit with alpha)
+		{name: "hex 4 digit", color: "fffa", want: "fffa"},
+		// Hex codes (8 digit with alpha)
+		{name: "hex 8 digit", color: "abcdef12", want: "abcdef12"},
+		// Invalid inputs
+		{name: "invalid name", color: "notacolor", want: ""},
+		{name: "invalid hex too short", color: "ab", want: ""},
+		{name: "invalid hex too long", color: "abcdefghi", want: ""},
+		{name: "invalid hex with special chars", color: "abc#ef", want: ""},
+		{name: "empty string", color: "", want: ""},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := resolveColor(tt.color); got != tt.want {
+				t.Errorf("resolveColor(%q) = %q, want %q", tt.color, got, tt.want)
+			}
+		})
+	}
+}
+
 func Test_formatCount(t *testing.T) {
 	type args struct {
 		count float64
@@ -187,6 +243,55 @@ func Test_parseBadgeSettings(t *testing.T) {
 			},
 			want: defaultSettings,
 		},
+		{
+			name: "named colors - shields.io style",
+			values: url.Values{
+				"font-color":              []string{"white"},
+				"font-shadow-color":       []string{"black"},
+				"top-shadow-accent-color": []string{"lightgrey"},
+				"title-bg-color":          []string{"blue"},
+				"badge-bg-color":          []string{"brightgreen"},
+			},
+			want: &badgeSettings{
+				FontColor:            "ffffff",
+				TextShadowColor:      "000000",
+				TopShadowAccentColor: "9f9f9f",
+				TitleBackgroundColor: "007ec6",
+				BadgeBackgroundColor: "44cc11",
+			},
+		},
+		{
+			name: "mixed named colors and hex codes",
+			values: url.Values{
+				"font-color":              []string{"fff"},
+				"font-shadow-color":       []string{"navy"},
+				"top-shadow-accent-color": []string{"bbb"},
+				"title-bg-color":          []string{"blueviolet"},
+				"badge-bg-color":          []string{"success"},
+			},
+			want: &badgeSettings{
+				FontColor:            "fff",
+				TextShadowColor:      "000080",
+				TopShadowAccentColor: "bbb",
+				TitleBackgroundColor: "8a2be2",
+				BadgeBackgroundColor: "44cc11",
+			},
+		},
+		{
+			name: "case insensitive named colors",
+			values: url.Values{
+				"font-color":     []string{"WHITE"},
+				"title-bg-color": []string{"Blue"},
+				"badge-bg-color": []string{"BrightGreen"},
+			},
+			want: &badgeSettings{
+				FontColor:            "ffffff",
+				TextShadowColor:      defaultSettings.TextShadowColor,
+				TopShadowAccentColor: defaultSettings.TopShadowAccentColor,
+				TitleBackgroundColor: "007ec6",
+				BadgeBackgroundColor: "44cc11",
+			},
+		},
 	}
 
 	for _, tt := range tests {