updated shell completion

- uses github.com/rsteube/carapace - thus no need for cobra fork anymore - replaced completion_function.go with go callbacks - provides shell completion for bash, elvish, fish, powershell and zsh
yashraj2312 · Aug 20, 2020 · 7bebe48 · 7bebe48
1 parent 6f24bc8
commit 7bebe48
Show file tree

Hide file tree

Showing 41 changed files with 722 additions and 342 deletions.
diff --git a/cmd/ci_lint.go b/cmd/ci_lint.go
@@ -7,6 +7,7 @@ import (
 	"os"
 
 	"github.com/pkg/errors"
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
@@ -35,4 +36,7 @@ var ciLintCmd = &cobra.Command{
 
 func init() {
 	ciCmd.AddCommand(ciLintCmd)
+	carapace.Gen(ciLintCmd).PositionalCompletion(
+		carapace.ActionFiles(".gitlab-ci.yml"),
+	)
 }
diff --git a/cmd/ci_run.go b/cmd/ci_run.go
@@ -7,8 +7,10 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	gitlab "github.com/xanzy/go-gitlab"
+	"github.com/zaquestion/lab/internal/action"
 	"github.com/zaquestion/lab/internal/git"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
@@ -131,14 +133,18 @@ func parseCIVariables(vars []string) (map[string]string, error) {
 }
 
 func init() {
-	ciCreateCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote_branches origin")
 	ciCreateCmd.Flags().StringP("project", "p", "", "Project to create pipeline on")
 	ciCmd.AddCommand(ciCreateCmd)
+	carapace.Gen(ciCreateCmd).PositionalCompletion(
+		action.Remotes(),
+	)
 
-	ciTriggerCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote_branches")
 	ciTriggerCmd.Flags().StringP("project", "p", "", "Project to run pipeline trigger on")
 	ciTriggerCmd.Flags().StringP("token", "t", os.Getenv("CI_JOB_TOKEN"), "Pipeline trigger token, optional if run within GitLabCI")
 	ciTriggerCmd.Flags().StringSliceP("variable", "v", []string{}, "Variables to pass to pipeline")
 
 	ciCmd.AddCommand(ciTriggerCmd)
+	carapace.Gen(ciTriggerCmd).PositionalCompletion(
+		action.RemoteBranches(-1),
+	)
 }
diff --git a/cmd/ci_status.go b/cmd/ci_status.go
@@ -8,8 +8,10 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	gitlab "github.com/xanzy/go-gitlab"
+	"github.com/zaquestion/lab/internal/action"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
 
@@ -91,7 +93,11 @@ lab ci status --wait`,
 }
 
 func init() {
-	ciStatusCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote_branches")
 	ciStatusCmd.Flags().Bool("wait", false, "Continuously print the status and wait to exit until the pipeline finishes. Exit code indicates pipeline status")
 	ciCmd.AddCommand(ciStatusCmd)
+
+	carapace.Gen(ciStatusCmd).PositionalCompletion(
+		action.Remotes(),
+		action.RemoteBranches(0),
+	)
 }
diff --git a/cmd/ci_trace.go b/cmd/ci_trace.go
@@ -12,7 +12,9 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
+	"github.com/zaquestion/lab/internal/action"
 	"github.com/zaquestion/lab/internal/git"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
@@ -106,7 +108,9 @@ func doTrace(ctx context.Context, w io.Writer, pid interface{}, sha, name string
 }
 
 func init() {
-	ciTraceCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	ciTraceCmd.MarkZshCompPositionalArgumentCustom(2, "__lab_completion_remote_branches $words[2]")
 	ciCmd.AddCommand(ciTraceCmd)
+	carapace.Gen(ciTraceCmd).PositionalCompletion(
+		action.Remotes(),
+		action.RemoteBranches(0),
+	)
 }
diff --git a/cmd/ci_view.go b/cmd/ci_view.go
@@ -14,11 +14,13 @@ import (
 	"github.com/gdamore/tcell"
 	"github.com/pkg/errors"
 	"github.com/rivo/tview"
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 
 	"github.com/lunixbochs/vtclean"
 	gitlab "github.com/xanzy/go-gitlab"
 
+	"github.com/zaquestion/lab/internal/action"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
 
@@ -623,7 +625,9 @@ func latestJobs(jobs []*gitlab.Job) []*gitlab.Job {
 }
 
 func init() {
-	ciViewCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	ciViewCmd.MarkZshCompPositionalArgumentCustom(2, "__lab_completion_remote_branches $words[2]")
 	ciCmd.AddCommand(ciViewCmd)
+	carapace.Gen(ciViewCmd).PositionalCompletion(
+		action.Remotes(),
+		action.RemoteBranches(0),
+	)
 }
diff --git a/cmd/completion.go b/cmd/completion.go
@@ -1,27 +1,28 @@
 package cmd
 
 import (
-	"os"
+	"fmt"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 )
 
 // completionCmd represents the completion command
 var completionCmd = &cobra.Command{
 	Use:       "completion",
-	Short:     "Generates the shell autocompletion",
-	Long:      `'completion bash' generates the bash and 'completion zsh' the zsh autocompletion`,
+	Short:     "Generates the shell autocompletion [bash, elvish, fish, powershell, zsh]",
+    Long: `Generates the shell autocompletion [bash, elvish, fish, powershell, zsh]
+
+Most scripts can be direcly sourced (though using pre-generated versions is recommended):
+  bash       : source <(lab completion bash)
+  elvish     : lab completion elvish > lab.elv; -source lab.elv
+  fish       : lab completion fish | source
+  powershell : lab completion powershell | Out-String | Invoke-Expression
+  zsh        : source <(lab completion zsh)`,
 	Args:      cobra.ExactArgs(1),
-	ValidArgs: []string{"bash", "zsh"},
+	ValidArgs: []string{"bash", "elvish", "fish", "powershell", "zsh"},
 	Run: func(cmd *cobra.Command, args []string) {
-		switch args[0] {
-		case "bash":
-			RootCmd.GenBashCompletion(os.Stdout)
-		case "zsh":
-			RootCmd.GenZshCompletion(os.Stdout)
-		default:
-			println("only 'bash' or 'zsh' allowed")
-		}
+		fmt.Println(carapace.Gen(cmd).Snippet(args[0]))
 	},
 }
 

diff --git a/cmd/completion_function.go b/cmd/completion_function.go
diff --git a/cmd/issue_browse.go b/cmd/issue_browse.go
@@ -4,7 +4,9 @@ import (
 	"log"
 	"strconv"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
+	"github.com/zaquestion/lab/internal/action"
 	"github.com/zaquestion/lab/internal/browser"
 	"github.com/zaquestion/lab/internal/gitlab"
 )
@@ -42,7 +44,9 @@ var issueBrowseCmd = &cobra.Command{
 }
 
 func init() {
-	issueBrowseCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	issueBrowseCmd.MarkZshCompPositionalArgumentCustom(2, "__lab_completion_issue $words[2]")
 	issueCmd.AddCommand(issueBrowseCmd)
+	carapace.Gen(issueBrowseCmd).PositionalCompletion(
+		action.Remotes(),
+		action.Issues(issueList),
+	)
 }
diff --git a/cmd/issue_close.go b/cmd/issue_close.go
@@ -4,7 +4,9 @@ import (
 	"fmt"
 	"log"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
+	"github.com/zaquestion/lab/internal/action"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
 
@@ -34,7 +36,9 @@ var issueCloseCmd = &cobra.Command{
 }
 
 func init() {
-	issueCloseCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	issueCloseCmd.MarkZshCompPositionalArgumentCustom(2, "__lab_completion_issue $words[2]")
 	issueCmd.AddCommand(issueCloseCmd)
+	carapace.Gen(issueCloseCmd).PositionalCompletion(
+		action.Remotes(),
+		action.Issues(issueList),
+	)
 }
diff --git a/cmd/issue_create.go b/cmd/issue_create.go
@@ -10,8 +10,10 @@ import (
 	"strings"
 	"text/template"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	gitlab "github.com/xanzy/go-gitlab"
+	"github.com/zaquestion/lab/internal/action"
 	"github.com/zaquestion/lab/internal/git"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
@@ -137,6 +139,8 @@ func init() {
 	issueCreateCmd.Flags().StringSliceP("assignees", "a", []string{}, "Set assignees by username")
 	issueCreateCmd.Flags().StringP("template", "t", "default", "use the given issue template")
 
-	issueCreateCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
 	issueCmd.AddCommand(issueCreateCmd)
+	carapace.Gen(issueCreateCmd).PositionalCompletion(
+		action.Remotes(),
+	)
 }
diff --git a/cmd/issue_edit.go b/cmd/issue_edit.go
@@ -9,9 +9,11 @@ import (
 	"strings"
 	"text/template"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 	gitlab "github.com/xanzy/go-gitlab"
+	"github.com/zaquestion/lab/internal/action"
 	"github.com/zaquestion/lab/internal/git"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
@@ -281,7 +283,9 @@ func issueEditCmdAddFlags(flags *pflag.FlagSet) *pflag.FlagSet {
 
 func init() {
 	issueEditCmdAddFlags(issueEditCmd.Flags())
-	issueEditCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	issueEditCmd.MarkZshCompPositionalArgumentCustom(2, "__lab_completion_issue $words[2]")
 	issueCmd.AddCommand(issueEditCmd)
+	carapace.Gen(issueEditCmd).PositionalCompletion(
+		action.Remotes(),
+		action.Issues(issueList),
+	)
 }
diff --git a/cmd/issue_list.go b/cmd/issue_list.go
@@ -4,8 +4,10 @@ import (
 	"fmt"
 	"log"
 
+	"github.com/rsteube/carapace"
 	"github.com/spf13/cobra"
 	gitlab "github.com/xanzy/go-gitlab"
+	"github.com/zaquestion/lab/internal/action"
 	lab "github.com/zaquestion/lab/internal/gitlab"
 )
 
@@ -27,29 +29,7 @@ lab issue list "search terms"         # search issues for "search terms"
 lab issue search "search terms"       # same as above
 lab issue list remote "search terms"  # search "remote" for issues with "search terms"`,
 	Run: func(cmd *cobra.Command, args []string) {
-		rn, issueSearch, err := parseArgsRemoteString(args)
-		if err != nil {
-			log.Fatal(err)
-		}
-
-		opts := gitlab.ListProjectIssuesOptions{
-			ListOptions: gitlab.ListOptions{
-				PerPage: issueNumRet,
-			},
-			Labels:  issueLabels,
-			State:   &issueState,
-			OrderBy: gitlab.String("updated_at"),
-		}
-
-		if issueSearch != "" {
-			opts.Search = &issueSearch
-		}
-
-		num := issueNumRet
-		if issueAll {
-			num = -1
-		}
-		issues, err := lab.IssueList(rn, opts, num)
+		issues, err := issueList(args)
 		if err != nil {
 			log.Fatal(err)
 		}
@@ -59,6 +39,32 @@ lab issue list remote "search terms"  # search "remote" for issues with "search
 	},
 }
 
+func issueList(args []string) ([]*gitlab.Issue, error) {
+	rn, issueSearch, err := parseArgsRemoteString(args)
+	if err != nil {
+		return nil, err
+	}
+
+	opts := gitlab.ListProjectIssuesOptions{
+		ListOptions: gitlab.ListOptions{
+			PerPage: issueNumRet,
+		},
+		Labels:  issueLabels,
+		State:   &issueState,
+		OrderBy: gitlab.String("updated_at"),
+	}
+
+	if issueSearch != "" {
+		opts.Search = &issueSearch
+	}
+
+	num := issueNumRet
+	if issueAll {
+		num = -1
+	}
+	return lab.IssueList(rn, opts, num)
+}
+
 func init() {
 	issueListCmd.Flags().StringSliceVarP(
 		&issueLabels, "label", "l", []string{},
@@ -73,7 +79,11 @@ func init() {
 		&issueAll, "all", "a", false,
 		"List all issues on the project")
 
-	issueListCmd.MarkZshCompPositionalArgumentCustom(1, "__lab_completion_remote")
-	issueListCmd.MarkFlagCustom("state", "(opened closed)")
 	issueCmd.AddCommand(issueListCmd)
+	carapace.Gen(issueListCmd).FlagCompletion(carapace.ActionMap{
+		"state": carapace.ActionValues("opened", "closed"),
+	})
+	carapace.Gen(issueListCmd).PositionalCompletion(
+		action.Remotes(),
+	)
 }