From cf382e0fad77e758898e7d51c4e322645fb6042c Mon Sep 17 00:00:00 2001 From: Steve Moyer Date: Wed, 18 Jan 2023 05:42:25 -0500 Subject: [PATCH 1/3] style: clean up linter complaints --- commands/bug/bug_comment.go | 2 +- commands/bug/bug_comment_add.go | 2 +- commands/bug/bug_label.go | 2 +- commands/bug/bug_select.go | 2 +- commands/bug/bug_show.go | 6 ++++-- commands/bug/bug_status.go | 2 +- commands/bug/bug_status_close.go | 2 +- commands/bug/bug_status_open.go | 2 +- commands/bug/bug_title.go | 2 +- commands/bug/bug_title_edit.go | 2 +- 10 files changed, 13 insertions(+), 11 deletions(-) diff --git a/commands/bug/bug_comment.go b/commands/bug/bug_comment.go index 5cb8ff17a7435f9900c1b2c7217ceebc08f564b9..b037f688b54a55a0e890ae937a560448986b03b0 100644 --- a/commands/bug/bug_comment.go +++ b/commands/bug/bug_comment.go @@ -26,7 +26,7 @@ func newBugCommentCommand(env *execenv.Env) *cobra.Command { } func runBugComment(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_comment_add.go b/commands/bug/bug_comment_add.go index 152a18930fe9553265aca43e96e41d9abd0b52bf..132de2339c640d03da746b7743e415d82ef1ad5a 100644 --- a/commands/bug/bug_comment_add.go +++ b/commands/bug/bug_comment_add.go @@ -41,7 +41,7 @@ func newBugCommentNewCommand(env *execenv.Env) *cobra.Command { } func runBugCommentNew(env *execenv.Env, opts bugCommentNewOptions, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_label.go b/commands/bug/bug_label.go index 554496e35b7c96e567e3b739cfea6eab8b6ca7e6..ec076922d015506214abbbf4d3c340cf6f5590d0 100644 --- a/commands/bug/bug_label.go +++ b/commands/bug/bug_label.go @@ -24,7 +24,7 @@ func newBugLabelCommand(env *execenv.Env) *cobra.Command { } func runBugLabel(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_select.go b/commands/bug/bug_select.go index 652c61eae56169fdb93786416fe2f144e8e9a4dc..c93cd7b1a23868d0b27040d38c999014f35fe81f 100644 --- a/commands/bug/bug_select.go +++ b/commands/bug/bug_select.go @@ -44,7 +44,7 @@ The complementary command is "git bug deselect" performing the opposite operatio func runBugSelect(env *execenv.Env, args []string) error { if len(args) == 0 { - return errors.New("You must provide a bug id") + return errors.New("a bug id must be provided") } prefix := args[0] diff --git a/commands/bug/bug_show.go b/commands/bug/bug_show.go index 9a03c9a31ddb9c62c97bd6846be11fb85db7a50c..38eda54a8aebd922945c5824681be92d7941d7d6 100644 --- a/commands/bug/bug_show.go +++ b/commands/bug/bug_show.go @@ -47,7 +47,7 @@ func newBugShowCommand(env *execenv.Env) *cobra.Command { } func runBugShow(env *execenv.Env, opts bugShowOptions, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } @@ -91,7 +91,9 @@ func runBugShow(env *execenv.Env, opts bugShowOptions, args []string) error { case "title": env.Out.Printf("%s\n", snap.Title) default: - return fmt.Errorf("\nUnsupported field: %s\n", opts.fields) + env.Out.Println() + + return fmt.Errorf("unsupported field: %s", opts.fields) } return nil diff --git a/commands/bug/bug_status.go b/commands/bug/bug_status.go index 59bef3fd02e222423ff742567e25ea20d06ec60d..c8542240b72294e8c23a34ede567700308d4b6e6 100644 --- a/commands/bug/bug_status.go +++ b/commands/bug/bug_status.go @@ -24,7 +24,7 @@ func newBugStatusCommand(env *execenv.Env) *cobra.Command { } func runBugStatus(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_status_close.go b/commands/bug/bug_status_close.go index 1d06007b416608779e8a5be599c503ad1e22e7e4..7a8ae4de5f6773ee3d50fab05586c849b0af4ffe 100644 --- a/commands/bug/bug_status_close.go +++ b/commands/bug/bug_status_close.go @@ -21,7 +21,7 @@ func newBugStatusCloseCommand(env *execenv.Env) *cobra.Command { } func runBugStatusClose(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_status_open.go b/commands/bug/bug_status_open.go index e99d2db03d166459627a84bb28b90b72cbbba6b4..0c0c02f088e9e71f513bb920642466628ffac2f0 100644 --- a/commands/bug/bug_status_open.go +++ b/commands/bug/bug_status_open.go @@ -21,7 +21,7 @@ func newBugStatusOpenCommand(env *execenv.Env) *cobra.Command { } func runBugStatusOpen(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_title.go b/commands/bug/bug_title.go index 47603410427e20c2fc433588227a52b60076361f..af959fb734efb3824fa66377d48e14a6ad3050b1 100644 --- a/commands/bug/bug_title.go +++ b/commands/bug/bug_title.go @@ -23,7 +23,7 @@ func newBugTitleCommand(env *execenv.Env) *cobra.Command { } func runBugTitle(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } diff --git a/commands/bug/bug_title_edit.go b/commands/bug/bug_title_edit.go index fc60824f557afa6847eea8a462d3e0d25f76e5dc..2d6bafca1d12bd4a32194d84d0c9818f57fd8683 100644 --- a/commands/bug/bug_title_edit.go +++ b/commands/bug/bug_title_edit.go @@ -38,7 +38,7 @@ func newBugTitleEditCommand(env *execenv.Env) *cobra.Command { } func runBugTitleEdit(env *execenv.Env, opts bugTitleEditOptions, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, _, err := ResolveSelected(env.Backend, args) if err != nil { return err } From 14773b16ca4a16cbf84416894e254e41a01764b1 Mon Sep 17 00:00:00 2001 From: Steve Moyer Date: Thu, 19 Jan 2023 20:29:33 -0500 Subject: [PATCH 2/3] style: resolve PR comments --- commands/bug/bug_label_new.go | 4 +--- commands/bug/bug_label_rm.go | 4 +--- commands/bug/bug_show.go | 2 -- commands/bug/completion.go | 4 ++-- 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/commands/bug/bug_label_new.go b/commands/bug/bug_label_new.go index 1e1f2d4fb79bc788682e9e6fbe016fbda70596be..c8c3b8110869f8b8864190c36f18533a8f671c96 100644 --- a/commands/bug/bug_label_new.go +++ b/commands/bug/bug_label_new.go @@ -22,13 +22,11 @@ func newBugLabelNewCommand(env *execenv.Env) *cobra.Command { } func runBugLabelNew(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, added, err := ResolveSelected(env.Backend, args) if err != nil { return err } - added := args - changes, _, err := b.ChangeLabels(text.CleanupOneLineArray(added), nil) for _, change := range changes { diff --git a/commands/bug/bug_label_rm.go b/commands/bug/bug_label_rm.go index 6dda007c756706e2932646007519753e366186a2..fca2ac467ab3923f229f509ff5a7b5b639439005 100644 --- a/commands/bug/bug_label_rm.go +++ b/commands/bug/bug_label_rm.go @@ -22,13 +22,11 @@ func newBugLabelRmCommand(env *execenv.Env) *cobra.Command { } func runBugLabelRm(env *execenv.Env, args []string) error { - b, args, err := ResolveSelected(env.Backend, args) + b, removed, err := ResolveSelected(env.Backend, args) if err != nil { return err } - removed := args - changes, _, err := b.ChangeLabels(nil, text.CleanupOneLineArray(removed)) for _, change := range changes { diff --git a/commands/bug/bug_show.go b/commands/bug/bug_show.go index 38eda54a8aebd922945c5824681be92d7941d7d6..ef20df2a3954bff9f8613e121f9e2bb214b3134a 100644 --- a/commands/bug/bug_show.go +++ b/commands/bug/bug_show.go @@ -91,8 +91,6 @@ func runBugShow(env *execenv.Env, opts bugShowOptions, args []string) error { case "title": env.Out.Printf("%s\n", snap.Title) default: - env.Out.Println() - return fmt.Errorf("unsupported field: %s", opts.fields) } diff --git a/commands/bug/completion.go b/commands/bug/completion.go index 4754f97dcc419d4d88c630bbdfdc28c882e002d0..62bf658a77d61a32e6cb4222054d5f89e063dedf 100644 --- a/commands/bug/completion.go +++ b/commands/bug/completion.go @@ -50,7 +50,7 @@ func BugAndLabelsCompletion(env *execenv.Env, addOrRemove bool) completion.Valid _ = env.Backend.Close() }() - b, args, err := ResolveSelected(env.Backend, args) + b, cleanArgs, err := ResolveSelected(env.Backend, args) if _select.IsErrNoValidId(err) { // we need a bug first to complete labels return bugWithBackend(env.Backend, toComplete) @@ -62,7 +62,7 @@ func BugAndLabelsCompletion(env *execenv.Env, addOrRemove bool) completion.Valid snap := b.Snapshot() seenLabels := map[bug.Label]bool{} - for _, label := range args { + for _, label := range cleanArgs { seenLabels[bug.Label(label)] = addOrRemove } From 3f764397dbd49910e549d3ef3c0d26e3ca2f8b0f Mon Sep 17 00:00:00 2001 From: Steve Moyer Date: Fri, 20 Jan 2023 09:02:05 -0500 Subject: [PATCH 3/3] docs(commands): try to make cleaned argument use more obvious --- commands/bug/bug_comment_test.go | 1 - commands/bug/bug_label_new.go | 4 +++- commands/bug/bug_label_rm.go | 4 +++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/commands/bug/bug_comment_test.go b/commands/bug/bug_comment_test.go index ecc1c5f65654b0a600bfe8114a9c3e5943eb063e..add48b218b04dbc5ab553d489446e60dea6df7de 100644 --- a/commands/bug/bug_comment_test.go +++ b/commands/bug/bug_comment_test.go @@ -140,7 +140,6 @@ func requireCommentsEqual(t *testing.T, golden string, env *execenv.Env) { comments = normalizeParsedComments(t, comments) if *cmdtest.Update { - t.Log("Got here") for i, comment := range comments { fileName := fmt.Sprintf(goldenFilePattern, golden, i) require.NoError(t, os.WriteFile(fileName, []byte(comment.message), 0644)) diff --git a/commands/bug/bug_label_new.go b/commands/bug/bug_label_new.go index c8c3b8110869f8b8864190c36f18533a8f671c96..9fff851c3502413b00c361121e78366a3a731c2e 100644 --- a/commands/bug/bug_label_new.go +++ b/commands/bug/bug_label_new.go @@ -22,11 +22,13 @@ func newBugLabelNewCommand(env *execenv.Env) *cobra.Command { } func runBugLabelNew(env *execenv.Env, args []string) error { - b, added, err := ResolveSelected(env.Backend, args) + b, cleanArgs, err := ResolveSelected(env.Backend, args) if err != nil { return err } + added := cleanArgs + changes, _, err := b.ChangeLabels(text.CleanupOneLineArray(added), nil) for _, change := range changes { diff --git a/commands/bug/bug_label_rm.go b/commands/bug/bug_label_rm.go index fca2ac467ab3923f229f509ff5a7b5b639439005..d389830f3554ea102bca86f1cf9306687d74402d 100644 --- a/commands/bug/bug_label_rm.go +++ b/commands/bug/bug_label_rm.go @@ -22,11 +22,13 @@ func newBugLabelRmCommand(env *execenv.Env) *cobra.Command { } func runBugLabelRm(env *execenv.Env, args []string) error { - b, removed, err := ResolveSelected(env.Backend, args) + b, cleanArgs, err := ResolveSelected(env.Backend, args) if err != nil { return err } + removed := cleanArgs + changes, _, err := b.ChangeLabels(nil, text.CleanupOneLineArray(removed)) for _, change := range changes {