Merge pull request #9317 from filecoin-project/gstuart/cli-cleanup

chore: cli: cleanup and standardize cli

cli/backup.go

@@ -114,8 +114,8 @@ this command must be within this base path`,
 		},
 		ArgsUsage: "[backup file path]",
 		Action: func(cctx *cli.Context) error {
-			if cctx.Args().Len() != 1 {
-				return xerrors.Errorf("expected 1 argument")
+			if cctx.NArg() != 1 {
+				return IncorrectNumArgs(cctx)
 			}
 
 			if cctx.Bool("offline") {

cli/chain.go

@@ -946,8 +946,8 @@ var ChainBisectCmd = &cli.Command{
 		defer closer()
 		ctx := ReqContext(cctx)
 
-		if cctx.Args().Len() < 4 {
-			return xerrors.New("need at least 4 args")
+		if cctx.NArg() < 4 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		start, err := strconv.ParseUint(cctx.Args().Get(0), 10, 64)
@@ -1312,8 +1312,8 @@ var chainDecodeParamsCmd = &cli.Command{
 		defer closer()
 		ctx := ReqContext(cctx)
 
-		if cctx.Args().Len() != 3 {
-			return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments"))
+		if cctx.NArg() != 3 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		to, err := address.NewFromString(cctx.Args().First())
@@ -1391,8 +1391,8 @@ var chainEncodeParamsCmd = &cli.Command{
 	Action: func(cctx *cli.Context) error {
 		afmt := NewAppFmt(cctx.App)
 
-		if cctx.Args().Len() != 3 {
-			return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments"))
+		if cctx.NArg() != 3 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		method, err := strconv.ParseInt(cctx.Args().Get(1), 10, 64)

cli/client.go

@@ -130,7 +130,7 @@ var clientImportCmd = &cli.Command{
 		ctx := ReqContext(cctx)
 
 		if cctx.NArg() != 1 {
-			return xerrors.New("expected input path as the only arg")
+			return IncorrectNumArgs(cctx)
 		}
 
 		absPath, err := filepath.Abs(cctx.Args().First())
@@ -212,8 +212,8 @@ var clientCommPCmd = &cli.Command{
 		defer closer()
 		ctx := ReqContext(cctx)
 
-		if cctx.Args().Len() != 1 {
-			return fmt.Errorf("usage: commP <inputPath>")
+		if cctx.NArg() != 1 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		ret, err := api.ClientCalcCommP(ctx, cctx.Args().Get(0))
@@ -245,8 +245,8 @@ var clientCarGenCmd = &cli.Command{
 		defer closer()
 		ctx := ReqContext(cctx)
 
-		if cctx.Args().Len() != 2 {
-			return fmt.Errorf("usage: generate-car <inputPath> <outputPath>")
+		if cctx.NArg() != 2 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		ref := lapi.FileRef{
@@ -376,7 +376,7 @@ The minimum value is 518400 (6 months).`,
 		afmt := NewAppFmt(cctx.App)
 
 		if cctx.NArg() != 4 {
-			return xerrors.New(expectedArgsMsg)
+			return IncorrectNumArgs(cctx)
 		}
 
 		// [data, miner, price, dur]

cli/client_retr.go

@@ -289,7 +289,7 @@ Examples:
 	}, retrFlagsCommon...),
 	Action: func(cctx *cli.Context) error {
 		if cctx.NArg() != 2 {
-			return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments"))
+			return IncorrectNumArgs(cctx)
 		}
 
 		if cctx.Bool("car-export-merkle-proof") {
@@ -405,7 +405,7 @@ var clientRetrieveCatCmd = &cli.Command{
 	}, retrFlagsCommon...),
 	Action: func(cctx *cli.Context) error {
 		if cctx.NArg() != 1 {
-			return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments"))
+			return IncorrectNumArgs(cctx)
 		}
 
 		ainfo, err := GetAPIInfo(cctx, repo.FullNode)
@@ -484,7 +484,7 @@ var clientRetrieveLsCmd = &cli.Command{
 	}, retrFlagsCommon...),
 	Action: func(cctx *cli.Context) error {
 		if cctx.NArg() != 1 {
-			return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments"))
+			return IncorrectNumArgs(cctx)
 		}
 
 		ainfo, err := GetAPIInfo(cctx, repo.FullNode)

cli/filplus.go

@@ -61,8 +61,8 @@ var filplusVerifyClientCmd = &cli.Command{
 			return err
 		}
 
-		if cctx.Args().Len() != 2 {
-			return fmt.Errorf("must specify two arguments: address and allowance")
+		if cctx.NArg() != 2 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		target, err := address.NewFromString(cctx.Args().Get(0))
@@ -120,7 +120,7 @@ var filplusVerifyClientCmd = &cli.Command{
 			return err
 		}
 
-		if mwait.Receipt.ExitCode != 0 {
+		if mwait.Receipt.ExitCode.IsError() {
 			return fmt.Errorf("failed to add verified client: %d", mwait.Receipt.ExitCode)
 		}
 
@@ -289,8 +289,8 @@ var filplusSignRemoveDataCapProposal = &cli.Command{
 		},
 	},
 	Action: func(cctx *cli.Context) error {
-		if cctx.Args().Len() != 3 {
-			return fmt.Errorf("must specify three arguments: notary address, client address, and allowance to remove")
+		if cctx.NArg() != 3 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		api, closer, err := GetFullNodeAPI(cctx)

cli/helper.go

@@ -31,6 +31,10 @@ func ShowHelp(cctx *ufcli.Context, err error) error {
 	return &PrintHelpErr{Err: err, Ctx: cctx}
 }
 
+func IncorrectNumArgs(cctx *ufcli.Context) error {
+	return ShowHelp(cctx, fmt.Errorf("incorrect number of arguments, got %d", cctx.NArg()))
+}
+
 func RunApp(app *ufcli.App) {
 	if err := app.Run(os.Args); err != nil {
 		if os.Getenv("LOTUS_DEV") != "" {

cli/mpool.go

@@ -404,7 +404,7 @@ var MpoolReplaceCmd = &cli.Command{
 
 		var from address.Address
 		var nonce uint64
-		switch cctx.Args().Len() {
+		switch cctx.NArg() {
 		case 1:
 			mcid, err := cid.Decode(cctx.Args().First())
 			if err != nil {
@@ -610,8 +610,8 @@ var MpoolConfig = &cli.Command{
 	Usage:     "get or set current mpool configuration",
 	ArgsUsage: "[new-config]",
 	Action: func(cctx *cli.Context) error {
-		if cctx.Args().Len() > 1 {
-			return cli.ShowCommandHelp(cctx, cctx.Command.Name)
+		if cctx.NArg() > 1 {
+			return IncorrectNumArgs(cctx)
 		}
 
 		afmt := NewAppFmt(cctx.App)
@@ -624,7 +624,7 @@ var MpoolConfig = &cli.Command{
 
 		ctx := ReqContext(cctx)
 
-		if cctx.Args().Len() == 0 {
+		if cctx.NArg() == 0 {
 			cfg, err := api.MpoolGetConfig(ctx)
 			if err != nil {
 				return err