Shrink the command interface

Author: bep

cobrakai.go

@@ -4,7 +4,6 @@ import (
 	"context"
 
 	"github.com/spf13/cobra"
-	"github.com/spf13/pflag"
 )
 
 // Executer is the execution entry point.
@@ -17,8 +16,7 @@ type Executer interface {
 type Commander interface {
 	Name() string
 	Run(ctx context.Context, args []string) error
-	AddFlagsLocal(*pflag.FlagSet)
-	AddFlagsPersistent(*pflag.FlagSet)
+	WithCobraCommand(*cobra.Command) error
 }
 
 type root struct {
@@ -56,18 +54,14 @@ type Commandeer struct {
 
 func (c *Commandeer) compile() error {
 	c.CobraCommand = &cobra.Command{
-		Use:   c.Command.Name(),
-		Short: "TODO",
-		Long:  "TODO",
+		Use: c.Command.Name(),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			return c.Command.Run(cmd.Context(), args)
 		},
 	}
-	// There's a LocalFlags set in Cobra which one would believe would be the right place to put these flags,
-	// but that doesn't work and there's several related open issues.
-	// This is how the docs say to do it and also where Hugo puts local flags.
-	c.Command.AddFlagsLocal(c.CobraCommand.Flags())
-	c.Command.AddFlagsPersistent(c.CobraCommand.PersistentFlags())
+
+	// This is where the flags, short and long description etc. are added
+	c.Command.WithCobraCommand(c.CobraCommand)
 
 	// Add commands recursively.
 	for _, cc := range c.commandeers {
@@ -123,16 +117,14 @@ type simpleCommand struct {
 	run  func(ctx context.Context, args []string) error
 }
 
-func (s *simpleCommand) Name() string {
-	return s.name
-}
-
-func (s *simpleCommand) Run(ctx context.Context, args []string) error {
-	return s.run(ctx, args)
+func (c *simpleCommand) Name() string {
+	return c.name
 }
 
-func (s *simpleCommand) AddFlagsLocal(*pflag.FlagSet) {
+func (c *simpleCommand) Run(ctx context.Context, args []string) error {
+	return c.run(ctx, args)
 }
 
-func (s *simpleCommand) AddFlagsPersistent(*pflag.FlagSet) {
+func (c *simpleCommand) WithCobraCommand(cmd *cobra.Command) error {
+	return nil
 }

cobrakai_test.go

@@ -8,7 +8,7 @@ import (
 
 	"github.com/bep/cobrakai"
 	qt "github.com/frankban/quicktest"
-	"github.com/spf13/pflag"
+	"github.com/spf13/cobra"
 )
 
 func TestCobraKai(t *testing.T) {
@@ -95,12 +95,14 @@ func (c *testComand1) Name() string {
 	return c.name
 }
 
-func (c *testComand1) AddFlagsLocal(flags *pflag.FlagSet) {
-	flags.StringVar(&c.localFlagName, "localFlagName", "", "set localFlagName")
-}
+func (c *testComand1) WithCobraCommand(cmd *cobra.Command) error {
+	localFlags := cmd.Flags()
+	persistentFlags := cmd.PersistentFlags()
+
+	localFlags.StringVar(&c.localFlagName, "localFlagName", "", "set localFlagName")
+	persistentFlags.StringVar(&c.persistentFlagName, "persistentFlagName", "", "set persistentFlagName")
 
-func (c *testComand1) AddFlagsPersistent(flags *pflag.FlagSet) {
-	flags.StringVar(&c.persistentFlagName, "persistentFlagName", "", "set persistentFlagName")
+	return nil
 }
 
 type testComand2 struct {
@@ -120,10 +122,8 @@ func (c *testComand2) Name() string {
 	return c.name
 }
 
-func (c *testComand2) AddFlagsLocal(flags *pflag.FlagSet) {
-	flags.StringVar(&c.localFlagName, "localFlagName", "", "set localFlagName for testCommand2")
-}
-
-func (c *testComand2) AddFlagsPersistent(flags *pflag.FlagSet) {
-
+func (c *testComand2) WithCobraCommand(cmd *cobra.Command) error {
+	localFlags := cmd.Flags()
+	localFlags.StringVar(&c.localFlagName, "localFlagName", "", "set localFlagName for testCommand2")
+	return nil
 }

go.mod

@@ -5,7 +5,6 @@ go 1.20
 require (
 	github.com/frankban/quicktest v1.14.2
 	github.com/spf13/cobra v1.7.0
-	github.com/spf13/pflag v1.0.5
 )
 
 require (
@@ -14,5 +13,6 @@ require (
 	github.com/kr/pretty v0.3.0 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/rogpeppe/go-internal v1.6.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
 	golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 // indirect
 )