README.md

@@ -20,7 +20,7 @@ go get github.com/TwiN/go-color
 
 ### Function
 
-You can use the `color.Colorize(color, message)` or `color.Ize(color, message)` function 
+You can use the `color.Colorize(color, str)`, the `color.Ize(color, string)`, or the `color.With(color, str)` function
 in conjunction with a variable like so:
 ```go
 package main
@@ -36,8 +36,8 @@ func main() {
 }
 ```
 
-Because I felt reading `color.Ize()` to be more visually pleasant than `color.Colorize()`, 
-I included `Ize()` as an alias for `Colorize()`.
+Because I felt reading `color.With()`/`color.Ize()` to be more visually pleasant than `color.Colorize()`, 
+I included `Ize()` and `With()` as an alias for `Colorize()`.
 
 I'm not usually a big fan of having two methods doing the same thing, but since
 this package doesn't have much room for growth (its only purpose is to colorize
@@ -51,20 +51,40 @@ package main
 import "github.com/TwiN/go-color"
 
 func main() {
+    // Special
     println(color.InBold("This is bold"))
     println(color.InUnderline("This is underlined"))
-    println(color.InBlack("This is black"))
-    println(color.InRed("This is red"))
-    println(color.InGreen("This is green"))
-    println(color.InYellow("This is yellow"))
-    println(color.InBlue("This is blue"))
-    println(color.InPurple("This is purple"))
-    println(color.InCyan("This is cyan"))
-    println(color.InGray("This is gray"))
-    println(color.InWhite("This is white"))
+    // Text colors
+    println(color.InBlack("This is in black"))
+    println(color.InRed("This is in red"))
+    println(color.InGreen("This is in green"))
+    println(color.InYellow("This is in yellow"))
+    println(color.InBlue("This is in blue"))
+    println(color.InPurple("This is in purple"))
+    println(color.InCyan("This is in cyan"))
+    println(color.InGray("This is in gray"))
+    println(color.InWhite("This is in white"))
+    // Background colors
+    println(color.OverBlack("This is over a black background"))
+    println(color.OverRed("This is over a red background"))
+    println(color.OverGreen("This is over a green background"))
+    println(color.OverYellow("This is over a yellow background"))
+    println(color.OverBlue("This is over a blue background"))
+    println(color.OverPurple("This is over a purple background"))
+    println(color.OverCyan("This is over a cyan background"))
+    println(color.OverGray("This is over a gray background"))
+    println(color.OverWhite("This is over a white background"))
 }
 ```
 
+If you wish, you can also combine text and background colors by using the `In<color>Over<color>` functions, e.g.:
+```go
+color.InWhiteOverBlack("This is white text on a black background")
+color.InRedOverYellow("This is red text on a yellow background")
+color.InGreenOverBlue("This is green text on a blue background")
+```
+Note that the example above is not exhaustive.
+
 
 ### Variables only
 

color.go

@@ -1,18 +1,42 @@
 package color
 
 var (
-	Reset     = "\033[0m"
+	Reset = "\033[0m"
+
+	/////////////
+	// Special //
+	/////////////
+
 	Bold      = "\033[1m"
 	Underline = "\033[4m"
-	Black     = "\033[30m"
-	Red       = "\033[31m"
-	Green     = "\033[32m"
-	Yellow    = "\033[33m"
-	Blue      = "\033[34m"
-	Purple    = "\033[35m"
-	Cyan      = "\033[36m"
-	Gray      = "\033[37m"
-	White     = "\033[97m"
+
+	/////////////////
+	// Text colors //
+	/////////////////
+
+	Black  = "\033[30m"
+	Red    = "\033[31m"
+	Green  = "\033[32m"
+	Yellow = "\033[33m"
+	Blue   = "\033[34m"
+	Purple = "\033[35m"
+	Cyan   = "\033[36m"
+	Gray   = "\033[37m"
+	White  = "\033[97m"
+
+	///////////////////////
+	// Background colors //
+	///////////////////////
+
+	BlackBackground  = "\033[40m"
+	RedBackground    = "\033[41m"
+	GreenBackground  = "\033[42m"
+	YellowBackground = "\033[43m"
+	BlueBackground   = "\033[44m"
+	PurpleBackground = "\033[45m"
+	CyanBackground   = "\033[46m"
+	GrayBackground   = "\033[47m"
+	WhiteBackground  = "\033[107m"
 )
 
 // Ize is an alias for the Colorize function
@@ -24,6 +48,15 @@ func Ize(color, s string) string {
 	return Colorize(color, s)
 }
 
+// With is an alias for the Colorize function
+//
+// Example:
+//
+//	println(color.With(color.Red, "This is red"))
+func With(color, s string) string {
+	return Colorize(color, s)
+}
+
 // Colorize wraps a given message in a given color.
 //
 // Example:
@@ -131,3 +164,166 @@ func InGray(s string) string {
 func InWhite(s string) string {
 	return Colorize(White, s)
 }
+
+// OverBlack wraps the given string s in BlackBackground
+//
+// Example:
+//
+//	println(color.OverBlack("This is over black"))
+func OverBlack(s string) string {
+	return Colorize(BlackBackground, s)
+}
+
+// OverRed wraps the given string s in RedBackground
+//
+// Example:
+//
+//	println(color.OverRed("This is over red"))
+func OverRed(s string) string {
+	return Colorize(RedBackground, s)
+}
+
+// OverGreen wraps the given string s in GreenBackground
+//
+// Example:
+//
+//	println(color.OverGreen("This is over green"))
+func OverGreen(s string) string {
+	return Colorize(GreenBackground, s)
+}
+
+// OverYellow wraps the given string s in YellowBackground
+//
+// Example:
+//
+//	println(color.OverYellow("This is over yellow"))
+func OverYellow(s string) string {
+	return Colorize(YellowBackground, s)
+}
+
+// OverBlue wraps the given string s in BlueBackground
+//
+// Example:
+//
+//	println(color.OverBlue("This is over blue"))
+func OverBlue(s string) string {
+	return Colorize(BlueBackground, s)
+}
+
+// OverPurple wraps the given string s in PurpleBackground
+//
+// Example:
+//
+//	println(color.OverPurple("This is over purple"))
+func OverPurple(s string) string {
+	return Colorize(PurpleBackground, s)
+}
+
+// OverCyan wraps the given string s in CyanBackground
+//
+// Example:
+//
+//	println(color.OverCyan("This is over cyan"))
+func OverCyan(s string) string {
+	return Colorize(CyanBackground, s)
+}
+
+// OverGray wraps the given string s in GrayBackground
+//
+// Example:
+//
+//	println(color.OverGray("This is over gray"))
+func OverGray(s string) string {
+	return Colorize(GrayBackground, s)
+}
+
+// OverWhite wraps the given string s in WhiteBackground
+//
+// Example:
+//
+//	println(color.OverWhite("This is over white"))
+func OverWhite(s string) string {
+	return Colorize(WhiteBackground, s)
+}
+
+func InBlackOverBlack(s string) string   { return Colorize(Black+BlackBackground, s) }
+func InBlackOverRed(s string) string     { return Colorize(Black+RedBackground, s) }
+func InBlackOverGreen(s string) string   { return Colorize(Black+GreenBackground, s) }
+func InBlackOverYellow(s string) string  { return Colorize(Black+YellowBackground, s) }
+func InBlackOverBlue(s string) string    { return Colorize(Black+BlueBackground, s) }
+func InBlackOverPurple(s string) string  { return Colorize(Black+PurpleBackground, s) }
+func InBlackOverCyan(s string) string    { return Colorize(Black+CyanBackground, s) }
+func InBlackOverGray(s string) string    { return Colorize(Black+GrayBackground, s) }
+func InBlackOverWhite(s string) string   { return Colorize(Black+WhiteBackground, s) }
+func InRedOverBlack(s string) string     { return Colorize(Red+BlackBackground, s) }
+func InRedOverRed(s string) string       { return Colorize(Red+RedBackground, s) }
+func InRedOverGreen(s string) string     { return Colorize(Red+GreenBackground, s) }
+func InRedOverYellow(s string) string    { return Colorize(Red+YellowBackground, s) }
+func InRedOverBlue(s string) string      { return Colorize(Red+BlueBackground, s) }
+func InRedOverPurple(s string) string    { return Colorize(Red+PurpleBackground, s) }
+func InRedOverCyan(s string) string      { return Colorize(Red+CyanBackground, s) }
+func InRedOverGray(s string) string      { return Colorize(Red+GrayBackground, s) }
+func InRedOverWhite(s string) string     { return Colorize(Red+WhiteBackground, s) }
+func InGreenOverBlack(s string) string   { return Colorize(Green+BlackBackground, s) }
+func InGreenOverRed(s string) string     { return Colorize(Green+RedBackground, s) }
+func InGreenOverGreen(s string) string   { return Colorize(Green+GreenBackground, s) }
+func InGreenOverYellow(s string) string  { return Colorize(Green+YellowBackground, s) }
+func InGreenOverBlue(s string) string    { return Colorize(Green+BlueBackground, s) }
+func InGreenOverPurple(s string) string  { return Colorize(Green+PurpleBackground, s) }
+func InGreenOverCyan(s string) string    { return Colorize(Green+CyanBackground, s) }
+func InGreenOverGray(s string) string    { return Colorize(Green+GrayBackground, s) }
+func InGreenOverWhite(s string) string   { return Colorize(Green+WhiteBackground, s) }
+func InYellowOverBlack(s string) string  { return Colorize(Yellow+BlackBackground, s) }
+func InYellowOverRed(s string) string    { return Colorize(Yellow+RedBackground, s) }
+func InYellowOverGreen(s string) string  { return Colorize(Yellow+GreenBackground, s) }
+func InYellowOverYellow(s string) string { return Colorize(Yellow+YellowBackground, s) }
+func InYellowOverBlue(s string) string   { return Colorize(Yellow+BlueBackground, s) }
+func InYellowOverPurple(s string) string { return Colorize(Yellow+PurpleBackground, s) }
+func InYellowOverCyan(s string) string   { return Colorize(Yellow+CyanBackground, s) }
+func InYellowOverGray(s string) string   { return Colorize(Yellow+GrayBackground, s) }
+func InYellowOverWhite(s string) string  { return Colorize(Yellow+WhiteBackground, s) }
+func InBlueOverBlack(s string) string    { return Colorize(Blue+BlackBackground, s) }
+func InBlueOverRed(s string) string      { return Colorize(Blue+RedBackground, s) }
+func InBlueOverGreen(s string) string    { return Colorize(Blue+GreenBackground, s) }
+func InBlueOverYellow(s string) string   { return Colorize(Blue+YellowBackground, s) }
+func InBlueOverBlue(s string) string     { return Colorize(Blue+BlueBackground, s) }
+func InBlueOverPurple(s string) string   { return Colorize(Blue+PurpleBackground, s) }
+func InBlueOverCyan(s string) string     { return Colorize(Blue+CyanBackground, s) }
+func InBlueOverGray(s string) string     { return Colorize(Blue+GrayBackground, s) }
+func InBlueOverWhite(s string) string    { return Colorize(Blue+WhiteBackground, s) }
+func InPurpleOverBlack(s string) string  { return Colorize(Purple+BlackBackground, s) }
+func InPurpleOverRed(s string) string    { return Colorize(Purple+RedBackground, s) }
+func InPurpleOverGreen(s string) string  { return Colorize(Purple+GreenBackground, s) }
+func InPurpleOverYellow(s string) string { return Colorize(Purple+YellowBackground, s) }
+func InPurpleOverBlue(s string) string   { return Colorize(Purple+BlueBackground, s) }
+func InPurpleOverPurple(s string) string { return Colorize(Purple+PurpleBackground, s) }
+func InPurpleOverCyan(s string) string   { return Colorize(Purple+CyanBackground, s) }
+func InPurpleOverGray(s string) string   { return Colorize(Purple+GrayBackground, s) }
+func InPurpleOverWhite(s string) string  { return Colorize(Purple+WhiteBackground, s) }
+func InCyanOverBlack(s string) string    { return Colorize(Cyan+BlackBackground, s) }
+func InCyanOverRed(s string) string      { return Colorize(Cyan+RedBackground, s) }
+func InCyanOverGreen(s string) string    { return Colorize(Cyan+GreenBackground, s) }
+func InCyanOverYellow(s string) string   { return Colorize(Cyan+YellowBackground, s) }
+func InCyanOverBlue(s string) string     { return Colorize(Cyan+BlueBackground, s) }
+func InCyanOverPurple(s string) string   { return Colorize(Cyan+PurpleBackground, s) }
+func InCyanOverCyan(s string) string     { return Colorize(Cyan+CyanBackground, s) }
+func InCyanOverGray(s string) string     { return Colorize(Cyan+GrayBackground, s) }
+func InCyanOverWhite(s string) string    { return Colorize(Cyan+WhiteBackground, s) }
+func InGrayOverBlack(s string) string    { return Colorize(Gray+BlackBackground, s) }
+func InGrayOverRed(s string) string      { return Colorize(Gray+RedBackground, s) }
+func InGrayOverGreen(s string) string    { return Colorize(Gray+GreenBackground, s) }
+func InGrayOverYellow(s string) string   { return Colorize(Gray+YellowBackground, s) }
+func InGrayOverBlue(s string) string     { return Colorize(Gray+BlueBackground, s) }
+func InGrayOverPurple(s string) string   { return Colorize(Gray+PurpleBackground, s) }
+func InGrayOverCyan(s string) string     { return Colorize(Gray+CyanBackground, s) }
+func InGrayOverGray(s string) string     { return Colorize(Gray+GrayBackground, s) }
+func InGrayOverWhite(s string) string    { return Colorize(Gray+WhiteBackground, s) }
+func InWhiteOverBlack(s string) string   { return Colorize(White+BlackBackground, s) }
+func InWhiteOverRed(s string) string     { return Colorize(White+RedBackground, s) }
+func InWhiteOverGreen(s string) string   { return Colorize(White+GreenBackground, s) }
+func InWhiteOverYellow(s string) string  { return Colorize(White+YellowBackground, s) }
+func InWhiteOverBlue(s string) string    { return Colorize(White+BlueBackground, s) }
+func InWhiteOverPurple(s string) string  { return Colorize(White+PurpleBackground, s) }
+func InWhiteOverCyan(s string) string    { return Colorize(White+CyanBackground, s) }
+func InWhiteOverGray(s string) string    { return Colorize(White+GrayBackground, s) }
+func InWhiteOverWhite(s string) string   { return Colorize(White+WhiteBackground, s) }