Add the running command to Init

Author: bep

README.md

@@ -16,8 +16,9 @@ type Commander interface {
 	Run(ctx context.Context, cd *Commandeer, args []string) error
 
 	// Init called on all ancestors and the executing command itself, before execution, starting from the root.
-	// This is the place to evaluate flags and set up the command.
-	Init(*Commandeer) error
+	// This is the place to evaluate flags and set up the this Commandeer.
+	// The runner Commandeer holds the currently running command, which will be Init last.
+	Init(this, runner *Commandeer) error
 
 	// WithCobraCommand is called when the cobra command is created.
 	// This is where the flags, short and long description etc. are added.

simplecobra.go

@@ -18,8 +18,9 @@ type Commander interface {
 	Run(ctx context.Context, cd *Commandeer, args []string) error
 
 	// Init called on all ancestors and the executing command itself, before execution, starting from the root.
-	// This is the place to evaluate flags and set up the command.
-	Init(*Commandeer) error
+	// This is the place to evaluate flags and set up the this Commandeer.
+	// The runner Commandeer holds the currently running command, which will be Init last.
+	Init(this, runner *Commandeer) error
 
 	// WithCobraCommand is called when the cobra command is created.
 	// This is where the flags, short and long description etc. are added.
@@ -88,7 +89,7 @@ func (c *Commandeer) init() error {
 	// Init all of them starting from the root.
 	for i := len(ancestors) - 1; i >= 0; i-- {
 		cd := ancestors[i]
-		if err := cd.Command.Init(cd); err != nil {
+		if err := cd.Command.Init(cd, c); err != nil {
 			return err
 		}
 	}
@@ -106,8 +107,12 @@ func (r *runErr) Error() string {
 }
 
 func (c *Commandeer) compile() error {
+	useCommandFlagsArgs := "[command] [flags]"
+	if len(c.commandeers) == 0 {
+		useCommandFlagsArgs = "[flags] [args]"
+	}
 	c.CobraCommand = &cobra.Command{
-		Use: c.Command.Name(),
+		Use: fmt.Sprintf("%s %s", c.Command.Name(), useCommandFlagsArgs),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			if err := c.Command.Run(cmd.Context(), c, args); err != nil {
 				return &runErr{err: err}

simplecobra_test.go

@@ -47,6 +47,8 @@ func TestSimpleCobra(t *testing.T) {
 	c.Assert(tc.persistentFlagName, qt.Equals, "root_persistent")
 	c.Assert(tc.persistentFlagNameC, qt.Equals, "root_persistent_rootCommand_compiled")
 	c.Assert(tc.localFlagNameC, qt.Equals, "root_local_rootCommand_compiled")
+	c.Assert(tc.initRunner, qt.Equals, cd)
+	c.Assert(tc.initThis, qt.Equals, cd)
 
 	// Execute a level 1 command.
 	// This may not be very realistic, but it works. The common use case for a CLI app is to run one command and then exit.
@@ -62,6 +64,8 @@ func TestSimpleCobra(t *testing.T) {
 	c.Assert(tc2.localFlagNameC, qt.Equals, "bar_local_lvl1Command_compiled")
 	c.Assert(tc.persistentFlagName, qt.Equals, "bar_persistent")
 	c.Assert(tc.persistentFlagNameC, qt.Equals, "bar_persistent_rootCommand_compiled")
+	c.Assert(tc2.rootCmd.initRunner, qt.Equals, cd2)
+	c.Assert(tc2.rootCmd.initThis, qt.Equals, cd2.Root)
 
 	// Execute a level 2 command.
 	args = []string{"bar", "baz", "--persistentFlagName", "baz_persistent"}
@@ -73,6 +77,8 @@ func TestSimpleCobra(t *testing.T) {
 	c.Assert(tc3.rootCmd, qt.Equals, rootCmd)
 	c.Assert(tc3.parentCmd, qt.Equals, tc2)
 	c.Assert(tc3.ctx, qt.Equals, ctx)
+	c.Assert(tc3.rootCmd.initRunner, qt.Equals, cd3)
+	c.Assert(tc3.rootCmd.initThis, qt.Equals, cd3.Root)
 
 }
 
@@ -170,7 +176,9 @@ type rootCommand struct {
 	localFlagNameC      string
 
 	// For testing.
-	ctx context.Context
+	ctx        context.Context
+	initThis   *simplecobra.Commandeer
+	initRunner *simplecobra.Commandeer
 
 	// Sub commands.
 	commands []simplecobra.Commander
@@ -180,10 +188,12 @@ func (c *rootCommand) Commands() []simplecobra.Commander {
 	return c.commands
 }
 
-func (c *rootCommand) Init(*simplecobra.Commandeer) error {
+func (c *rootCommand) Init(this, runner *simplecobra.Commandeer) error {
 	c.isInit = true
 	c.persistentFlagNameC = c.persistentFlagName + "_rootCommand_compiled"
 	c.localFlagNameC = c.localFlagName + "_rootCommand_compiled"
+	c.initThis = this
+	c.initRunner = runner
 	return nil
 }
 
@@ -224,10 +234,10 @@ func (c *lvl1Command) Commands() []simplecobra.Commander {
 	return c.commands
 }
 
-func (c *lvl1Command) Init(cd *simplecobra.Commandeer) error {
+func (c *lvl1Command) Init(this, runner *simplecobra.Commandeer) error {
 	c.isInit = true
 	c.localFlagNameC = c.localFlagName + "_lvl1Command_compiled"
-	c.rootCmd = cd.Root.Command.(*rootCommand)
+	c.rootCmd = this.Root.Command.(*rootCommand)
 	return nil
 }
 
@@ -260,10 +270,10 @@ func (c *lvl2Command) Commands() []simplecobra.Commander {
 	return nil
 }
 
-func (c *lvl2Command) Init(cd *simplecobra.Commandeer) error {
+func (c *lvl2Command) Init(this, runner *simplecobra.Commandeer) error {
 	c.isInit = true
-	c.rootCmd = cd.Root.Command.(*rootCommand)
-	c.parentCmd = cd.Parent.Command.(*lvl1Command)
+	c.rootCmd = this.Root.Command.(*rootCommand)
+	c.parentCmd = this.Parent.Command.(*lvl1Command)
 	return nil
 }