Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dixonwille/wlog
A simple logging interface that supports cross-platform color and concurrency.
https://github.com/dixonwille/wlog
awesome-go cli golang golang-package logger
Last synced: 3 days ago
JSON representation
A simple logging interface that supports cross-platform color and concurrency.
- Host: GitHub
- URL: https://github.com/dixonwille/wlog
- Owner: dixonwille
- License: mit
- Created: 2016-04-13T16:47:40.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-11-25T10:51:50.000Z (about 2 months ago)
- Last Synced: 2025-01-02T17:14:53.887Z (10 days ago)
- Topics: awesome-go, cli, golang, golang-package, logger
- Language: Go
- Homepage:
- Size: 127 KB
- Stars: 66
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - wlog - Simple logging interface that supports cross-platform color and concurrency. (Command Line / Standard CLI)
- fucking-awesome-go - wlog - Simple logging interface that supports cross-platform color and concurrency. (Command Line / Standard CLI)
- awesome-go - wlog - Simple logging interface that supports cross-platform color and concurrency. (Command Line / Standard CLI)
- awesome-go - wlog - Simple logging interface that supports cross-platform color and concurrency. (Command Line / Standard CLI)
- awesome-go - wlog - A simple logging interface that supports cross-platform color and concurrency. - ★ 26 (Command Line)
- awesome-go-extra - wlog - platform color and concurrency.|57|6|0|2016-04-13T16:47:40Z|2021-08-31T17:23:26Z| (Build Automation / Standard CLI)
- awesome-go-with-stars - wlog - Simple logging interface that supports cross-platform color and concurrency. (Command Line / Standard CLI)
- awesome-go-cn - wlog
- awesome-go-plus - wlog - Simple logging interface that supports cross-platform color and concurrency. ![stars](https://img.shields.io/badge/stars-66-blue) (Command Line / Standard CLI)
- awesome-go-plus - wlog - Simple logging interface that supports cross-platform color and concurrency. ![stars](https://img.shields.io/badge/stars-66-blue) (Command Line / Standard CLI)
README
# WLog[![Pull Requests](https://github.com/dixonwille/wlog/actions/workflows/pullRequests.yaml/badge.svg?event=push)](https://github.com/dixonwille/wlog/actions/workflows/pullRequests.yaml)
Package wlog creates simple to use UI structure. The UI is used to simply print
to the screen. There a wrappers that will wrap each other to create a good
looking UI. You can add color and prefixes as well as make it thread safe.## Documentation
https://pkg.go.dev/github.com/dixonwille/wlog/v3
## Installation
WLog can be added to your go module file by running:
```bash
go get github.com/dixonwille/wlog/v3@latest
```You can them import the library using an import statement:
```go
import "github.com/dixonwille/wlog/v3"
```## Idea Behind WLog
I used Mitchellh's [CLI](https://github.com/mitchellh/cli) structure and
wrapping for the different structures. It was a clean look and feel. Plus it
was pretty simple to use. But I didn't want all the other cli stuff that came
with the package so I created this.For color I use DavidDenGCN's
[Go-ColorText](https://github.com/daviddengcn/go-colortext). His color package
allows for color that is available cross-platforms. I made a wrapper with all
possible color combinations with his package. So you only have to import this
package (one less line).## Example Usage
This example creates a new `wlog.UI` instance, simulates a user providing input and calls UI functions that show output. If you wish to try the example and provide your own user input you can replace the `reader` variable with a reader such as `os.Stdin` which will read from a terminal.
```go
var ui wlog.UI
reader := strings.NewReader("User Input\r\n") //Simulate user typing "User Input" then pressing [enter] when reading from os.Stdin
ui = wlog.New(reader, os.Stdout, os.Stdout)
ui = wlog.AddPrefix("?", wlog.Cross, " ", "", "", "~", wlog.Check, "!", ui)
ui = wlog.AddConcurrent(ui)ui.Ask("Ask question", "")
ui.Error("Error message")
ui.Info("Info message")
ui.Output("Output message")
ui.Running("Running message")
ui.Success("Success message")
ui.Warn("Warning message")
```Output:
```
? Ask question
✗ Error message
Info message
Output message
~ Running message
✓ Success message
! Warning message
```On Windows it outputs to this (this includes color):
![winss](https://raw.githubusercontent.com/dixonwille/wlog/master/resources/winss.png)
On Mac it outputs to this (this includes color):
![macss](https://raw.githubusercontent.com/dixonwille/wlog/master/resources/macss.png)