185 lines
3.7 KiB
Markdown
185 lines
3.7 KiB
Markdown
# | extended terminal format |
|
|
|
|
[](https://golang.org/doc/go1.11)
|
|
[](https://goreportcard.com/report/git.xdrm.io/go/clifmt)
|
|
[](https://godoc.org/git.xdrm.io/go/clifmt)
|
|
[](https://app.buddy.works/xdrmbracketsdev/clifmt/repository/branch/master)
|
|
|
|
|
|
Simple utility written in `go` that extends the standard `fmt.Sprintf` and `fmt.Printf` functions. It allows you to set foreground/background color, **bold**, <u>underlined</u> and _italic_ text.
|
|
|
|
<!-- toc -->
|
|
|
|
- [(1) Format](#1-format)
|
|
- [[Colorization]](#colorization)
|
|
- [Base format](#base-format)
|
|
- [Example](#example)
|
|
- [Foreground only](#foreground-only)
|
|
- [Example](#example-1)
|
|
- [Background only](#background-only)
|
|
- [Example](#example-2)
|
|
- [[Markdown-like format]](#markdown-like-format)
|
|
- [Bold format](#bold-format)
|
|
- [Example](#example-3)
|
|
- [Italic format](#italic-format)
|
|
- [Example](#example-4)
|
|
- [Underline format](#underline-format)
|
|
- [Example](#example-5)
|
|
- [(2) Screenshot](#2-screenshot)
|
|
- [Colorizing format example :](#colorizing-format-example-)
|
|
- [Markdown-like format example](#markdown-like-format-example)
|
|
- [(3) Incoming features](#3-incoming-features)
|
|
|
|
<!-- tocstop -->
|
|
|
|
----
|
|
|
|
## (1) Format
|
|
|
|
|
|
|
|
### [Colorization]
|
|
|
|
#### Base format
|
|
|
|
```go
|
|
${<target text>}(<fg>:<bg>)
|
|
```
|
|
|
|
- `<target text>` is the text that will be colorized.
|
|
|
|
- `<fg>` is the name of the foreground color (*c.f. [color list](https://git.xdrm.io/go/clifmt/src/master/colors.go#L15)*), or an hex color (*e.g.`#00ffaa`, `#0fa`*).
|
|
|
|
- `<bg>` is the name of the background color with the same syntax as for the foreground.
|
|
|
|
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text ${red text over black}(red:#000) normal text")
|
|
```
|
|
|
|
> Note that it is not recommended to nest the different coloring formats.
|
|
|
|
|
|
|
|
#### Foreground only
|
|
|
|
```go
|
|
${<target text>}(<fg>)
|
|
```
|
|
|
|
- `<target text>` is the text that will be colorized.
|
|
- `<fg>` is the name of the foreground color.
|
|
|
|
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text ${red text}(red) normal text")
|
|
```
|
|
|
|
|
|
|
|
#### Background only
|
|
|
|
```go
|
|
${<target text>}(:<bg>)
|
|
```
|
|
|
|
- `<target text>` is the text that will be colorized.
|
|
- `<bg>` is the name of the background color.
|
|
|
|
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text ${text over red}(#ff0000) normal text")
|
|
```
|
|
|
|
|
|
|
|
### [Markdown-like format]
|
|
|
|
|
|
|
|
#### Bold format
|
|
|
|
```go
|
|
**<target text>**
|
|
```
|
|
|
|
- `<target text>` is the text that will be bold.
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text **bold text** normal text")
|
|
```
|
|
|
|
|
|
|
|
#### Italic format
|
|
|
|
```go
|
|
*<target text>*
|
|
```
|
|
|
|
- `<target text>` is the text that will be italic.
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text *italic text* normal text")
|
|
```
|
|
|
|
|
|
|
|
#### Underline format
|
|
|
|
```go
|
|
_<target text>_
|
|
```
|
|
|
|
- `<target text>` is the text that will be underlined.
|
|
|
|
###### Example
|
|
|
|
```go
|
|
clifmt.Printf("normal text _underline text_ normal text")
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
## (2) Screenshot
|
|
|
|
|
|
|
|
###### Colorizing format example :
|
|
|
|
|
|
|
|
|
|
|
|
###### Markdown-like format example
|
|
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
## (3) Incoming features
|
|
|
|
- [x] **markdown-like formatting** - bold, italic, underlined, (strike-through?)
|
|
- [ ] **global alignment** - align text dynamically
|
|
- [ ] **progress-line** - redrawing format to show, for instance an animated progress bar on the same line
|
|
|