Merge pull request cli#3024 from cli/normalize-pr-commands

samcoe · web-flow · commit a49654970c82 · 2021-02-26T10:31:06.000-08:00
Normalize pr command arguments
diff --git a/pkg/cmd/pr/comment/comment.go b/pkg/cmd/pr/comment/comment.go
@@ -30,6 +30,7 @@ func NewCmdComment(f *cmdutil.Factory, runF func(*shared.CommentableOptions) err
 		Example: heredoc.Doc(`
 			$ gh pr comment 22 --body "This looks great, lets get it deployed."
 		`),
+		Args: cobra.MaximumNArgs(1),
 		PreRunE: func(cmd *cobra.Command, args []string) error {
 			if repoOverride, _ := cmd.Flags().GetString("repo"); repoOverride != "" && len(args) == 0 {
 				return &cmdutil.FlagError{Err: errors.New("argument required when using the --repo flag")}
diff --git a/pkg/cmd/pr/comment/comment_test.go b/pkg/cmd/pr/comment/comment_test.go
@@ -32,6 +32,12 @@ func TestNewCmdComment(t *testing.T) {
 			},
 			wantsErr: false,
 		},
+		{
+			name:     "two arguments",
+			input:    "1 2",
+			output:   shared.CommentableOptions{},
+			wantsErr: true,
+		},
 		{
 			name:  "pr number",
 			input: "1",
diff --git a/pkg/cmd/pr/edit/edit.go b/pkg/cmd/pr/edit/edit.go
@@ -46,7 +46,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
 	}
 
 	cmd := &cobra.Command{
-		Use:   "edit {<number> | <url>}",
+		Use:   "edit [<number> | <url> | <branch>]",
 		Short: "Edit a pull request",
 		Example: heredoc.Doc(`
 			$ gh pr edit 23 --title "I found a bug" --body "Nothing works"
@@ -56,12 +56,14 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
 			$ gh pr edit 23 --add-project "Roadmap" --remove-project v1,v2
 			$ gh pr edit 23 --milestone "Version 1"
 		`),
-		Args: cobra.ExactArgs(1),
+		Args: cobra.MaximumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// support `-R, --repo` override
 			opts.BaseRepo = f.BaseRepo
 
-			opts.SelectorArg = args[0]
+			if len(args) > 0 {
+				opts.SelectorArg = args[0]
+			}
 
 			flags := cmd.Flags()
 			if flags.Changed("title") {
diff --git a/pkg/cmd/pr/edit/edit_test.go b/pkg/cmd/pr/edit/edit_test.go
@@ -23,8 +23,17 @@ func TestNewCmdEdit(t *testing.T) {
 		wantsErr bool
 	}{
 		{
-			name:     "no argument",
-			input:    "",
+			name:  "no argument",
+			input: "",
+			output: EditOptions{
+				SelectorArg: "",
+				Interactive: true,
+			},
+			wantsErr: false,
+		},
+		{
+			name:     "two arguments",
+			input:    "1 2",
 			output:   EditOptions{},
 			wantsErr: true,
 		},
