1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
---
**[Cobra](https://github.com/spf13/cobra)** library for creating powerful modern CLI doesn't support color settings for console output. `ColoredCobra` is a small library that allows you to colorize the text output of the Cobra library, making the console output look better.
`ColoredCobra` provides very simple set of settings that allows you to customize individual parts of Cobra text output by specifying a color for them, as well as bold, italic, underlined styles.
It's very easy to add `ColoredCobra` to your project!
---
## Installing
Open terminal and execute:
```bash
go get -u github.com/ivanpirog/coloredcobra
```
## Quick start
Open your `cmd/root.go` and insert this code:
```go
import cc "github.com/ivanpirog/coloredcobra"
```
Or:
```go
import (
...
cc "github.com/ivanpirog/coloredcobra"
)
```
Then put this code at the beginning of the `Execute()` function:
```go
cc.Init(&cc.Config{
RootCmd: rootCmd,
Headings: cc.HiCyan + cc.Bold + cc.Underline,
Commands: cc.HiYellow + cc.Bold,
Example: cc.Italic,
ExecName: cc.Bold,
Flags: cc.Bold,
})
```
That's all. Now build your project and see the output of the help command.
## Overview
`Config{}` has just one required parameter `RootCmd`. This is a pointer to the Cobra's root command. Rest of parameters have default values.
Style of any part of text output is represented by a sum of predefined constants. For example:
```go
Headings: cc.HiYellow + cc.Bold + cc.Underline
Commands: cc.Red + cc.Bold
ExecName: cc.Bold // equals cc.White + cc.Bold
Example: cc.Underline // equals cc.White + cc.Underline
```
### Available color constants:
```
Black
Red
Green
Yellow
Blue
Magenta
Cyan
White (default)
HiRed (Hi-Intensity Red)
HiGreen
HiYellow
HiBlue
HiMagenta
HiCyan
HiWhite
```
### Available text formatting constants:
```
Bold
Italic
Underline
```
### Available config parameters:
* `Headings:` headers style.
* `Commands:` commands style.
* `CmdShortDescr:` short description of commands style.
* `ExecName:` executable name style.
* `Flags:` short and long flag names (-f, --flag) style.
* `FlagsDataType:` style of flags data type.
* `FlagsDescr:` flags description text style.
* `Aliases:` list of command aliases style.
* `Example:` example text style.
* `NoExtraNewlines:` no line breaks before and after headings, if `true`. By default: `false`.
* `NoBottomNewline:` no line break at the end of Cobra's output, if `true`. By default: `false`.
<br>
### `NoExtraNewlines` parameter results:
## How it works
`ColoredCobra` patches Cobra's usage template and extends it with functions for text styling. [fatih/color](https://github.com/fatih/color) library is used for coloring text output in console.
## License
ColoredCobra is released under the MIT license. See [LICENSE](https://github.com/ivanpirog/coloredcobra/blob/main/LICENSE).
|
