opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 05:05:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(cli): rename Cmd to Command (#12616)

Browse Source 
I think Command is cleaner and my original decision to use "Cmd"
a mistake.

Plus this creates better parity with cobra.
This commit is contained in:
Ammar Bandukwala
2024-03-17 09:45:26 -05:00
committed by GitHub
parent 2a77580ba6
commit b4c0fa80d8
95 changed files with 313 additions and 311 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/clidocgen/gen.go
+9 -9
View File
@@ -25,8 +25,8 @@ var commandTemplate *template.Template
func init() {
commandTemplate = template.Must(
template.New("command.tpl").Funcs(template.FuncMap{
"visibleSubcommands": func(cmd *serpent.Cmd) []*serpent.Cmd {
var visible []*serpent.Cmd
"visibleSubcommands": func(cmd *serpent.Command) []*serpent.Command {
var visible []*serpent.Command
for _, sub := range cmd.Children {
if sub.Hidden {
continue
@@ -35,7 +35,7 @@ func init() {
}
return visible
},
"visibleOptions": func(cmd *serpent.Cmd) []serpent.Option {
"visibleOptions": func(cmd *serpent.Command) []serpent.Option {
var visible []serpent.Option
for _, opt := range cmd.Options {
if opt.Hidden {
@@ -45,7 +45,7 @@ func init() {
}
return visible
},
"atRoot": func(cmd *serpent.Cmd) bool {
"atRoot": func(cmd *serpent.Command) bool {
return cmd.FullName() == "coder"
},
"newLinesToBr": func(s string) string {
@@ -54,7 +54,7 @@ func init() {
"wrapCode": func(s string) string {
return fmt.Sprintf("<code>%s</code>", s)
},
"commandURI": func(cmd *serpent.Cmd) string {
"commandURI": func(cmd *serpent.Command) string {
return fmtDocFilename(cmd)
},
"fullName": fullName,
@@ -67,14 +67,14 @@ func init() {
)
}
func fullName(cmd *serpent.Cmd) string {
func fullName(cmd *serpent.Command) string {
if cmd.FullName() == "coder" {
return "coder"
}
return strings.TrimPrefix(cmd.FullName(), "coder ")
}
func fmtDocFilename(cmd *serpent.Cmd) string {
func fmtDocFilename(cmd *serpent.Command) string {
if cmd.FullName() == "coder" {
// Special case for index.
return "../cli.md"
@@ -83,7 +83,7 @@ func fmtDocFilename(cmd *serpent.Cmd) string {
return fmt.Sprintf("%s.md", name)
}
func writeCommand(w io.Writer, cmd *serpent.Cmd) error {
func writeCommand(w io.Writer, cmd *serpent.Command) error {
var b strings.Builder
err := commandTemplate.Execute(&b, cmd)
if err != nil {
@@ -112,7 +112,7 @@ func writeCommand(w io.Writer, cmd *serpent.Cmd) error {
return err
}
func genTree(dir string, cmd *serpent.Cmd, wroteLog map[string]*serpent.Cmd) error {
func genTree(dir string, cmd *serpent.Command, wroteLog map[string]*serpent.Command) error {
if cmd.Hidden {
return nil
}
scripts/clidocgen/main.go
+1 -1
View File
@@ -83,7 +83,7 @@ func main() {
root := (&cli.RootCmd{})
// wroteMap indexes file paths to commands.
wroteMap := make(map[string]*serpent.Cmd)
wroteMap := make(map[string]*serpent.Command)
var (
docsDir = filepath.Join(workdir, "docs")