Detailed changes
@@ -94,10 +94,10 @@ git bug status:open --by creation "foo bar" baz
flags.StringVarP(&options.sortDirection, "direction", "d", "asc",
"Select the sorting direction. Valid values are [asc,desc]")
cmd.RegisterFlagCompletionFunc("direction", completion.From([]string{"asc", "desc"}))
- flags.StringVarP(&options.outputFormat, "format", "f", "default",
- "Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode]")
+ flags.StringVarP(&options.outputFormat, "format", "f", "",
+ "Select the output formatting style. Valid values are [default,plain,id,json,org-mode]")
cmd.RegisterFlagCompletionFunc("format",
- completion.From([]string{"default", "plain", "compact", "id", "json", "org-mode"}))
+ completion.From([]string{"default", "plain", "id", "json", "org-mode"}))
const selectGroup = "select"
cmd.AddGroup(&cobra.Group{ID: selectGroup, Title: "Implicit selection"})
@@ -147,28 +147,32 @@ func runBug(env *execenv.Env, opts bugOptions, args []string) error {
return err
}
- bugExcerpt := make([]*cache.BugExcerpt, len(allIds))
+ excerpts := make([]*cache.BugExcerpt, len(allIds))
for i, id := range allIds {
b, err := env.Backend.Bugs().ResolveExcerpt(id)
if err != nil {
return err
}
- bugExcerpt[i] = b
+ excerpts[i] = b
}
switch opts.outputFormat {
- case "org-mode":
- return bugsOrgmodeFormatter(env, bugExcerpt)
+ case "":
+ if env.Out.IsTerminal() {
+ return bugsDefaultFormatter(env, excerpts)
+ } else {
+ return bugsPlainFormatter(env, excerpts)
+ }
+ case "default":
+ return bugsDefaultFormatter(env, excerpts)
+ case "id":
+ return bugsIDFormatter(env, excerpts)
case "plain":
- return bugsPlainFormatter(env, bugExcerpt)
+ return bugsPlainFormatter(env, excerpts)
case "json":
- return bugsJsonFormatter(env, bugExcerpt)
- case "compact":
- return bugsCompactFormatter(env, bugExcerpt)
- case "id":
- return bugsIDFormatter(env, bugExcerpt)
- case "default":
- return bugsDefaultFormatter(env, bugExcerpt)
+ return bugsJsonFormatter(env, excerpts)
+ case "org-mode":
+ return bugsOrgmodeFormatter(env, excerpts)
default:
return fmt.Errorf("unknown format %s", opts.outputFormat)
}
@@ -187,9 +191,9 @@ func repairQuery(args []string) string {
return strings.Join(args, " ")
}
-func bugsJsonFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
- jsonBugs := make([]cmdjson.BugExcerpt, len(bugExcerpts))
- for i, b := range bugExcerpts {
+func bugsJsonFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
+ jsonBugs := make([]cmdjson.BugExcerpt, len(excerpts))
+ for i, b := range excerpts {
jsonBug, err := cmdjson.NewBugExcerpt(env.Backend, b)
if err != nil {
return err
@@ -199,41 +203,15 @@ func bugsJsonFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error
return env.Out.PrintJSON(jsonBugs)
}
-func bugsCompactFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
- for _, b := range bugExcerpts {
- author, err := env.Backend.Identities().ResolveExcerpt(b.AuthorId)
- if err != nil {
- return err
- }
-
- var labelsTxt strings.Builder
- for _, l := range b.Labels {
- lc256 := l.Color().Term256()
- labelsTxt.WriteString(lc256.Escape())
- labelsTxt.WriteString("◼")
- labelsTxt.WriteString(lc256.Unescape())
- }
-
- env.Out.Printf("%s %s %s %s %s\n",
- colors.Cyan(b.Id().Human()),
- colors.Yellow(b.Status),
- text.LeftPadMaxLine(strings.TrimSpace(b.Title), 40, 0),
- text.LeftPadMaxLine(labelsTxt.String(), 5, 0),
- colors.Magenta(text.TruncateMax(author.DisplayName(), 15)),
- )
- }
- return nil
-}
-
-func bugsIDFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
- for _, b := range bugExcerpts {
+func bugsIDFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
+ for _, b := range excerpts {
env.Out.Println(b.Id().String())
}
return nil
}
-func bugsDefaultFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
+func bugsDefaultFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
width := env.Out.Width()
widthId := entity.HumanIdLength
widthStatus := len("closed")
@@ -252,7 +230,7 @@ func bugsDefaultFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) err
widthRemaining = widthRemaining - widthTitle - 3 - 2
widthAuthor := widthRemaining
- for _, b := range bugExcerpts {
+ for _, b := range excerpts {
author, err := env.Backend.Identities().ResolveExcerpt(b.AuthorId)
if err != nil {
return err
@@ -290,14 +268,14 @@ func bugsDefaultFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) err
return nil
}
-func bugsPlainFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
- for _, b := range bugExcerpts {
- env.Out.Printf("%s [%s] %s\n", b.Id().Human(), b.Status, strings.TrimSpace(b.Title))
+func bugsPlainFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
+ for _, b := range excerpts {
+ env.Out.Printf("%s\t%s\t%s\n", b.Id().Human(), b.Status, strings.TrimSpace(b.Title))
}
return nil
}
-func bugsOrgmodeFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) error {
+func bugsOrgmodeFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
// see https://orgmode.org/manual/Tags.html
orgTagRe := regexp.MustCompile("[^[:alpha:]_@]")
formatTag := func(l bug.Label) string {
@@ -310,7 +288,7 @@ func bugsOrgmodeFormatter(env *execenv.Env, bugExcerpts []*cache.BugExcerpt) err
env.Out.Println("#+TODO: OPEN | CLOSED")
- for _, b := range bugExcerpts {
+ for _, b := range excerpts {
status := strings.ToUpper(b.Status.String())
var title string
@@ -2,7 +2,7 @@ package bugcmd
import (
"fmt"
- "io/ioutil"
+ "os"
"strings"
"testing"
"time"
@@ -10,7 +10,6 @@ import (
"github.com/stretchr/testify/require"
"github.com/MichaelMure/git-bug/commands/bug/testenv"
- "github.com/MichaelMure/git-bug/commands/cmdtest"
"github.com/MichaelMure/git-bug/commands/execenv"
)
@@ -143,7 +142,7 @@ func requireCommentsEqual(t *testing.T, golden string, env *execenv.Env) {
t.Log("Got here")
for i, comment := range comments {
fileName := fmt.Sprintf(goldenFilePattern, golden, i)
- require.NoError(t, ioutil.WriteFile(fileName, []byte(comment.message), 0644))
+ require.NoError(t, os.WriteFile(fileName, []byte(comment.message), 0644))
}
}
@@ -157,7 +156,7 @@ func requireCommentsEqual(t *testing.T, golden string, env *execenv.Env) {
require.Equal(t, date.Add(time.Duration(i)*time.Minute), comment.date)
fileName := fmt.Sprintf(goldenFilePattern, golden, i)
- exp, err := ioutil.ReadFile(fileName)
+ exp, err := os.ReadFile(fileName)
require.NoError(t, err)
require.Equal(t, strings.ReplaceAll(string(exp), "\r", ""), strings.ReplaceAll(comment.message, "\r", ""))
}
@@ -2,7 +2,6 @@ package bugcmd
import (
"encoding/json"
- "fmt"
"testing"
"github.com/stretchr/testify/require"
@@ -61,44 +60,33 @@ $`
format string
exp string
}{
- {"default", "^[0-9a-f]{7}\topen\tthis is a bug title \tJohn Doe \t\n$"},
- {"plain", "^[0-9a-f]{7} \\[open\\] this is a bug title\n$"},
- {"compact", "^[0-9a-f]{7} open this is a bug title John Doe\n$"},
+ {"default", "^[0-9a-f]{7}\topen\tthis is a bug title John Doe \n$"},
+ {"plain", "^[0-9a-f]{7}\topen\tthis is a bug title\n$"},
{"id", "^[0-9a-f]{64}\n$"},
{"org-mode", expOrgMode},
+ {"json", ".*"},
}
for _, testcase := range cases {
- opts := bugOptions{
- sortDirection: "asc",
- sortBy: "creation",
- outputFormat: testcase.format,
- }
-
- name := fmt.Sprintf("with %s format", testcase.format)
-
- t.Run(name, func(t *testing.T) {
+ t.Run(testcase.format, func(t *testing.T) {
env, _ := testenv.NewTestEnvAndBug(t)
+ opts := bugOptions{
+ sortDirection: "asc",
+ sortBy: "creation",
+ outputFormat: testcase.format,
+ }
+
require.NoError(t, runBug(env, opts, []string{}))
- require.Regexp(t, testcase.exp, env.Out.String())
+
+ switch testcase.format {
+ case "json":
+ var bugs []cmdjson.BugExcerpt
+ require.NoError(t, json.Unmarshal(env.Out.Bytes(), &bugs))
+ require.Len(t, bugs, 1)
+ default:
+ require.Regexp(t, testcase.exp, env.Out.String())
+ }
})
}
-
- t.Run("with JSON format", func(t *testing.T) {
- opts := bugOptions{
- sortDirection: "asc",
- sortBy: "creation",
- outputFormat: "json",
- }
-
- env, _ := testenv.NewTestEnvAndBug(t)
-
- require.NoError(t, runBug(env, opts, []string{}))
-
- var bugs []cmdjson.BugExcerpt
- require.NoError(t, json.Unmarshal(env.Out.Bytes(), &bugs))
-
- require.Len(t, bugs, 1)
- })
}
@@ -13,14 +13,8 @@ git-bug-bridge-new - Configure a new bridge
.SH DESCRIPTION
.PP
-.RS
-
-.nf
Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.
-.fi
-.RE
-
.SH OPTIONS
.PP
@@ -61,8 +61,8 @@ You can pass an additional query to filter and order the list. This query can be
Select the sorting direction. Valid values are [asc,desc]
.PP
-\fB-f\fP, \fB--format\fP="default"
- Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode]
+\fB-f\fP, \fB--format\fP=""
+ Select the output formatting style. Valid values are [default,plain,id,json,org-mode]
.PP
\fB-h\fP, \fB--help\fP[=false]
@@ -4,7 +4,7 @@ Configure a new bridge
### Synopsis
- Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.
+Configure a new bridge by passing flags or/and using interactive terminal prompts. You can avoid all the terminal prompts by passing all the necessary flags to configure your bridge.
```
git-bug bridge new [flags]
@@ -42,7 +42,7 @@ git bug status:open --by creation "foo bar" baz
-n, --no strings Filter by absence of something. Valid values are [label]
-b, --by string Sort the results by a characteristic. Valid values are [id,creation,edit] (default "creation")
-d, --direction string Select the sorting direction. Valid values are [asc,desc] (default "asc")
- -f, --format string Select the output formatting style. Valid values are [default,plain,compact,id,json,org-mode] (default "default")
+ -f, --format string Select the output formatting style. Valid values are [default,plain,id,json,org-mode]
-h, --help help for bug
```