https://github.com/ortense/consolestyle
A lightweight and expressive package to style your console output with ease, adding colors, backgrounds, and various text styles to enhance your command-line experience.
https://github.com/ortense/consolestyle
ansi-escape-codes cli command-line commandline console go golang golang-package terminal
Last synced: about 2 months ago
JSON representation
A lightweight and expressive package to style your console output with ease, adding colors, backgrounds, and various text styles to enhance your command-line experience.
- Host: GitHub
- URL: https://github.com/ortense/consolestyle
- Owner: ortense
- License: mit
- Created: 2024-03-09T22:21:07.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-10T00:11:11.000Z (about 1 year ago)
- Last Synced: 2025-01-17T05:43:52.675Z (3 months ago)
- Topics: ansi-escape-codes, cli, command-line, commandline, console, go, golang, golang-package, terminal
- Language: Go
- Homepage: https://pkg.go.dev/github.com/ortense/consolestyle
- Size: 87.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @ortense/consolestyle
A lightweight and expressive package to style your console output with ease, adding colors, backgrounds, and various text styles to enhance your command-line experience.
## Install
```sh
go get github.com/ortense/consolestyle
```
## Usage
You can use the fluent api of `Style` func.
```go
import (
"fmt"
"github.com/ortense/consolestyle"
)
func main() {
message := consolestyle.
Style("Hey there! 👋").Cyan().Italic().
EmptyLine().
NewLine("Are u tired of boring console outputs?").Inverse().
EmptyLine().
NewLine("✨ Now u can easily create fun console messages! 🦄").Magenta().Bold()
fmt.Println(message)
}
```
Alternatively, you can choose specific functions to apply styles to your console output.
```go
import (
"fmt"
cs "github.com/ortense/consolestyle"
)
func main() {
fmt.Println(cs.Italic(cs.Green("\"Simplicity is the ultimate sophistication.\"")))
fmt.Println(cs.Dim("- Leonardo da Vinci"))
}
```
More details in the [complete documentation](https://pkg.go.dev/github.com/ortense/consolestyle).
## Key Features
- Easily style your console output with a fluent API.
- Apply a wide range of text colors, backgrounds, and styles.
- Enhance your command-line interface with vibrant and visually appealing messages.
### Available styles
- `Red()`: Apply red text color.
- `Green()`: Apply green text color.
- `Yellow()`: Apply yellow text color.
- `Blue()`: Apply blue text color.
- `Magenta()`: Apply magenta text color.
- `Cyan()`: Apply cyan text color.
- `BgRed()`: Apply red background color.
- `BgGreen()`: Apply green background color.
- `BgYellow()`: Apply yellow background color.
- `BgBlue()`: Apply blue background color.
- `BgMagenta()`: Apply magenta background color.
- `BgCyan()`: Apply cyan background color.
- `Inverse()`: Apply inverted colors
- `Bold()`: Apply bold text style.
- `Dim()`: Apply dim text style.
- `Italic()`: Apply italic text style.
- `Underline()`: Apply underline text style.
- `Strike()`: Apply strike-through text style.
## License
This package is licensed under the MIT License. See the LICENSE file for details.