Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/i582/cfmt

Small library for simple and convenient formatted stylized output to the console.
https://github.com/i582/cfmt

cfmt color color-output format go golang stylized

Last synced: about 2 months ago
JSON representation

Small library for simple and convenient formatted stylized output to the console.

Awesome Lists containing this project

README 

        
![](doc/logo.png)



[![Build Status](https://travis-ci.org/i582/cfmt.svg?branch=master)](https://travis-ci.org/i582/cfmt) [![Codecov](https://codecov.io/gh/i582/cfmt/branch/master/graph/badge.svg)](https://codecov.io/gh/i582/cfmt) [![Go Report Card](https://goreportcard.com/badge/github.com/i582/cfmt)](https://goreportcard.com/report/github.com/i582/cfmt) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/i582/phpstats/master/LICENSE) ![](https://img.shields.io/badge/-%3C%3E%20with%20%E2%9D%A4-red) [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)  



# cfmt



**cfmt** is a small library for **simple and convenient formatted stylized output** to the console, providing an interface that is exactly the same as the standard `fmt` and `log` libraries.



## Table of Contents



* [Install](#install)

* [Usage](#usage)

  * [Simple usage](#simple-usage)

  * [Complex style](#complex-style)

  * [Custom styles](#custom-styles)

  * [HEX colors](#hex-colors)

  * [Background color](#background-color)

* [Other examples](#other-examples)

* [Supported colors and styles](#supported-colors-and-styles)

* [Motivation](#motivation)

* [Contact](#contact)

* [License](#license)



## Install



```

go get -v github.com/i582/cfmt

```



## Usage



To switch to `cfmt` anywhere in the code, it is enough to add one letter `c` to `fmt` (or to `log`), import the required part (`cfmt` or `clog`):



```go

import (

	"github.com/i582/cfmt/cmd/cfmt"

	// or

	"github.com/i582/cfmt/cmd/clog"

)

```



and you get all the possibilities, the library is fully compatible with the standard libraries `fmt` and `log`



### Simple usage



Let's take an example:



Suppose you need to display text and highlight some word or phrase. Using `cfmt`, all that is needed is to wrap the desired part in `{{}}` and after `::` write the desired styles:



```go

cfmt.Println("This is a {{red color}}::red")

```



![](doc/example1.svg)



If we compare this with the `gookit/color` library, then this example looks more complicated and less readable there:



```go

fmt.Printf("This is a %s", color.Red.Sprintf("red color"))

```



### Complex style



It is even more convenient if you need complex styles, if you want to make the text also bold, then all you need to add is in the format after `|` write `bold`:



```go

cfmt.Println("This is a {{red color}}::red|bold")

```



![](doc/example2.svg)



In `gookit/color`, this is done as follows:



```go

redBold := color.New(color.FgRed, color.OpBold)

fmt.Printf("This is a %s", redBold.Sprintf("red color"))

```



### Custom styles



In the  `gookit/color` we can reuse the created style, in ` cfmt` this is also possible. To do this, you need to register a new style using the `cfmt.RegisterStyle` function:



```go

cfmt.RegisterStyle("code", func(s string) string {

	return cfmt.Sprintf("{{%s}}::red|underline", s)

})

```



And now it can be used anywhere just by writing its name:



```go

cfmt.Println("This is a {{red color}}::code")

```



![](doc/example3.svg)



The new style can of course also be used in conjunction with others:



```go

cfmt.Println("This is a {{red color}}::code|bold")

```



![](doc/example4.svg)



Also you can do whatever you want with the text, which is styled.



```go

cfmt.RegisterStyle("flag", func(s string) string {

    return cfmt.Sprintf("{{--%s}}::green (-%c)", s, s[0])

})

```



```go

flag := "help"

cfmt.Println("{{%s}}::flag ", flag)

```



![](doc/example8.svg)



### HEX colors



If the standard colors are not enough for you, then you can use the colors in the `HEX` format (*NOTE: not all terminals support all colors fully!*).



```go

cfmt.Println("This is a {{red color}}::#ff0000")

```



### Background color



To set the background color, you need to add the prefix `bg` to the color, in the case of standard colors, the first letter of the color must be capitalized:



```go

cfmt.Println("This is a {{red color}}::bgRed")

```



For `HEX` it will look like this:



```go

cfmt.Println("This is a {{red color}}::bg#ff0000")

```



## Other examples



```go

cfmt.RegisterStyle("code", func(s string) string {

	return cfmt.Sprintf("{{%s}}::red|underline", s)

})



cfmt.Printf(`

    {{Example of reports}}::bold



    {{                                                                            }}::bgRed

    {{                            Critical errors found                           }}::bgRed|#ffffff

    {{                                                                            }}::bgRed



    {{100}}::#ffffff myStyle := color.{{New(color.FgWhite, color.BgBlack, color.OpBold)}}::code|bold

        {{[100, 17]}}::blue Undefined function New at {{~/projects/test}}::underline:100



    {{101}}::#ffffff {{myStyle}}::code.Print("t")

        {{[101, 0]}}::blue Undefined variable myStyle at {{~/projects/test}}::underline:101

`)

```



![](doc/example6.png)



```go

cfmt.Print(`

        {{                 -/+:.          }}::green

        {{                :++++.          }}::green

        {{               /+++/.           }}::green

        {{       .:-::- .+/:-''.::-       }}::green

        {{    .:/++++++/::::/++++++//:    }}::green

        {{  .:///////////////////////:    }}::yellow

        {{  ////////////////////////      }}::yellow

        {{ -+++++++++++++++++++++++       }}::red

        {{ /++++++++++++++++++++++/       }}::red

        {{ /sssssssssssssssssssssss.      }}::red

        {{ :ssssssssssssssssssssssss-     }}::red

        {{  osssssssssssssssssssssssso/   }}::magenta

        {{   syyyyyyyyyyyyyyyyyyyyyyyy+   }}::magenta

        {{    ossssssssssssssssssssss/    }}::blue

        {{      :ooooooooooooooooooo+.    }}::blue

        {{       :+oo+/:-..-:/+o+/-       }}::blue

`)

```



![](doc/example7.svg)



## Supported colors and styles



| Styles               |

| -------------------- |

| *italic*             |

| **bold**             |

| ~~crossout~~         |

| underline |

| concealed            |

| reverse              |

| blink                |



| Colors  |              |               |           |

| ------- | ------------ | ------------- | --------- |

| black   | darkGray     | bgDarkGray    | bgBlack   |

| red     | lightRed     | bgLightRed    | bgRed     |

| green   | lightGreen   | bgLightGreen  | bgGreen   |

| yellow  | lightYellow  | bgLightYellow | bgYellow  |

| blue    | lightBlue    | bgLightBlue   | bgBlue    |

| magenta | lightMagenta | bgLightMagent | bgMagenta |

| cyan    | lightCyan    | bgLightCyan   | bgCyan    |

| white   | lightWhite   | bgLightWhite  | bgWhite   |

| gray    |              |               | bgGray    |



And colors in HEX format. See [HEX colors](#hex-colors) part.



## Motivation



The existing libraries for styling the output are very powerful and this library builds on one of them ([gookit/color](https://github.com/gookit/color)). However, they are not very useful for styling certain words or sentences, since you need to use `Sprintf` and put the styled ones in a format string, which greatly reduces readability if you need to style many elements.



I believe that the library will be useful primarily for formatting ready-made text, for reference, or examples. However, in other cases, it should be just as convenient.



The library aims to make formatted text look readable in code, even with complex formatting.



## Contact



 For any questions — tg: `@petr_makhnev`.



## License



This project is under the **MIT License**. See the [LICENSE](https://github.com/i582/phpstats/blob/master/LICENSE) file for the full license text.