https://github.com/printzero/tint
Minimal terminal style module for go
https://github.com/printzero/tint
console golang terminal-colors terminal-style
Last synced: 6 months ago
JSON representation
Minimal terminal style module for go
- Host: GitHub
- URL: https://github.com/printzero/tint
- Owner: printzero
- License: apache-2.0
- Created: 2019-03-03T16:32:44.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T18:06:34.000Z (about 2 years ago)
- Last Synced: 2025-04-18T15:16:37.505Z (6 months ago)
- Topics: console, golang, terminal-colors, terminal-style
- Language: Go
- Homepage: https://pkg.go.dev/github.com/printzero/tint
- Size: 271 KB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tint aims to provide functions that you can use to color your cli text output. This project is originally written to be used
in the project called [orb](https://github.com/orbpkg/orb) which I'm currently working on. It resolves some of my concerns
about the state of terminal styling implemented in Go.
[](https://godoc.org/github.com/printzero/tint)
### Import
```bash
go get github.com/printzero/tint
```
### Getting started
The below topics will get you started with the basics of this module and also some of the features that it provides.
#### Initialization
Initialize a pointer to `Tint` struct
```go
t := tint.Init()
```
#### Functions
Tint has some functions that let you directly color your terminal output, Example:
```go
t.Println("This is an error", tint.Red)
```
this function is equivalent to `fmt.Println()`, but notice the extra parameter passed. This is a color constant.
A lot of times we need to use the raw string representation of colored string for various purposes and this is where
`t.Raw` is used. Example:
```go
err := writeCode()
if err != nil {
panic(err)
}
func writeCode() error {
return errors.New(t.Raw("This is a very bad error and it occurred while coding", tint.Red))
}
```
#### Higher-order color functions
It is possible with this module to create higher order functions with the help of `Swatch`. A swatch returns a function for a given color variable and print as well, Example:
```go
package main
import (
"time"
"tint"
)
var green tint.SwatchFunc
var yellow tint.SwatchFunc
func main() {
t := tint.Init()
green = t.Swatch(tint.Green)
yellow = t.Swatch(tint.Yellow)
yellow("Waiting for 2 seconds just for fun ...")
time.Sleep(time.Second * 2)
green("I give you a green light")
}
```
It is also possible for a swatch function to return a raw colored string using `SwatchRaw` but does not print it to stdout. So the above example becomes:
```go
package main
import (
"fmt"
"time"
"tint"
)
var green tint.SwatchFuncRaw
var yellow tint.SwatchFuncRaw
func main() {
t := tint.Init()
green = t.SwatchRaw(tint.Green)
yellow = t.SwatchRaw(tint.Yellow)
y := yellow("Waiting for 2 seconds just for fun ...")
fmt.Printf("Yellow string: %s", y)
time.Sleep(time.Second * 2)
g := green("I give you a green light")
fmt.Printf("Green string: %s", g)
}
```
### Contributing to this project
Take a look at this [CONTIBUTING.md](https://github.com/printzero/tint/blob/master/CONTIBUTING.md).
### Github Project Board
I use this github project [board](https://github.com/printzero/tint/projects/1) to track changes for this project and any new feature, bug or ideas for upcoming releases are posted here.
### License
This project is licensed under `Apache 2.0`