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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
// Copyright © 2019 The Homeport Team
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package neat
import (
"bufio"
"bytes"
"fmt"
"io"
"strings"
colorful "github.com/lucasb-eyer/go-colorful"
"github.com/gonvenience/bunt"
"github.com/gonvenience/term"
)
// BoxStyle represents a styling option for a content box
type BoxStyle func(*boxOptions)
type boxOptions struct {
headlineColor *colorful.Color
contentColor *colorful.Color
headlineStyles []bunt.StyleOption
noClosingEndOfLine bool
noLineWrap bool
}
// HeadlineColor sets the color of the headline text
func HeadlineColor(color colorful.Color) BoxStyle {
return func(options *boxOptions) {
options.headlineColor = &color
}
}
// HeadlineStyle sets the style to be used for the headline text
func HeadlineStyle(style bunt.StyleOption) BoxStyle {
return func(options *boxOptions) {
options.headlineStyles = append(options.headlineStyles, style)
}
}
// ContentColor sets the color of the content text
func ContentColor(color colorful.Color) BoxStyle {
return func(options *boxOptions) {
options.contentColor = &color
}
}
// NoFinalEndOfLine specifies that the rendering does not add a closing linefeed
func NoFinalEndOfLine() BoxStyle {
return func(options *boxOptions) {
options.noClosingEndOfLine = true
}
}
// NoLineWrap disables line wrapping in the content box
func NoLineWrap() BoxStyle {
return func(options *boxOptions) {
options.noLineWrap = true
}
}
// ContentBox creates a string for the terminal where content is printed inside
// a simple box shape.
func ContentBox(headline string, content string, opts ...BoxStyle) string {
var buf bytes.Buffer
Box(&buf, headline, strings.NewReader(content), opts...)
return buf.String()
}
// Box writes the provided content in a simple box shape to given writer
func Box(out io.Writer, headline string, content io.Reader, opts ...BoxStyle) {
var (
beginning = "╭"
prefix = "│"
lastline = "╵"
linewritten = false
)
// Process all provided box style options
options := &boxOptions{}
for _, f := range opts {
f(options)
}
// Apply headline color if it is set
if options.headlineColor != nil {
for _, pointer := range []*string{&beginning, &headline, &prefix, &lastline} {
*pointer = bunt.Style(*pointer,
bunt.Foreground(*options.headlineColor),
)
}
}
// Apply headline styles if they are set
for _, style := range options.headlineStyles {
headline = bunt.Style(headline, style)
}
var processText = func(text string) []string {
if options.noLineWrap {
return []string{text}
}
words := strings.Fields(strings.TrimSpace(text))
if len(words) == 0 {
return []string{text}
}
var (
buf bytes.Buffer
lines = []string{}
lineWidth = term.GetTerminalWidth() - len(prefix)
)
buf.WriteString(words[0])
for _, word := range words[1:] {
if len(word)+1 > lineWidth-buf.Len() {
lines = append(lines, buf.String())
buf.Reset()
buf.WriteString(word)
} else {
fmt.Fprint(&buf, " ", word)
}
}
return append(lines, buf.String())
}
// Process each line of the content and apply styles if necessary
scanner := bufio.NewScanner(content)
for scanner.Scan() {
text := scanner.Text()
if !linewritten {
// Write the headline string including the corner item
fmt.Fprintf(out, "%s %s\n", beginning, headline)
}
for _, line := range processText(text) {
if options.contentColor != nil {
line = bunt.Style(line, bunt.Foreground(*options.contentColor))
}
fmt.Fprintf(out, "%s %s\n", prefix, line)
}
linewritten = true
}
if linewritten {
fmt.Fprint(out, lastline)
// If not configured otherwise, end with a linefeed
if !options.noClosingEndOfLine {
fmt.Fprintln(out)
}
}
}
|
