feat(cli): bash autocomplete affecting on global flags (#76)

Author: apskhem

cli/cmd/cmds/ci.go

@@ -7,7 +7,7 @@ import (
 
 type CICmd struct {
 Artifact string `short:"a" help:"Dump all produced artifacts to the given path."`
-Path string `arg:"" default:"" help:"The path to scan from."`
+Path string `kong:"arg,predictor=path" default:"" help:"The path to scan from."`
 Platform []string `short:"p" help:"Run the target with the given platform."`
 }
 

cli/cmd/cmds/deploy.go

@@ -8,7 +8,7 @@ import (
 )
 
 type DeployCmd struct {
-Project string `arg:"" help:"The path to the project to deploy."`
+Project string `arg:"" help:"The path to the project to deploy." kong:"arg,predictor=path"`
 }
 
 func (c *DeployCmd) Run(ctx run.RunContext) error {

cli/cmd/cmds/dump.go

@@ -7,7 +7,7 @@ import (
 )
 
 type DumpCmd struct {
-Project string `arg:"" help:"Path to the project."`
+Project string `arg:"" help:"Path to the project." kong:"arg,predictor=path"`
 Pretty bool `help:"Pretty print JSON output."`
 }
 

cli/cmd/cmds/run.go

@@ -7,7 +7,7 @@ import (
 
 type RunCmd struct {
 Artifact string `short:"a" help:"Dump all produced artifacts to the given path."`
-Path string `arg:"" help:"The path to the target to execute (i.e., ./dir1+test)."`
+Path string `kong:"arg,predictor=path" help:"The path to the target to execute (i.e., ./dir1+test)."`
 Platform []string `short:"p" help:"Run the target with the given platform."`
 Pretty bool `help:"Pretty print JSON output."`
 TargetArgs []string `arg:"" help:"Arguments to pass to the target." default:""`

cli/cmd/cmds/scan.go

@@ -18,7 +18,7 @@ type ScanCmd struct {
 Earthfile bool `help:"Return the Earthfile targets for each project."`
 Filter []string `short:"f" help:"Filter Earthfile targets by regular expression or blueprint results by path."`
 Pretty bool `help:"Pretty print JSON output."`
-RootPath string `arg:"" help:"Root path to scan for Earthfiles and their respective targets."`
+RootPath string `kong:"arg,predictor=path" help:"Root path to scan for Earthfiles and their respective targets."`
 }
 
 func (c *ScanCmd) Run(ctx run.RunContext) error {

cli/cmd/cmds/secret.go

@@ -19,13 +19,13 @@ type Get struct {
 Key string `short:"k" help:"The key inside of the secret to get."`
 Project string `help:"Path to a project to use for getting secret configuration."`
 Provider string `short:"p" help:"The provider of the secret store." default:"aws"`
-Path string `arg:"" help:"The path to the secret (or path in a project blueprint if --project is specified)."`
+Path string `kong:"arg,predictor=path" help:"The path to the secret (or path in a project blueprint if --project is specified)."`
 }
 
 type Set struct {
 Field []string `short:"f" help:"A secret field to set."`
 Provider string `short:"p" help:"The provider of the secret store." default:"aws"`
-Path string `arg:"" help:"The path to the secret (or path in a project blueprint if --project is specified)."`
+Path string `kong:"arg,predictor=path" help:"The path to the secret (or path in a project blueprint if --project is specified)."`
 Project string `help:"Path to a project to use for getting secret configuration."`
 Value string `arg:"" help:"The value to set." default:""`
 }

cli/cmd/cmds/tag.go

@@ -8,7 +8,7 @@ import (
 
 type TagCmd struct {
 Pretty bool `short:"p" help:"Pretty print JSON output."`
-Project string `arg:"" help:"The project to generate tags for."`
+Project string `kong:"arg,predictor=path" help:"The project to generate tags for."`
 Trim bool `short:"t" help:"Trim the project path from the git tag."`
 }
 

cli/cmd/cmds/validate.go

@@ -5,7 +5,7 @@ import (
 )
 
 type ValidateCmd struct {
-Project string `arg:"" help:"Path to the project."`
+Project string `kong:"arg,predictor=path" help:"Path to the project."`
 }
 
 func (c *ValidateCmd) Run(ctx run.RunContext) error {

cli/cmd/main.go

@@ -15,23 +15,27 @@ import (
 "github.com/input-output-hk/catalyst-forge/lib/project/schema"
 "github.com/input-output-hk/catalyst-forge/lib/project/secrets"
 "github.com/input-output-hk/catalyst-forge/lib/tools/walker"
+"github.com/posener/complete"
+"github.com/willabides/kongplete"
 )
 
 var version = "dev"
 
 var cli struct {
 cmds.GlobalArgs
 
-Deploy cmds.DeployCmd `cmd:"" help:"Deploy a project."`
-Dump cmds.DumpCmd `cmd:"" help:"Dumps a project's blueprint to JSON."`
-CI cmds.CICmd `cmd:"" help:"Simulate a CI run."`
-Release cmds.ReleaseCmd `cmd:"" help:"Release a project."`
-Run cmds.RunCmd `cmd:"" help:"Run an Earthly target."`
-Scan cmds.ScanCmd `cmd:"" help:"Scan for Earthfiles."`
-Secret cmds.SecretCmd `cmd:"" help:"Manage secrets."`
-Tag cmds.TagCmd `cmd:"" help:"Generate a tag for a project."`
-Validate cmds.ValidateCmd `cmd:"" help:"Validates a project."`
-Version VersionCmd `cmd:"" help:"Print the version."`
+Deploy cmds.DeployCmd `kong:"cmd" help:"Deploy a project."`
+Dump cmds.DumpCmd `kong:"cmd" help:"Dumps a project's blueprint to JSON."`
+CI cmds.CICmd `kong:"cmd" help:"Simulate a CI run."`
+Release cmds.ReleaseCmd `kong:"cmd" help:"Release a project."`
+Run cmds.RunCmd `kong:"cmd" help:"Run an Earthly target."`
+Scan cmds.ScanCmd `kong:"cmd" help:"Scan for Earthfiles."`
+Secret cmds.SecretCmd `kong:"cmd" help:"Manage secrets."`
+Tag cmds.TagCmd `kong:"cmd" help:"Generate a tag for a project."`
+Validate cmds.ValidateCmd `kong:"cmd" help:"Validates a project."`
+Version VersionCmd `kong:"cmd" help:"Print the version."`
+
+InstallCompletions kongplete.InstallCompletions `cmd:"" help:"install shell completions"`
 }
 
 type VersionCmd struct{}
@@ -50,10 +54,22 @@ func (c *VersionCmd) Run() error {
 
 // Run is the entrypoint for the CLI tool.
 func Run() int {
-ctx := kong.Parse(&cli,
+cliArgs := os.Args[1:]
+
+parser := kong.Must(&cli,
 kong.Name("forge"),
 kong.Description("The CLI tool powering Catalyst Forge"))
 
+kongplete.Complete(parser,
+kongplete.WithPredictor("path", complete.PredictFiles("*")),
+)
+
+ctx, err := parser.Parse(cliArgs)
+if err != nil {
+fmt.Fprintf(os.Stderr, "forge: %v\n", err)
+return 1
+}
+
 handler := log.New(os.Stderr)
 switch cli.Verbose {
 case 0:
@@ -79,9 +95,8 @@ func Run() int {
 }
 ctx.Bind(runctx)
 
-err := ctx.Run()
-if err != nil {
-fmt.Fprintf(os.Stderr, "forge: %v", err)
+if err := ctx.Run(); err != nil {
+fmt.Fprintf(os.Stderr, "forge: %v\n", err)
 return 1
 }
 

cli/go.mod

@@ -15,9 +15,11 @@ require (
 github.com/input-output-hk/catalyst-forge/lib/project v0.0.0
 github.com/input-output-hk/catalyst-forge/lib/tools v0.0.0
 github.com/migueleliasweb/go-github-mock v1.0.1
+github.com/posener/complete v1.2.3
 github.com/rogpeppe/go-internal v1.12.1-0.20240709150035-ccf4b4329d21
 github.com/spf13/afero v1.11.0
 github.com/stretchr/testify v1.9.0
+github.com/willabides/kongplete v0.4.0
 golang.org/x/exp v0.0.0-20231006140011-7918f672742d
 )
 
@@ -59,6 +61,8 @@ require (
 github.com/google/go-querystring v1.1.0 // indirect
 github.com/google/uuid v1.6.0 // indirect
 github.com/gorilla/mux v1.8.0 // indirect
+github.com/hashicorp/errwrap v1.1.0 // indirect
+github.com/hashicorp/go-multierror v1.1.1 // indirect
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
 github.com/kevinburke/ssh_config v1.2.0 // indirect
 github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
@@ -72,6 +76,7 @@ require (
 github.com/pkg/errors v0.9.1 // indirect
 github.com/pmezard/go-difflib v1.0.0 // indirect
 github.com/rivo/uniseg v0.4.7 // indirect
+github.com/riywo/loginshell v0.0.0-20200815045211-7d26008be1ab // indirect
 github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
 github.com/skeema/knownhosts v1.2.2 // indirect
 github.com/xanzy/ssh-agent v0.3.3 // indirect