Rename Cmd to Command

Creates better parity with cobra, plus my
original rationale for using Cmd is a bit flawed
as the semantics of a serpent command are nothing
alike a go std lib Cmd.

Author: ammario

README.md

@@ -30,7 +30,7 @@ import (
 
 func main() {
 	var upper bool
-	cmd := serpent.Cmd{
+	cmd := serpent.Command{
 		Use:   "echo <text>",
 		Short: "Prints the given text to the console.",
 		Options: serpent.OptionSet{
@@ -86,7 +86,7 @@ type Option struct {
 }
 ```
 
-And is used by each [Cmd](https://pkg.go.dev/github.com/coder/serpent#Cmd) when
+And is used by each [Command](https://pkg.go.dev/github.com/coder/serpent#Command) when
 passed as an array to the `Options` field.
 
 ## More coming...

cmd.go renamed to command.go

@@ -21,14 +21,16 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-// Cmd describes an executable command.
-type Cmd struct {
+// Command describes an executable command.
+type Command struct {
 	// Parent is the direct parent of the command.
 	//
 	// It is set automatically when an invokation runs.
-	Parent *Cmd
+	Parent *Command
+
 	// Children is a list of direct descendants.
-	Children []*Cmd
+	Children []*Command
+
 	// Use is provided in form "command [flags] [args...]".
 	Use string
 
@@ -61,15 +63,15 @@ type Cmd struct {
 
 // AddSubcommands adds the given subcommands, setting their
 // Parent field automatically.
-func (c *Cmd) AddSubcommands(cmds ...*Cmd) {
+func (c *Command) AddSubcommands(cmds ...*Command) {
 	for _, cmd := range cmds {
 		cmd.Parent = c
 		c.Children = append(c.Children, cmd)
 	}
 }
 
 // Walk calls fn for the command and all its children.
-func (c *Cmd) Walk(fn func(*Cmd)) {
+func (c *Command) Walk(fn func(*Command)) {
 	fn(c)
 	for _, child := range c.Children {
 		child.Parent = c
@@ -87,7 +89,7 @@ func ascendingSortFn[T constraints.Ordered](a, b T) int {
 }
 
 // init performs initialization and linting on the command and all its children.
-func (c *Cmd) init() error {
+func (c *Command) init() error {
 	if c.Use == "" {
 		c.Use = "unnamed"
 	}
@@ -121,7 +123,7 @@ func (c *Cmd) init() error {
 	slices.SortFunc(c.Options, func(a, b Option) int {
 		return ascendingSortFn(a.Name, b.Name)
 	})
-	slices.SortFunc(c.Children, func(a, b *Cmd) int {
+	slices.SortFunc(c.Children, func(a, b *Command) int {
 		return ascendingSortFn(a.Name(), b.Name())
 	})
 	for _, child := range c.Children {
@@ -135,13 +137,13 @@ func (c *Cmd) init() error {
 }
 
 // Name returns the first word in the Use string.
-func (c *Cmd) Name() string {
+func (c *Command) Name() string {
 	return strings.Split(c.Use, " ")[0]
 }
 
 // FullName returns the full invocation name of the command,
 // as seen on the command line.
-func (c *Cmd) FullName() string {
+func (c *Command) FullName() string {
 	var names []string
 	if c.Parent != nil {
 		names = append(names, c.Parent.FullName())
@@ -152,7 +154,7 @@ func (c *Cmd) FullName() string {
 
 // FullName returns usage of the command, preceded
 // by the usage of its parents.
-func (c *Cmd) FullUsage() string {
+func (c *Command) FullUsage() string {
 	var uses []string
 	if c.Parent != nil {
 		uses = append(uses, c.Parent.FullName())
@@ -162,7 +164,7 @@ func (c *Cmd) FullUsage() string {
 }
 
 // FullOptions returns the options of the command and its parents.
-func (c *Cmd) FullOptions() OptionSet {
+func (c *Command) FullOptions() OptionSet {
 	var opts OptionSet
 	if c.Parent != nil {
 		opts = append(opts, c.Parent.FullOptions()...)
@@ -175,7 +177,7 @@ func (c *Cmd) FullOptions() OptionSet {
 // stdio discarded.
 //
 // The returned invocation is not live until Run() is called.
-func (c *Cmd) Invoke(args ...string) *Invocation {
+func (c *Command) Invoke(args ...string) *Invocation {
 	return &Invocation{
 		Command: c,
 		Args:    args,
@@ -189,7 +191,7 @@ func (c *Cmd) Invoke(args ...string) *Invocation {
 // Invocation represents an instance of a command being executed.
 type Invocation struct {
 	ctx         context.Context
-	Command     *Cmd
+	Command     *Command
 	parsedFlags *pflag.FlagSet
 	Args        []string
 	// Environ is a list of environment variables. Use EnvsWithPrefix to parse
@@ -291,7 +293,7 @@ func (inv *Invocation) run(state *runState) error {
 
 	// Now the fun part, argument parsing!
 
-	children := make(map[string]*Cmd)
+	children := make(map[string]*Command)
 	for _, child := range inv.Command.Children {
 		child.Parent = inv.Command
 		for _, name := range append(child.Aliases, child.Name()) {
@@ -447,7 +449,7 @@ func (inv *Invocation) run(state *runState) error {
 }
 
 type RunCommandError struct {
-	Cmd *Cmd
+	Cmd *Command
 	Err error
 }
 

cmd_test.go renamed to command_test.go

@@ -33,15 +33,15 @@ func fakeIO(i *serpent.Invocation) *ioBufs {
 func TestCommand(t *testing.T) {
 	t.Parallel()
 
-	cmd := func() *serpent.Cmd {
+	cmd := func() *serpent.Command {
 		var (
 			verbose bool
 			lower   bool
 			prefix  string
 			reqBool bool
 			reqStr  string
 		)
-		return &serpent.Cmd{
+		return &serpent.Command{
 			Use: "root [subcommand]",
 			Options: serpent.OptionSet{
 				serpent.Option{
@@ -55,7 +55,7 @@ func TestCommand(t *testing.T) {
 					Value: serpent.StringOf(&prefix),
 				},
 			},
-			Children: []*serpent.Cmd{
+			Children: []*serpent.Command{
 				{
 					Use:   "required-flag --req-bool=true --req-string=foo",
 					Short: "Example with required flags",
@@ -320,12 +320,12 @@ func TestCommand(t *testing.T) {
 
 func TestCommand_DeepNest(t *testing.T) {
 	t.Parallel()
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use: "1",
-		Children: []*serpent.Cmd{
+		Children: []*serpent.Command{
 			{
 				Use: "2",
-				Children: []*serpent.Cmd{
+				Children: []*serpent.Command{
 					{
 						Use: "3",
 						Handler: func(i *serpent.Invocation) error {
@@ -348,7 +348,7 @@ func TestCommand_FlagOverride(t *testing.T) {
 	t.Parallel()
 	var flag string
 
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use: "1",
 		Options: serpent.OptionSet{
 			{
@@ -357,7 +357,7 @@ func TestCommand_FlagOverride(t *testing.T) {
 				Value: serpent.DiscardValue,
 			},
 		},
-		Children: []*serpent.Cmd{
+		Children: []*serpent.Command{
 			{
 				Use: "2",
 				Options: serpent.OptionSet{
@@ -392,7 +392,7 @@ func TestCommand_MiddlewareOrder(t *testing.T) {
 		}
 	}
 
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use:   "toupper [word]",
 		Short: "Converts a word to upper case",
 		Middleware: serpent.Chain(
@@ -416,8 +416,8 @@ func TestCommand_MiddlewareOrder(t *testing.T) {
 func TestCommand_RawArgs(t *testing.T) {
 	t.Parallel()
 
-	cmd := func() *serpent.Cmd {
-		return &serpent.Cmd{
+	cmd := func() *serpent.Command {
+		return &serpent.Command{
 			Use: "root",
 			Options: serpent.OptionSet{
 				{
@@ -426,7 +426,7 @@ func TestCommand_RawArgs(t *testing.T) {
 					Value: serpent.StringOf(new(string)),
 				},
 			},
-			Children: []*serpent.Cmd{
+			Children: []*serpent.Command{
 				{
 					Use:     "sushi <args...>",
 					Short:   "Throws back raw output",
@@ -480,7 +480,7 @@ func TestCommand_RawArgs(t *testing.T) {
 
 func TestCommand_RootRaw(t *testing.T) {
 	t.Parallel()
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		RawArgs: true,
 		Handler: func(i *serpent.Invocation) error {
 			_, _ = i.Stdout.Write([]byte(strings.Join(i.Args, " ")))
@@ -498,7 +498,7 @@ func TestCommand_RootRaw(t *testing.T) {
 
 func TestCommand_HyphenHyphen(t *testing.T) {
 	t.Parallel()
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: (func(i *serpent.Invocation) error {
 			_, _ = i.Stdout.Write([]byte(strings.Join(i.Args, " ")))
 			return nil
@@ -518,7 +518,7 @@ func TestCommand_ContextCancels(t *testing.T) {
 
 	var gotCtx context.Context
 
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: (func(i *serpent.Invocation) error {
 			gotCtx = i.Context()
 			if err := gotCtx.Err(); err != nil {
@@ -537,8 +537,8 @@ func TestCommand_ContextCancels(t *testing.T) {
 func TestCommand_Help(t *testing.T) {
 	t.Parallel()
 
-	cmd := func() *serpent.Cmd {
-		return &serpent.Cmd{
+	cmd := func() *serpent.Command {
+		return &serpent.Command{
 			Use: "root",
 			HelpHandler: (func(i *serpent.Invocation) error {
 				_, _ = i.Stdout.Write([]byte("abdracadabra"))
@@ -585,9 +585,9 @@ func TestCommand_Help(t *testing.T) {
 func TestCommand_SliceFlags(t *testing.T) {
 	t.Parallel()
 
-	cmd := func(want ...string) *serpent.Cmd {
+	cmd := func(want ...string) *serpent.Command {
 		var got []string
-		return &serpent.Cmd{
+		return &serpent.Command{
 			Use: "root",
 			Options: serpent.OptionSet{
 				{
@@ -614,9 +614,9 @@ func TestCommand_SliceFlags(t *testing.T) {
 func TestCommand_EmptySlice(t *testing.T) {
 	t.Parallel()
 
-	cmd := func(want ...string) *serpent.Cmd {
+	cmd := func(want ...string) *serpent.Command {
 		var got []string
-		return &serpent.Cmd{
+		return &serpent.Command{
 			Use: "root",
 			Options: serpent.OptionSet{
 				{
@@ -667,7 +667,7 @@ func TestCommand_DefaultsOverride(t *testing.T) {
 				got    string
 				config serpent.YAMLConfigPath
 			)
-			cmd := &serpent.Cmd{
+			cmd := &serpent.Command{
 				Options: serpent.OptionSet{
 					{
 						Name:    "url",

example/echo/main.go

@@ -9,7 +9,7 @@ import (
 
 func main() {
 	var upper bool
-	cmd := serpent.Cmd{
+	cmd := serpent.Command{
 		Use:   "echo <text>",
 		Short: "Prints the given text to the console.",
 		Options: serpent.OptionSet{

help.go

@@ -123,10 +123,10 @@ var defaultHelpTemplate = func() *template.Template {
 					}
 					return sb.String()
 				},
-				"rootCommandName": func(cmd *Cmd) string {
+				"rootCommandName": func(cmd *Command) string {
 					return strings.Split(cmd.FullName(), " ")[0]
 				},
-				"formatSubcommand": func(cmd *Cmd) string {
+				"formatSubcommand": func(cmd *Command) string {
 					// Minimize padding by finding the longest neighboring name.
 					maxNameLength := len(cmd.Name())
 					if parent := cmd.Parent; parent != nil {
@@ -205,12 +205,12 @@ var defaultHelpTemplate = func() *template.Template {
 					s = wrapTTY(s)
 					return s
 				},
-				"visibleChildren": func(cmd *Cmd) []*Cmd {
-					return filterSlice(cmd.Children, func(c *Cmd) bool {
+				"visibleChildren": func(cmd *Command) []*Command {
+					return filterSlice(cmd.Children, func(c *Command) bool {
 						return !c.Hidden
 					})
 				},
-				"optionGroups": func(cmd *Cmd) []optionGroup {
+				"optionGroups": func(cmd *Command) []optionGroup {
 					groups := []optionGroup{{
 						// Default group.
 						Name:        "",