fix: remove the annoying tail message shows on every command with -h …

…or --help (gnolang#1490) This PR fixed the tail error message on every command with -h or --help: `error parsing commandline arguments: flag: help requested` Before: ![image](https://github.com/gnolang/gno/assets/25278203/8bc998d6-8d6a-45e0-aeca-7957cc15b96a) After: ![image](https://github.com/gnolang/gno/assets/25278203/a2ab7b5a-0dd2-4bcc-a8d1-49e71e1e3d51) --------- Co-authored-by: Hariom Verma <[email protected]>
moul · Jan 18, 2024 · 0ac3f97 · 0ac3f97
1 parent f3c4f2d
commit 0ac3f97
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 60 deletions.
diff --git a/contribs/gnodev/main.go b/contribs/gnodev/main.go
@@ -59,10 +59,7 @@ additional specified paths.`,
 			return execDev(cfg, args, stdio)
 		})
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		fmt.Fprintf(os.Stderr, "%+v\n", err)
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 func (c *devCfg) RegisterFlags(fs *flag.FlagSet) {
 	fs.StringVar(

diff --git a/contribs/gnokeykc/main.go b/contribs/gnokeykc/main.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -16,11 +15,7 @@ func main() {
 	cmd := client.NewRootCmd(wrappedio)
 	cmd.AddSubCommands(newKcCmd(stdio))
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 type wrappedIO struct {

diff --git a/docs/getting-started/working-with-key-pairs.md b/docs/getting-started/working-with-key-pairs.md
@@ -51,8 +51,6 @@ FLAGS
   -insecure-password-stdin=false                       WARNING! take password from stdin
   -quiet=false                                         suppress output during execution
   -remote 127.0.0.1:26657                              remote node URL
-
-error parsing commandline arguments: flag: help requested
 ```
 
 In this example, the directory where `gnokey` will store working data

diff --git a/gno.land/cmd/genesis/main.go b/gno.land/cmd/genesis/main.go
@@ -3,7 +3,6 @@ package main
 import (
 	"context"
 	"flag"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -13,11 +12,7 @@ func main() {
 	io := commands.NewDefaultIO()
 	cmd := newRootCmd(io)
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func newRootCmd(io commands.IO) *commands.Command {

diff --git a/gno.land/cmd/gnofaucet/main.go b/gno.land/cmd/gnofaucet/main.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -22,9 +21,5 @@ func main() {
 		newServeCmd(),
 	)
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
diff --git a/gno.land/cmd/gnokey/main.go b/gno.land/cmd/gnokey/main.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/gnovm/pkg/gnoenv"
@@ -17,9 +16,5 @@ func main() {
 	}
 
 	cmd := client.NewRootCmdWithBaseConfig(commands.NewDefaultIO(), baseCfg)
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
diff --git a/gno.land/cmd/gnoland/root.go b/gno.land/cmd/gnoland/root.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -13,10 +12,7 @@ import (
 func main() {
 	cmd := newRootCmd(commands.NewDefaultIO())
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func newRootCmd(io commands.IO) *commands.Command {

diff --git a/gno.land/cmd/gnotxsync/main.go b/gno.land/cmd/gnotxsync/main.go
@@ -3,7 +3,6 @@ package main
 import (
 	"context"
 	"flag"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -35,11 +34,7 @@ func main() {
 		newExportCommand(cfg),
 	)
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func (c *config) RegisterFlags(fs *flag.FlagSet) {

diff --git a/gnovm/cmd/gno/main.go b/gnovm/cmd/gno/main.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/commands"
@@ -11,11 +10,7 @@ import (
 func main() {
 	cmd := newGnocliCmd(commands.NewDefaultIO())
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func newGnocliCmd(io commands.IO) *commands.Command {

diff --git a/gnovm/cmd/gno/testdata/gno_precompile/01_no_args.txtar b/gnovm/cmd/gno/testdata/gno_precompile/01_no_args.txtar
@@ -3,4 +3,4 @@
 ! gno precompile
 
 ! stdout .+ 
-stderr 'flag: help requested'
+stderr 'USAGE'
diff --git a/gnovm/cmd/gno/testdata/gno_test/no_args.txtar b/gnovm/cmd/gno/testdata/gno_test/no_args.txtar
@@ -3,4 +3,4 @@
 ! gno test
 
 ! stdout .+ 
-stderr 'flag: help requested'
+stderr 'USAGE'
diff --git a/misc/genproto/genproto.go b/misc/genproto/genproto.go
@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"os"
 
 	"github.com/gnolang/gno/tm2/pkg/amino"
@@ -38,11 +37,7 @@ func main() {
 		execGen,
 	)
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func execGen(_ context.Context, _ []string) error {

diff --git a/misc/goscan/goscan.go b/misc/goscan/goscan.go
@@ -22,11 +22,7 @@ func main() {
 		execScan,
 	)
 
-	if err := cmd.ParseAndRun(context.Background(), os.Args[1:]); err != nil {
-		_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
-
-		os.Exit(1)
-	}
+	cmd.Execute(context.Background(), os.Args[1:])
 }
 
 func execScan(_ context.Context, args []string) error {

diff --git a/tm2/pkg/commands/command.go b/tm2/pkg/commands/command.go
@@ -5,6 +5,7 @@ import (
 	"errors"
 	"flag"
 	"fmt"
+	"os"
 	"strings"
 	"text/tabwriter"
 
@@ -105,6 +106,19 @@ func (c *Command) AddSubCommands(cmds ...*Command) {
 	}
 }
 
+// Execute is a helper function for command entry. It wraps ParseAndRun and
+// handles the flag.ErrHelp error, ensuring that every command with -h or
+// --help won't show an error message:
+// 'error parsing commandline arguments: flag: help requested'
+func (c *Command) Execute(ctx context.Context, args []string) {
+	if err := c.ParseAndRun(ctx, args); err != nil {
+		if !errors.Is(err, flag.ErrHelp) {
+			_, _ = fmt.Fprintf(os.Stderr, "%+v\n", err)
+		}
+		os.Exit(1)
+	}
+}
+
 // ParseAndRun is a helper function that calls Parse and then Run in a single
 // invocation. It's useful for simple command trees that don't need two-phase
 // setup.