Repository navigation
Expand file tree
/
Copy pathman.go
More file actions
128 lines (110 loc) 路 3.24 KB
/
Copy pathman.go
File metadata and controls
128 lines (110 loc) 路 3.24 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
package main
import (
"fmt"
"os"
"strings"
"github.com/charmbracelet/glamour"
"github.com/mattn/go-isatty"
mcobra "github.com/muesli/mango-cobra"
"github.com/muesli/roff"
"github.com/spf13/cobra"
)
// We use this special character to represent the character that delimits the
// important symbols in the text. We replace these to code in markdown and bold
// in roff.
const specialChar = "%"
var (
manDescription = `VHS let's you write terminal GIFs as code.
VHS reads .tape files and renders GIFs (videos).
A tape file is a script made up of commands describing what actions to perform in the render.
The following is a list of all possible commands in VHS:
* %Output% <path>.(gif|webm|mp4)
* %Require% <program>
* %Set% <setting> <value>
* %Sleep% <time>
* %Type% "<string>"
* %Ctrl%+<key>
* %Backspace% [repeat]
* %Down% [repeat]
* %Enter% [repeat]
* %Left% [repeat]
* %Right% [repeat]
* %Tab% [repeat]
* %Up% [repeat]
* %Hide%
* %Show%
`
manOutput = `The Output command instructs VHS where to save the output of the recording.
File names with the extension %.gif%, %.webm%, %.mp4% will have the respective file types.
`
manSettings = `The Set command allows VHS to adjust settings in the terminal, such as fonts, dimensions, and themes.
The following is a list of all possible setting commands in VHS:
* Set %Shell% <string>
* Set %FontSize% <number>
* Set %FontFamily% <string>
* Set %Height% <number>
* Set %Width% <number>
* Set %LetterSpacing% <float>
* Set %LineHeight% <float>
* Set %TypingSpeed% <time>
* Set %Theme% <json|string>
* Set %Padding% <number>
* Set %Framerate% <number>
* Set %PlaybackSpeed% <float>
`
manBugs = "See GitHub Issues: <https://github.com/charmbracelet/vhs/issues>"
manAuthor = "Charm <vt100@charm.sh>"
)
var manCmd = &cobra.Command{
Use: "manual",
Aliases: []string{"man"},
Short: "Generate man pages",
Args: cobra.NoArgs,
Hidden: true,
RunE: func(cmd *cobra.Command, args []string) error {
if isatty.IsTerminal(os.Stdout.Fd()) {
renderer, err := glamour.NewTermRenderer(
glamour.WithStyles(GlamourTheme),
)
if err != nil {
return err
}
v, err := renderer.Render(markdownManual())
if err != nil {
return err
}
fmt.Println(v)
return nil
}
manPage, err := mcobra.NewManPage(1, rootCmd)
if err != nil {
return err
}
manPage = manPage.
WithLongDescription(sanitizeSpecial(manDescription)).
WithSection("Output", sanitizeSpecial(manOutput)).
WithSection("Settings", sanitizeSpecial(manSettings)).
WithSection("Bugs", sanitizeSpecial(manBugs)).
WithSection("Author", sanitizeSpecial(manAuthor)).
WithSection("Copyright", "(C) 2021-2022 Charmbracelet, Inc.\n"+
"Released under MIT license.")
fmt.Println(manPage.Build(roff.NewDocument()))
return nil
},
}
func markdownManual() string {
return fmt.Sprint(
"# MANUAL\n", sanitizeMarkdown(manDescription),
"# OUTPUT\n", sanitizeMarkdown(manOutput),
"# SETTING\n", sanitizeMarkdown(manSettings),
"# BUGS\n", manBugs,
"\n# AUTHOR\n", manAuthor,
)
}
func sanitizeMarkdown(s string) string {
return strings.ReplaceAll(strings.ReplaceAll(strings.ReplaceAll(
s, "<", "<"), ">", ">"), specialChar, "`")
}
func sanitizeSpecial(s string) string {
return strings.ReplaceAll(s, specialChar, "")
}