Merge pull request #409 from rsteube/add-gh

added gh

Author: rsteube

completers/gh_completer/cmd/action/action.go

@@ -0,0 +1,187 @@
+package action
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/completers/gh_completer/cmd/action/config"
+	"github.com/rsteube/carapace-bin/completers/gh_completer/cmd/action/ghrepo"
+	"github.com/rsteube/carapace-bin/completers/gh_completer/cmd/action/git"
+	"github.com/spf13/cobra"
+)
+
+func ghExecutable() string {
+	return "gh"
+}
+
+func ActionConfigHosts() carapace.Action {
+	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+		if config, err := config.ParseDefaultConfig(); err != nil {
+			return carapace.ActionMessage("failed to parse DefaultConfig: " + err.Error())
+		} else {
+			if hosts, err := config.Hosts(); err != nil {
+				return carapace.ActionMessage("failed ot loadd hosts: " + err.Error())
+			} else {
+				return carapace.ActionValues(hosts...)
+			}
+		}
+	})
+}
+
+func ActionHttpMethods() carapace.Action {
+	return carapace.ActionValuesDescribed(
+		"POST", "submit an entity to the specified resource",
+		"PATCH", "apply partial modifications to a resourc",
+		"PUT", "replaces all current representations of the target resource with the request payload",
+		"DELETE", "delete the specified resource",
+	)
+}
+
+func ApiV3Action(cmd *cobra.Command, query string, v interface{}, transform func() carapace.Action) carapace.Action {
+	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+		if repo, err := repoOverride(cmd); err != nil {
+			return carapace.ActionMessage(err.Error())
+		} else {
+			return carapace.ActionExecCommand(ghExecutable(), "api", "--hostname", repo.RepoHost(), query)(func(output []byte) carapace.Action {
+				if err := json.Unmarshal(output, &v); err != nil {
+					return carapace.ActionMessage("failed to unmarshall response: " + err.Error())
+				}
+				return transform()
+			})
+		}
+	})
+}
+
+func GraphQlAction(cmd *cobra.Command, query string, v interface{}, transform func() carapace.Action) carapace.Action {
+	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+		params := make([]string, 0)
+		if strings.Contains(query, "$owner") {
+			params = append(params, "$owner: String!")
+		}
+		if strings.Contains(query, "$repo") {
+			params = append(params, "$repo: String!")
+		}
+		queryParams := strings.Join(params, ",")
+		if queryParams != "" {
+			queryParams = "(" + queryParams + ")"
+		}
+
+		if repo, err := repoOverride(cmd); err != nil {
+			return carapace.ActionMessage(err.Error())
+		} else {
+			return carapace.ActionExecCommand(ghExecutable(), "api", "--hostname", repo.RepoHost(), "--header", "Accept: application/vnd.github.merge-info-preview+json", "graphql", "-F", "owner="+repo.RepoOwner(), "-F", "repo="+repo.RepoName(), "-f", fmt.Sprintf("query=query%v {%v}", queryParams, query))(func(output []byte) carapace.Action {
+				if err := json.Unmarshal(output, &v); err != nil {
+					return carapace.ActionMessage("failed to unmarshall response: " + err.Error())
+				}
+				return transform()
+			})
+		}
+	})
+}
+
+func repoOverride(cmd *cobra.Command) (ghrepo.Interface, error) {
+	repoOverride := ""
+	if flag := cmd.Flag("repo"); flag != nil {
+		repoOverride = flag.Value.String()
+	}
+	if repoFromEnv := os.Getenv("GH_REPO"); repoOverride == "" && repoFromEnv != "" {
+		repoOverride = repoFromEnv
+	}
+	if repoOverride != "" {
+		splitted := strings.Split(repoOverride, "/")
+		switch len(splitted) {
+		case 1:
+			return ghrepo.New(splitted[0], ""), nil // assume owner
+		case 2:
+			if strings.Contains(splitted[0], ".") {
+				return ghrepo.NewWithHost(splitted[1], "", splitted[0]), nil
+			} else {
+				return ghrepo.New(splitted[0], splitted[1]), nil
+			}
+		default:
+			return ghrepo.NewWithHost(splitted[1], splitted[2], splitted[0]), nil
+		}
+	} else {
+		if remotes, err := git.Remotes(); err == nil {
+			for _, remote := range remotes {
+				if remote.Resolved == "base" {
+					return ghrepo.FromURL(remote.FetchURL) // TODO ssh translator
+				}
+			}
+		}
+	}
+	return ghrepo.New("", ""), nil
+}
+
+func ActionAuthScopes() carapace.Action {
+	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+		return carapace.ActionValuesDescribed(
+			"repo", "Grants full access to private and public repositories.",
+			"repo:status", "Grants read/write access to public and private repository commit statuses.",
+			"repo_deployment", "Grants access to deployment statuses for public and private repositories.",
+			"public_repo", "Limits access to public repositories.",
+			"repo:invite", "Grants accept/decline abilities for invitations to collaborate on a repository.",
+			"security_events", "Grants read and write access to security events in the code scanning API.",
+			"admin:repo_hook", "Grants read, write, ping, and delete access to repository hooks in public and private repositories.",
+			"write:repo_hook", "Grants read, write, and ping access to hooks in public or private repositories.",
+			"read:repo_hook", "Grants read and ping access to hooks in public or private repositories.",
+			"admin:org", "Fully manage the organization and its teams, projects, and memberships.",
+			"write:org", "Read and write access to organization membership, organization projects, and team membership.",
+			"read:org", "Read-only access to organization membership, organization projects, and team membership.",
+			"admin:public_key", "Fully manage public keys.",
+			"write:public_key", "Create, list, and view details for public keys.",
+			"read:public_key", "List and view details for public keys.",
+			"admin:org_hook", "Grants read, write, ping, and delete access to organization hooks.",
+			"gist", "Grants write access to gists.",
+			"notifications", "Grants read access to a user's notifications",
+			"user", "Grants read/write access to profile info only.",
+			"read:user", "Grants access to read a user's profile data.",
+			"user:email", "Grants read access to a user's email addresses.",
+			"user:follow", "Grants access to follow or unfollow other users.",
+			"delete_repo", "Grants access to delete adminable repositories.",
+			"write:discussion", "Allows read and write access for team discussions.",
+			"read:discussion", "Allows read access for team discussions.",
+			"write:packages", "Grants access to upload or publish a package in GitHub Packages.",
+			"read:packages", "Grants access to download or install packages from GitHub Packages.",
+			"delete:packages", "Grants access to delete packages from GitHub Packages.",
+			"admin:gpg_key", "Fully manage GPG keys.",
+			"write:gpg_key", "Create, list, and view details for GPG keys.",
+			"read:gpg_key", "List and view details for GPG keys.",
+			"workflow", "Grants the ability to add and update GitHub Actions workflow files.",
+		).Invoke(c).ToMultiPartsA(":")
+	})
+}
+
+// https://yourbasic.org/golang/formatting-byte-size-to-human-readable-format/
+func byteCountSI(b int) string {
+	const unit = 1000
+	if b < unit {
+		return fmt.Sprintf("%d B", b)
+	}
+	div, exp := int64(unit), 0
+	for n := b / unit; n >= unit; n /= unit {
+		div *= unit
+		exp++
+	}
+	return fmt.Sprintf("%.1f %cB",
+		float64(b)/float64(div), "kMGTPE"[exp])
+}
+
+func defaultUser() (user string, err error) {
+	var cfg config.Config
+	if cfg, err = config.ParseDefaultConfig(); err == nil {
+		var hosts []string
+		if hosts, err = cfg.Hosts(); err == nil {
+			if len(hosts) < 1 {
+				err = errors.New("could not retrieve default user")
+			} else {
+				user, err = cfg.Get(hosts[0], "user")
+			}
+		}
+	}
+	return
+}

completers/gh_completer/cmd/action/alias.go

@@ -0,0 +1,38 @@
+package action
+
+import (
+	"errors"
+
+	"github.com/rsteube/carapace"
+	"github.com/rsteube/carapace-bin/completers/gh_completer/cmd/action/config"
+)
+
+func Aliases() (map[string]string, error) {
+	if config, err := config.ParseDefaultConfig(); err != nil {
+		return nil, errors.New("failed to parse DefaultConfig:" + err.Error())
+	} else {
+		if aliasCfg, err := config.Aliases(); err != nil {
+			return nil, errors.New("failed to load AliasCfg:" + err.Error())
+		} else {
+			aliases := make(map[string]string)
+			for key, value := range aliasCfg.All() {
+				aliases[key] = value
+			}
+			return aliases, nil
+		}
+	}
+}
+
+func ActionAliases() carapace.Action {
+	return carapace.ActionCallback(func(c carapace.Context) carapace.Action {
+		if aliases, err := Aliases(); err != nil {
+			return carapace.ActionMessage(err.Error())
+		} else {
+			values := make([]string, 0)
+			for key, value := range aliases {
+				values = append(values, key, value)
+			}
+			return carapace.ActionValuesDescribed(values...)
+		}
+	})
+}

completers/gh_completer/cmd/action/api.go

@@ -0,0 +1,149 @@
+package action
+
+import (
+	"fmt"
+	"regexp"
+	"strings"
+
+	"github.com/rsteube/carapace"
+	"github.com/spf13/cobra"
+)
+
+// ActionApiPreviews https://docs.github.com/en/rest/overview/api-previews
+func ActionApiPreviews() carapace.Action {
+	return carapace.ActionValuesDescribed(
+		"wyandotte", "Migrations",
+		"ant-man", "Enhanced deployments",
+		"squirrel-girl", "Reactions",
+		"mockingbird", "Timeline",
+		"inertia", "Projects",
+		"cloak", "Commit search",
+		"mercy", "Repository topics",
+		"scarlet-witch", "Codes of conduct",
+		"zzzax", "Require signed commits",
+		"luke-cage", "Require multiple approving reviews",
+		"starfox", "Project card details",
+		"fury", "GitHub App Manifests",
+		"flash", "Deployment statuses",
+		"surtur", "Repository creation permissions",
+		"corsair", "Content attachments",
+		"switcheroo", "Enable and disable Pages",
+		"groot", "List branches or pull requests for a commit",
+		"dorian", "Enable or disable vulnerability alerts for a repository",
+		"lydian", "Update a pull request branch",
+		"london", "Enable or disable automated security fixes",
+		"baptiste", "Create and use repository templates",
+		"nebula", "New visibility parameter for the Repositories API",
+	)
+}
+
+func ActionApiV3Paths(cmd *cobra.Command) carapace.Action {
+	return carapace.ActionMultiParts("/", func(c carapace.Context) carapace.Action {
+		placeholder := regexp.MustCompile(`{(.*)}`)
+		matchedData := make(map[string]string)
+		matchedSegments := make(map[string]bool)
+		staticMatches := make(map[int]bool)
+
+	path:
+		for _, path := range v3Paths {
+			segments := strings.Split(path, "/")
+		segment:
+			for index, segment := range segments {
+				if index > len(c.Parts)-1 {
+					break segment
+				} else {
+					if segment != c.Parts[index] {
+						if !placeholder.MatchString(segment) {
+							continue path // skip this path as it doesn't match and is not a placeholder
+						} else {
+							matchedData[segment] = c.Parts[index] // store entered data for placeholder (overwrite if duplicate)
+						}
+					} else {
+						staticMatches[index] = true // static segment matches so placeholders should be ignored for this index
+					}
+				}
+			}
+
+			if len(segments) < len(c.Parts)+1 {
+				continue path // skip path as it is shorter than what was entered (must be after staticMatches being set)
+			}
+
+			for key := range staticMatches {
+				if segments[key] != c.Parts[key] {
+					continue path // skip this path as it has a placeholder where a static segment was matched
+				}
+			}
+			matchedSegments[segments[len(c.Parts)]] = true // store segment as path matched so far and this is currently being completed
+		}
+
+		actions := make([]carapace.InvokedAction, 0, len(matchedSegments))
+		for key := range matchedSegments {
+			switch key {
+			// TODO completion for other placeholders
+			case "{archive_format}":
+				actions = append(actions, carapace.ActionValues("zip").Invoke(c))
+			case "{artifact_id}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionWorkflowArtifactIds(cmd, "").Invoke(c))
+			case "{assignee}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionAssignableUsers(cmd).Invoke(c))
+			case "{branch}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionBranches(cmd).Invoke(c))
+			case "{gist_id}":
+				actions = append(actions, ActionGists(cmd).Invoke(c))
+			case "{gitignore_name}":
+				actions = append(actions, ActionGitignoreTemplates(cmd).Invoke(c))
+			case "{issue_number}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionIssues(cmd, IssueOpts{Open: true, Closed: true}).Invoke(c))
+			case "{owner}":
+				if strings.HasPrefix(c.CallbackValue, ":") {
+					actions = append(actions, carapace.ActionValues(":owner").Invoke(c))
+				} else {
+					actions = append(actions, ActionUsers(cmd, UserOpts{Users: true, Organizations: true}).Invoke(c))
+				}
+			case "{org}":
+				actions = append(actions, ActionUsers(cmd, UserOpts{Organizations: true}).Invoke(c))
+			case "{package_type}":
+				actions = append(actions, ActionPackageTypes().Invoke(c))
+			case "{pull_number}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionPullRequests(cmd, PullRequestOpts{Open: true, Closed: true, Merged: true}).Invoke(c))
+			case "{repo}":
+				if strings.HasPrefix(c.CallbackValue, ":") {
+					actions = append(actions, carapace.ActionValues(":repo").Invoke(c))
+				} else {
+					actions = append(actions, ActionRepositories(cmd, matchedData["{owner}"], c.CallbackValue).Invoke(c))
+				}
+			case "{tag}": // only used with releases
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionReleases(cmd).Invoke(c))
+			case "{template_owner}": // ignore this as it is already provided by `{owner}`
+			case "{template_repo}": // ignore this as it is already provided by `{repo}`
+			case "{username}":
+				actions = append(actions, ActionUsers(cmd, UserOpts{Users: true}).Invoke(c))
+			case "{workflow_id}":
+				fakeRepoFlag(cmd, matchedData["{owner}"], matchedData["{repo}"])
+				actions = append(actions, ActionWorkflows(cmd, WorkflowOpts{Enabled: true, Disabled: true, Id: true}).Invoke(c))
+			default:
+				// static value or placeholder not yet handled
+				actions = append(actions, carapace.ActionValues(key).Invoke(c))
+			}
+		}
+		switch len(actions) {
+		case 0:
+			return carapace.ActionValues()
+		case 1:
+			return actions[0].ToA()
+		default:
+			return actions[0].Merge(actions[1:]...).ToA()
+		}
+	})
+}
+
+func fakeRepoFlag(cmd *cobra.Command, owner, repo string) {
+	cmd.Flags().String("repo", fmt.Sprintf("%v/%v", owner, repo), "fake repo flag")
+	cmd.Flag("repo").Changed = true
+}