Merge pull request cli#144 from github/better-better-better

probablycorey · web-flow · commit 0bfd8213e240 · 2019-12-12T11:31:26.000-08:00
Better error messages when you don't supply an arg
diff --git a/api/queries_pr.go b/api/queries_pr.go
@@ -49,6 +49,10 @@ type PullRequest struct {
 	}
 }
 
+type NotFoundError struct {
+	error
+}
+
 func (pr PullRequest) HeadLabel() string {
 	if pr.IsCrossRepository {
 		return fmt.Sprintf("%s:%s", pr.HeadRepositoryOwner.Login, pr.HeadRefName)
@@ -368,7 +372,7 @@ func PullRequestForBranch(client *Client, ghRepo Repo, branch string) (*PullRequ
 		}
 	}
 
-	return nil, fmt.Errorf("no open pull requests found for branch %q", branch)
+	return nil, &NotFoundError{fmt.Errorf("no open pull requests found for branch %q", branch)}
 }
 
 func CreatePullRequest(client *Client, ghRepo Repo, params map[string]interface{}) (*PullRequest, error) {
diff --git a/command/issue.go b/command/issue.go
@@ -60,8 +60,13 @@ var issueStatusCmd = &cobra.Command{
 	RunE:  issueStatus,
 }
 var issueViewCmd = &cobra.Command{
-	Use:   "view {<number> | <url> | <branch>}",
-	Args:  cobra.MinimumNArgs(1),
+	Use: "view {<number> | <url> | <branch>}",
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) < 1 {
+			return errors.New("requires an issue number as an argument")
+		}
+		return nil
+	},
 	Short: "View an issue in the browser",
 	RunE:  issueView,
 }
@@ -108,8 +113,8 @@ func issueList(cmd *cobra.Command, args []string) error {
 		msg := "There are no open issues"
 
 		userSetFlags := false
-		cmd.Flags().VisitAll(func(f *pflag.Flag) {
-			userSetFlags = f.Changed || userSetFlags
+		cmd.Flags().Visit(func(f *pflag.Flag) {
+			userSetFlags = true
 		})
 		if userSetFlags {
 			msg = "No issues match your search"
diff --git a/command/pr.go b/command/pr.go
@@ -1,6 +1,7 @@
 package command
 
 import (
+	"errors"
 	"fmt"
 	"io"
 	"os"
@@ -45,8 +46,13 @@ A pull request can be supplied as argument in any of the following formats:
 var prCheckoutCmd = &cobra.Command{
 	Use:   "checkout {<number> | <url> | <branch>}",
 	Short: "Check out a pull request in Git",
-	Args:  cobra.MinimumNArgs(1),
-	RunE:  prCheckout,
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) < 1 {
+			return errors.New("requires a PR number as an argument")
+		}
+		return nil
+	},
+	RunE: prCheckout,
 }
 var prListCmd = &cobra.Command{
 	Use:   "list",
@@ -191,8 +197,8 @@ func prList(cmd *cobra.Command, args []string) error {
 		msg := "There are no open pull requests"
 
 		userSetFlags := false
-		cmd.Flags().VisitAll(func(f *pflag.Flag) {
-			userSetFlags = f.Changed || userSetFlags
+		cmd.Flags().Visit(func(f *pflag.Flag) {
+			userSetFlags = true
 		})
 		if userSetFlags {
 			msg = "No pull requests match your search"
@@ -263,8 +269,13 @@ func prView(cmd *cobra.Command, args []string) error {
 		} else {
 			pr, err := api.PullRequestForBranch(apiClient, baseRepo, branchWithOwner)
 			if err != nil {
+				var notFoundErr *api.NotFoundError
+				if errors.As(err, &notFoundErr) {
+					return fmt.Errorf("%s. To open a specific pull request use the pull request's number as an argument", err)
+				}
 				return err
 			}
+
 			openURL = pr.URL
 		}
 	}
diff --git a/command/pr_test.go b/command/pr_test.go
@@ -217,7 +217,7 @@ func TestPRView_noResultsForBranch(t *testing.T) {
 	defer restoreCmd()
 
 	_, err := RunCommand(prViewCmd, "pr view")
-	if err == nil || err.Error() != `no open pull requests found for branch "blueberries"` {
+	if err == nil || err.Error() != `no open pull requests found for branch "blueberries". To open a specific pull request use the pull request's number as an argument` {
 		t.Errorf("error running command `pr view`: %v", err)
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -49,6 +49,10 @@ type PullRequest struct {`
`49`	`49`	`}`
`50`	`50`	`}`
`51`	`51`
	`52`	`+type NotFoundError struct {`
	`53`	`+ error`
	`54`	`+}`
	`55`	`+`
`52`	`56`	`func (pr PullRequest) HeadLabel() string {`
`53`	`57`	`if pr.IsCrossRepository {`
`54`	`58`	`return fmt.Sprintf("%s:%s", pr.HeadRepositoryOwner.Login, pr.HeadRefName)`
`@@ -368,7 +372,7 @@ func PullRequestForBranch(client Client, ghRepo Repo, branch string) (PullRequ`
`368`	`372`	`}`
`369`	`373`	`}`
`370`	`374`
`371`		`- return nil, fmt.Errorf("no open pull requests found for branch %q", branch)`
	`375`	`+ return nil, &NotFoundError{fmt.Errorf("no open pull requests found for branch %q", branch)}`
`372`	`376`	`}`
`373`	`377`
`374`	`378`	`func CreatePullRequest(client Client, ghRepo Repo, params map[string]interface{}) (PullRequest, error) {`
Original file line number	Diff line number	Diff line change
`@@ -217,7 +217,7 @@ func TestPRView_noResultsForBranch(t *testing.T) {`
`217`	`217`	`defer restoreCmd()`
`218`	`218`
`219`	`219`	`_, err := RunCommand(prViewCmd, "pr view")`
`220`		- if err == nil \|\| err.Error() != `no open pull requests found for branch "blueberries"` {
	`220`	+ if err == nil \|\| err.Error() != `no open pull requests found for branch "blueberries". To open a specific pull request use the pull request's number as an argument` {
`221`	`221`	t.Errorf("error running command `pr view`: %v", err)
`222`	`222`	`}`
`223`	`223`