Repository navigation
Expand file tree
/
Copy pathfang.go
More file actions
234 lines (204 loc) · 5.43 KB
/
Copy pathfang.go
File metadata and controls
234 lines (204 loc) · 5.43 KB
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
// Package fang provides styling for cobra commands.
package fang
import (
"context"
"fmt"
"io"
"os"
"os/signal"
"runtime/debug"
"charm.land/lipgloss/v2"
"github.com/charmbracelet/colorprofile"
mango "github.com/muesli/mango-cobra"
"github.com/muesli/roff"
"github.com/spf13/cobra"
)
const shaLen = 7
// ErrorHandler handles an error, printing them to the given [io.Writer].
type ErrorHandler = func(w io.Writer, styles Styles, err error)
// HelpContext contains styling and writer helpers for custom help rendering.
type HelpContext struct {
Writer *colorprofile.Writer
Styles Styles
Width int
}
// HelpRenderer renders command help using Fang styling primitives.
type HelpRenderer func(cmd *cobra.Command, ctx HelpContext)
// ColorSchemeFunc gets a [lipgloss.LightDarkFunc] and returns a [ColorScheme].
type ColorSchemeFunc = func(lipgloss.LightDarkFunc) ColorScheme
type settings struct {
completions bool
manpages bool
skipVersion bool
version string
commit string
colorscheme ColorSchemeFunc
errHandler ErrorHandler
helpRenderer HelpRenderer
signals []os.Signal
}
// Option changes fang settings.
type Option func(*settings)
// WithoutCompletions disables completions.
func WithoutCompletions() Option {
return func(s *settings) {
s.completions = false
}
}
// WithoutManpage disables man pages.
func WithoutManpage() Option {
return func(s *settings) {
s.manpages = false
}
}
// WithColorSchemeFunc sets a function that return colorscheme.
func WithColorSchemeFunc(cs ColorSchemeFunc) Option {
return func(s *settings) {
s.colorscheme = cs
}
}
// WithTheme sets the colorscheme.
//
// Deprecated: use [WithColorSchemeFunc] instead.
func WithTheme(theme ColorScheme) Option {
return func(s *settings) {
s.colorscheme = func(lipgloss.LightDarkFunc) ColorScheme {
return theme
}
}
}
// WithVersion sets the version.
func WithVersion(version string) Option {
return func(s *settings) {
s.version = version
}
}
// WithoutVersion skips the `-v`/`--version` functionality.
func WithoutVersion() Option {
return func(s *settings) {
s.skipVersion = true
}
}
// WithCommit sets the commit SHA.
func WithCommit(commit string) Option {
return func(s *settings) {
s.commit = commit
}
}
// WithErrorHandler sets the error handler.
func WithErrorHandler(handler ErrorHandler) Option {
return func(s *settings) {
s.errHandler = handler
}
}
// WithHelpRenderer sets a custom help renderer.
func WithHelpRenderer(renderer HelpRenderer) Option {
return func(s *settings) {
s.helpRenderer = renderer
}
}
// WithNotifySignal sets the signals that should interrupt the execution of the
// program.
func WithNotifySignal(signals ...os.Signal) Option {
return func(s *settings) {
s.signals = signals
}
}
// Execute applies fang to the command and executes it.
func Execute(ctx context.Context, root *cobra.Command, options ...Option) error {
opts := settings{
manpages: true,
completions: true,
colorscheme: DefaultColorScheme,
errHandler: DefaultErrorHandler,
}
for _, option := range options {
option(&opts)
}
// Enable VT processing on Windows, otherwise, ANSI escape sequences might not work on older
// Windows versions. This is a no-op on other platforms.
for _, w := range []io.Writer{root.OutOrStdout(), root.ErrOrStderr()} {
// if we can't enable VT processing, just ignore it and continue
// without it.
_ = enableVirtualTerminalProcessing(w)
}
helpFunc := func(c *cobra.Command, _ []string) {
helpCtx := HelpContext{
Writer: colorprofile.NewWriter(c.OutOrStdout(), os.Environ()),
Styles: makeStyles(mustColorscheme(opts.colorscheme)),
Width: width(),
}
if opts.helpRenderer != nil {
opts.helpRenderer(c, helpCtx)
return
}
helpFn(c, helpCtx)
}
root.SilenceUsage = true
root.SilenceErrors = true
if !opts.skipVersion {
root.Version = buildVersion(opts)
}
root.SetHelpFunc(helpFunc)
if opts.manpages {
root.AddCommand(&cobra.Command{
Use: "man",
Short: "Generates manpages",
SilenceUsage: true,
DisableFlagsInUseLine: true,
Hidden: true,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, _ []string) error {
page, err := mango.NewManPage(1, cmd.Root())
if err != nil {
//nolint:wrapcheck
return err
}
_, err = fmt.Fprint(os.Stdout, page.Build(roff.NewDocument()))
//nolint:wrapcheck
return err
},
})
}
if !opts.completions {
root.CompletionOptions.DisableDefaultCmd = true
}
if len(opts.signals) > 0 {
var cancel context.CancelFunc
ctx, cancel = signal.NotifyContext(ctx, opts.signals...)
defer cancel()
}
if err := root.ExecuteContext(ctx); err != nil {
w := colorprofile.NewWriter(root.ErrOrStderr(), os.Environ())
opts.errHandler(w, makeStyles(mustColorscheme(opts.colorscheme)), err)
return err //nolint:wrapcheck
}
return nil
}
func buildVersion(opts settings) string {
commit := opts.commit
version := opts.version
if version == "" {
if info, ok := debug.ReadBuildInfo(); ok && info.Main.Sum != "" {
version = info.Main.Version
commit = getKey(info, "vcs.revision")
} else {
version = "unknown (built from source)"
}
}
if len(commit) >= shaLen {
version += " (" + commit[:shaLen] + ")"
}
return version
}
func getKey(info *debug.BuildInfo, key string) string {
if info == nil {
return ""
}
for _, iter := range info.Settings {
if iter.Key == key {
return iter.Value
}
}
return ""
}