Refactor cli (#1240)

* refactor: refactor cmds

* refactor: fix a lint error

Author: suzuki-shunsuke

cmd/aqua-registry/main.go

@@ -11,6 +11,7 @@ import (
 	"github.com/aquaproj/registry-tool/pkg/runtime"
 	"github.com/sirupsen/logrus"
 	"github.com/suzuki-shunsuke/logrus-error/logerr"
+	"github.com/suzuki-shunsuke/urfave-cli-v3-util/urfave"
 )
 
 var (
@@ -22,25 +23,17 @@ var (
 func main() {
 	rt := runtime.New()
 	logE := log.New(rt, version)
-	if err := core(logE, rt); err != nil {
+	if err := core(logE); err != nil {
 		logerr.WithError(logE, err).Fatal("aqua failed")
 	}
 }
 
-func core(logE *logrus.Entry, rt *runtime.Runtime) error {
-	runner := cli.Runner{
-		Stdin:  os.Stdin,
-		Stdout: os.Stdout,
-		Stderr: os.Stderr,
-		LDFlags: &cli.LDFlags{
-			Version: version,
-			Commit:  commit,
-			Date:    date,
-		},
-		LogE:    logE,
-		Runtime: rt,
-	}
+func core(logE *logrus.Entry) error {
 	ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
 	defer stop()
-	return runner.Run(ctx, os.Args...) //nolint:wrapcheck
+	return cli.Run(ctx, logE, &urfave.LDFlags{ //nolint:wrapcheck
+		Version: version,
+		Commit:  commit,
+		Date:    date,
+	}, os.Args...)
 }

go.mod

@@ -9,8 +9,8 @@ require (
 	github.com/sirupsen/logrus v1.9.3
 	github.com/spf13/afero v1.14.0
 	github.com/suzuki-shunsuke/logrus-error v0.1.4
-	github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.3
-	github.com/urfave/cli/v3 v3.2.0
+	github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.4
+	github.com/urfave/cli/v3 v3.3.2
 	gopkg.in/yaml.v2 v2.4.0
 	gopkg.in/yaml.v3 v3.0.1
 )

go.sum

@@ -109,14 +109,14 @@ github.com/suzuki-shunsuke/go-osenv v0.1.0 h1:hBQ7yaeO1WBZsEWuDj1wrOWF+N7HSWSOpE
 github.com/suzuki-shunsuke/go-osenv v0.1.0/go.mod h1:ZlSVi4kYvV51JEtYpdHh9hAxXKLOWExXel3Jo74aacQ=
 github.com/suzuki-shunsuke/logrus-error v0.1.4 h1:nWo98uba1fANHdZ9Y5pJ2RKs/PpVjrLzRp5m+mRb9KE=
 github.com/suzuki-shunsuke/logrus-error v0.1.4/go.mod h1:WsVvvw6SKSt08/fB2qbnsKIMJA4K1MYCUprqsBJbMiM=
-github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.3 h1:WlB8FC2BH3uVsDoPug7wIFdkb+aAlaKpp07H6x/GjFg=
-github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.3/go.mod h1:B/O/TfFHRZoSeFqZHgwIRf4aWhZiIU46A+UK4ThS2sQ=
+github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.4 h1:cwI1g8vDJZnH/A8Pfc4Vkuc6MIcO4eulf1qiFHYbLB4=
+github.com/suzuki-shunsuke/urfave-cli-v3-util v0.0.4/go.mod h1:XzvaaJ7L21jH7CqwZj4FlYCRJYqiEUHMqiFp54je7/M=
 github.com/therootcompany/xz v1.0.1 h1:CmOtsn1CbtmyYiusbfmhmkpAAETj0wBIH6kCYaX+xzw=
 github.com/therootcompany/xz v1.0.1/go.mod h1:3K3UH1yCKgBneZYhuQUvJ9HPD19UEXEI0BWbMn8qNMY=
 github.com/ulikunitz/xz v0.5.12 h1:37Nm15o69RwBkXM0J6A5OlE67RZTfzUxTj8fB3dfcsc=
 github.com/ulikunitz/xz v0.5.12/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14=
-github.com/urfave/cli/v3 v3.2.0 h1:m8WIXY0U9LCuUl5r+0fqLWDhNYWt6qvlW+GcF4EoXf8=
-github.com/urfave/cli/v3 v3.2.0/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
+github.com/urfave/cli/v3 v3.3.2 h1:BYFVnhhZ8RqT38DxEYVFPPmGFTEf7tJwySTXsVRrS/o=
+github.com/urfave/cli/v3 v3.3.2/go.mod h1:FJSKtM/9AiiTOJL4fJ6TbMUkxBXn7GO9guZqoZtpYpo=
 github.com/wk8/go-ordered-map/v2 v2.1.8 h1:5h/BUHu93oj4gIdvHHHGsScSTMijfx5PeYkE/fJgbpc=
 github.com/wk8/go-ordered-map/v2 v2.1.8/go.mod h1:5nJHM5DyteebpVlHnWMV0rPz6Zp7+xBAnxjb1X5vnTw=
 go4.org v0.0.0-20230225012048-214862532bf5 h1:nifaUDeh+rPaBCMPMQHZmvJf+QdpLFnuQPwx+LxVmtc=

pkg/cli/check_repo.go renamed to pkg/cli/checkrepo/command.go

@@ -1,4 +1,4 @@
-package cli
+package checkrepo
 
 import (
 	"context"
@@ -9,7 +9,14 @@ import (
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newCheckRepoCommand() *cli.Command {
+type runner struct{}
+
+func Command() *cli.Command {
+	r := &runner{}
+	return r.Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:      "check-repo",
 		Usage:     `Check if GitHub Repository was transferred`,
@@ -22,12 +29,12 @@ e.g.
 $ aqua-registry check-repo Azure/aztfy
 Azure/aztfexport
 `,
-		Action: r.checkRepoAction,
+		Action: r.action,
 		Flags:  []cli.Flag{},
 	}
 }
 
-func (r *Runner) checkRepoAction(ctx context.Context, cmd *cli.Command) error {
+func (r *runner) action(ctx context.Context, cmd *cli.Command) error {
 	return checkrepo.CheckRepo( //nolint:wrapcheck
 		ctx, afero.NewOsFs(), &http.Client{
 			CheckRedirect: func(_ *http.Request, _ []*http.Request) error {

pkg/cli/completion.go

@@ -1,13 +1,22 @@
-package cli
+package createprnewpkg
 
 import (
 	"context"
 
 	newpkg "github.com/aquaproj/registry-tool/pkg/create-pr-new-pkg"
+	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newCreatePRNewPkgCommand() *cli.Command {
+type runner struct {
+	logE *logrus.Entry
+}
+
+func Command(logE *logrus.Entry) *cli.Command {
+	return (&runner{logE: logE}).Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:      "create-pr-new-pkg",
 		Usage:     `Create a pull request to add new packages`,
@@ -25,10 +34,10 @@ This tool does the following things.
 3. Push the commit to origin
 4. Open a web browser to create a request with GitHub CLI
 `,
-		Action: r.createPRNewPkgAction,
+		Action: r.action,
 	}
 }
 
-func (r *Runner) createPRNewPkgAction(ctx context.Context, cmd *cli.Command) error {
-	return newpkg.CreatePRNewPkgs(ctx, r.LogE, cmd.Args().Slice()...) //nolint:wrapcheck
+func (r *runner) action(ctx context.Context, cmd *cli.Command) error {
+	return newpkg.CreatePRNewPkgs(ctx, r.logE, cmd.Args().Slice()...) //nolint:wrapcheck
 }

pkg/cli/create_pr_new_pkg.go renamed to pkg/cli/createprnewpkg/command.go

@@ -1,4 +1,4 @@
-package cli
+package gengr
 
 import (
 	"context"
@@ -7,7 +7,13 @@ import (
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newGenerateRegistryCommand() *cli.Command {
+type runner struct{}
+
+func Command() *cli.Command {
+	return (&runner{}).Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:      "generate-registry",
 		Aliases:   []string{"gr"},
@@ -20,10 +26,10 @@ Don't edit it manually, and if you update registry.yaml in the pkgs directory, d
 
 No argument is needed.
 `,
-		Action: r.generateRegistryAction,
+		Action: r.action,
 	}
 }
 
-func (r *Runner) generateRegistryAction(context.Context, *cli.Command) error {
+func (r *runner) action(context.Context, *cli.Command) error {
 	return genrg.GenerateRegistry() //nolint:wrapcheck
 }

pkg/cli/generate_registry.go renamed to pkg/cli/gengr/command.go

@@ -1,4 +1,4 @@
-package cli
+package initcmd
 
 import (
 	"context"
@@ -7,7 +7,13 @@ import (
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newInitCommand() *cli.Command {
+type runner struct{}
+
+func Command() *cli.Command {
+	return (&runner{}).Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:      "init",
 		Usage:     `Create configuration files`,
@@ -17,10 +23,10 @@ func (r *Runner) newInitCommand() *cli.Command {
 * aqua.yaml
 * aqua-dev.yaml
 `,
-		Action: r.initAction,
+		Action: r.action,
 	}
 }
 
-func (r *Runner) initAction(ctx context.Context, _ *cli.Command) error {
+func (r *runner) action(ctx context.Context, _ *cli.Command) error {
 	return initcmd.Init(ctx) //nolint:wrapcheck
 }

pkg/cli/init.go renamed to pkg/cli/initcmd/command.go

@@ -1,4 +1,4 @@
-package cli
+package mv
 
 import (
 	"context"
@@ -9,17 +9,23 @@ import (
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newMVCommand() *cli.Command {
+type runner struct{}
+
+func Command() *cli.Command {
+	return (&runner{}).Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:        "mv",
 		Usage:       `Rename a package`,
 		UsageText:   `$ aqua-registry mv <old package name> <new package name>`,
 		Description: `Rename a package.`,
-		Action:      r.moveAction,
+		Action:      r.action,
 	}
 }
 
-func (r *Runner) moveAction(ctx context.Context, cmd *cli.Command) error {
+func (r *runner) action(ctx context.Context, cmd *cli.Command) error {
 	args := cmd.Args().Slice()
 	if len(args) != 2 { //nolint:mnd
 		return errors.New("invalid arguments")

pkg/cli/mv.go renamed to pkg/cli/mv/command.go

@@ -1,13 +1,22 @@
-package cli
+package patchchecksum
 
 import (
 	"context"
 
 	"github.com/aquaproj/registry-tool/pkg/patchchecksum"
+	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v3"
 )
 
-func (r *Runner) newPatchChecksumCommand() *cli.Command {
+type runner struct {
+	logE *logrus.Entry
+}
+
+func Command(logE *logrus.Entry) *cli.Command {
+	return (&runner{logE: logE}).Command()
+}
+
+func (r *runner) Command() *cli.Command {
 	return &cli.Command{
 		Name:      "patch-checksum",
 		Usage:     `Patch a checksum configuration`,
@@ -18,10 +27,10 @@ e.g.
 
 $ aqua-registry patch-checksum pkgs/suzuki-shunsuke/tfcmt/registry.yaml
 `,
-		Action: r.patchChecksumAction,
+		Action: r.action,
 	}
 }
 
-func (r *Runner) patchChecksumAction(ctx context.Context, cmd *cli.Command) error {
-	return patchchecksum.PatchChecksum(ctx, r.LogE, cmd.Args().First()) //nolint:wrapcheck
+func (r *runner) action(ctx context.Context, cmd *cli.Command) error {
+	return patchchecksum.PatchChecksum(ctx, r.logE, cmd.Args().First()) //nolint:wrapcheck
 }