1package bugcmd
2
3import (
4 "fmt"
5 "regexp"
6 "strings"
7 "time"
8
9 text "github.com/MichaelMure/go-term-text"
10 "github.com/spf13/cobra"
11
12 "github.com/MichaelMure/git-bug/cache"
13 "github.com/MichaelMure/git-bug/commands/cmdjson"
14 "github.com/MichaelMure/git-bug/commands/completion"
15 "github.com/MichaelMure/git-bug/commands/execenv"
16 "github.com/MichaelMure/git-bug/entities/bug"
17 "github.com/MichaelMure/git-bug/entities/common"
18 "github.com/MichaelMure/git-bug/entity"
19 "github.com/MichaelMure/git-bug/query"
20 "github.com/MichaelMure/git-bug/util/colors"
21)
22
23type bugOptions struct {
24 statusQuery []string
25 authorQuery []string
26 metadataQuery []string
27 participantQuery []string
28 actorQuery []string
29 labelQuery []string
30 titleQuery []string
31 noQuery []string
32 sortBy string
33 sortDirection string
34 outputFormat string
35}
36
37func NewBugCommand() *cobra.Command {
38 env := execenv.NewEnv()
39 options := bugOptions{}
40
41 cmd := &cobra.Command{
42 Use: "bug [QUERY]",
43 Short: "List bugs",
44 Long: `Display a summary of each bugs.
45
46You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned.`,
47 Example: `List open bugs sorted by last edition with a query:
48git bug status:open sort:edit-desc
49
50List closed bugs sorted by creation with flags:
51git bug --status closed --by creation
52
53Do a full text search of all bugs:
54git bug "foo bar" baz
55
56Use queries, flags, and full text search:
57git bug status:open --by creation "foo bar" baz
58`,
59 PreRunE: execenv.LoadBackend(env),
60 RunE: execenv.CloseBackend(env, func(cmd *cobra.Command, args []string) error {
61 return runBug(env, options, args)
62 }),
63 ValidArgsFunction: completion.Ls(env),
64 }
65
66 flags := cmd.Flags()
67 flags.SortFlags = false
68
69 flags.StringSliceVarP(&options.statusQuery, "status", "s", nil,
70 "Filter by status. Valid values are [open,closed]")
71 cmd.RegisterFlagCompletionFunc("status", completion.From([]string{"open", "closed"}))
72 flags.StringSliceVarP(&options.authorQuery, "author", "a", nil,
73 "Filter by author")
74 flags.StringSliceVarP(&options.metadataQuery, "metadata", "m", nil,
75 "Filter by metadata. Example: github-url=URL")
76 cmd.RegisterFlagCompletionFunc("author", completion.UserForQuery(env))
77 flags.StringSliceVarP(&options.participantQuery, "participant", "p", nil,
78 "Filter by participant")
79 cmd.RegisterFlagCompletionFunc("participant", completion.UserForQuery(env))
80 flags.StringSliceVarP(&options.actorQuery, "actor", "A", nil,
81 "Filter by actor")
82 cmd.RegisterFlagCompletionFunc("actor", completion.UserForQuery(env))
83 flags.StringSliceVarP(&options.labelQuery, "label", "l", nil,
84 "Filter by label")
85 cmd.RegisterFlagCompletionFunc("label", completion.Label(env))
86 flags.StringSliceVarP(&options.titleQuery, "title", "t", nil,
87 "Filter by title")
88 flags.StringSliceVarP(&options.noQuery, "no", "n", nil,
89 "Filter by absence of something. Valid values are [label]")
90 cmd.RegisterFlagCompletionFunc("no", completion.Label(env))
91 flags.StringVarP(&options.sortBy, "by", "b", "creation",
92 "Sort the results by a characteristic. Valid values are [id,creation,edit]")
93 cmd.RegisterFlagCompletionFunc("by", completion.From([]string{"id", "creation", "edit"}))
94 flags.StringVarP(&options.sortDirection, "direction", "d", "asc",
95 "Select the sorting direction. Valid values are [asc,desc]")
96 cmd.RegisterFlagCompletionFunc("direction", completion.From([]string{"asc", "desc"}))
97 flags.StringVarP(&options.outputFormat, "format", "f", "",
98 "Select the output formatting style. Valid values are [default,plain,id,json,org-mode]")
99 cmd.RegisterFlagCompletionFunc("format",
100 completion.From([]string{"default", "plain", "id", "json", "org-mode"}))
101
102 const selectGroup = "select"
103 cmd.AddGroup(&cobra.Group{ID: selectGroup, Title: "Implicit selection"})
104
105 addCmdWithGroup := func(child *cobra.Command, groupID string) {
106 cmd.AddCommand(child)
107 child.GroupID = groupID
108 }
109
110 addCmdWithGroup(newBugDeselectCommand(), selectGroup)
111 addCmdWithGroup(newBugSelectCommand(), selectGroup)
112
113 cmd.AddCommand(newBugCommentCommand())
114 cmd.AddCommand(newBugLabelCommand())
115 cmd.AddCommand(newBugNewCommand())
116 cmd.AddCommand(newBugRmCommand())
117 cmd.AddCommand(newBugShowCommand())
118 cmd.AddCommand(newBugStatusCommand())
119 cmd.AddCommand(newBugTitleCommand())
120
121 return cmd
122}
123
124func runBug(env *execenv.Env, opts bugOptions, args []string) error {
125 var q *query.Query
126 var err error
127
128 if len(args) >= 1 {
129 // either the shell or cobra remove the quotes, we need them back for the query parsing
130 assembled := repairQuery(args)
131
132 q, err = query.Parse(assembled)
133 if err != nil {
134 return err
135 }
136 } else {
137 q = query.NewQuery()
138 }
139
140 err = completeQuery(q, opts)
141 if err != nil {
142 return err
143 }
144
145 allIds, err := env.Backend.Bugs().Query(q)
146 if err != nil {
147 return err
148 }
149
150 excerpts := make([]*cache.BugExcerpt, len(allIds))
151 for i, id := range allIds {
152 b, err := env.Backend.Bugs().ResolveExcerpt(id)
153 if err != nil {
154 return err
155 }
156 excerpts[i] = b
157 }
158
159 switch opts.outputFormat {
160 case "":
161 if env.Out.IsTerminal() {
162 return bugsDefaultFormatter(env, excerpts)
163 } else {
164 return bugsPlainFormatter(env, excerpts)
165 }
166 case "default":
167 return bugsDefaultFormatter(env, excerpts)
168 case "id":
169 return bugsIDFormatter(env, excerpts)
170 case "plain":
171 return bugsPlainFormatter(env, excerpts)
172 case "json":
173 return bugsJsonFormatter(env, excerpts)
174 case "org-mode":
175 return bugsOrgmodeFormatter(env, excerpts)
176 default:
177 return fmt.Errorf("unknown format %s", opts.outputFormat)
178 }
179}
180
181func repairQuery(args []string) string {
182 for i, arg := range args {
183 split := strings.Split(arg, ":")
184 for j, s := range split {
185 if strings.Contains(s, " ") {
186 split[j] = fmt.Sprintf("\"%s\"", s)
187 }
188 }
189 args[i] = strings.Join(split, ":")
190 }
191 return strings.Join(args, " ")
192}
193
194func bugsJsonFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
195 jsonBugs := make([]cmdjson.BugExcerpt, len(excerpts))
196 for i, b := range excerpts {
197 jsonBug, err := cmdjson.NewBugExcerpt(env.Backend, b)
198 if err != nil {
199 return err
200 }
201 jsonBugs[i] = jsonBug
202 }
203 return env.Out.PrintJSON(jsonBugs)
204}
205
206func bugsIDFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
207 for _, b := range excerpts {
208 env.Out.Println(b.Id().String())
209 }
210
211 return nil
212}
213
214func bugsDefaultFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
215 width := env.Out.Width()
216 widthId := entity.HumanIdLength
217 widthStatus := len("closed")
218 widthComment := 6
219
220 widthRemaining := width -
221 widthId - 1 -
222 widthStatus - 1 -
223 widthComment - 1
224
225 widthTitle := int(float32(widthRemaining-3) * 0.7)
226 if widthTitle < 0 {
227 widthTitle = 0
228 }
229
230 widthRemaining = widthRemaining - widthTitle - 3 - 2
231 widthAuthor := widthRemaining
232
233 for _, b := range excerpts {
234 author, err := env.Backend.Identities().ResolveExcerpt(b.AuthorId)
235 if err != nil {
236 return err
237 }
238
239 var labelsTxt strings.Builder
240 for _, l := range b.Labels {
241 lc256 := l.Color().Term256()
242 labelsTxt.WriteString(lc256.Escape())
243 labelsTxt.WriteString(" ◼")
244 labelsTxt.WriteString(lc256.Unescape())
245 }
246
247 // truncate + pad if needed
248 labelsFmt := text.TruncateMax(labelsTxt.String(), 10)
249 titleFmt := text.LeftPadMaxLine(strings.TrimSpace(b.Title), widthTitle-text.Len(labelsFmt), 0)
250 authorFmt := text.LeftPadMaxLine(author.DisplayName(), widthAuthor, 0)
251
252 comments := fmt.Sprintf("%3d 💬", b.LenComments-1)
253 if b.LenComments-1 <= 0 {
254 comments = ""
255 }
256 if b.LenComments-1 > 999 {
257 comments = " ∞ 💬"
258 }
259
260 env.Out.Printf("%s\t%s\t%s %s %s\n",
261 colors.Cyan(b.Id().Human()),
262 colors.Yellow(b.Status),
263 titleFmt+labelsFmt,
264 colors.Magenta(authorFmt),
265 comments,
266 )
267 }
268 return nil
269}
270
271func bugsPlainFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
272 for _, b := range excerpts {
273 env.Out.Printf("%s\t%s\t%s\n", b.Id().Human(), b.Status, strings.TrimSpace(b.Title))
274 }
275 return nil
276}
277
278func bugsOrgmodeFormatter(env *execenv.Env, excerpts []*cache.BugExcerpt) error {
279 // see https://orgmode.org/manual/Tags.html
280 orgTagRe := regexp.MustCompile("[^[:alpha:]_@]")
281 formatTag := func(l bug.Label) string {
282 return orgTagRe.ReplaceAllString(l.String(), "_")
283 }
284
285 formatTime := func(time time.Time) string {
286 return time.Format("[2006-01-02 Mon 15:05]")
287 }
288
289 env.Out.Println("#+TODO: OPEN | CLOSED")
290
291 for _, b := range excerpts {
292 status := strings.ToUpper(b.Status.String())
293
294 var title string
295 if link, ok := b.CreateMetadata["github-url"]; ok {
296 title = fmt.Sprintf("[[%s][%s]]", link, b.Title)
297 } else {
298 title = b.Title
299 }
300
301 author, err := env.Backend.Identities().ResolveExcerpt(b.AuthorId)
302 if err != nil {
303 return err
304 }
305
306 var labels strings.Builder
307 labels.WriteString(":")
308 for i, l := range b.Labels {
309 if i > 0 {
310 labels.WriteString(":")
311 }
312 labels.WriteString(formatTag(l))
313 }
314 labels.WriteString(":")
315
316 env.Out.Printf("* %-6s %s %s %s: %s %s\n",
317 status,
318 b.Id().Human(),
319 formatTime(b.CreateTime()),
320 author.DisplayName(),
321 title,
322 labels.String(),
323 )
324
325 env.Out.Printf("** Last Edited: %s\n", formatTime(b.EditTime()))
326
327 env.Out.Printf("** Actors:\n")
328 for _, element := range b.Actors {
329 actor, err := env.Backend.Identities().ResolveExcerpt(element)
330 if err != nil {
331 return err
332 }
333
334 env.Out.Printf(": %s %s\n",
335 actor.Id().Human(),
336 actor.DisplayName(),
337 )
338 }
339
340 env.Out.Printf("** Participants:\n")
341 for _, element := range b.Participants {
342 participant, err := env.Backend.Identities().ResolveExcerpt(element)
343 if err != nil {
344 return err
345 }
346
347 env.Out.Printf(": %s %s\n",
348 participant.Id().Human(),
349 participant.DisplayName(),
350 )
351 }
352 }
353
354 return nil
355}
356
357// Finish the command flags transformation into the query.Query
358func completeQuery(q *query.Query, opts bugOptions) error {
359 for _, str := range opts.statusQuery {
360 status, err := common.StatusFromString(str)
361 if err != nil {
362 return err
363 }
364 q.Status = append(q.Status, status)
365 }
366
367 q.Author = append(q.Author, opts.authorQuery...)
368 for _, str := range opts.metadataQuery {
369 tokens := strings.Split(str, "=")
370 if len(tokens) < 2 {
371 return fmt.Errorf("no \"=\" in key=value metadata markup")
372 }
373 var pair query.StringPair
374 pair.Key = tokens[0]
375 pair.Value = tokens[1]
376 q.Metadata = append(q.Metadata, pair)
377 }
378 q.Participant = append(q.Participant, opts.participantQuery...)
379 q.Actor = append(q.Actor, opts.actorQuery...)
380 q.Label = append(q.Label, opts.labelQuery...)
381 q.Title = append(q.Title, opts.titleQuery...)
382
383 for _, no := range opts.noQuery {
384 switch no {
385 case "label":
386 q.NoLabel = true
387 default:
388 return fmt.Errorf("unknown \"no\" filter %s", no)
389 }
390 }
391
392 switch opts.sortBy {
393 case "id":
394 q.OrderBy = query.OrderById
395 case "creation":
396 q.OrderBy = query.OrderByCreation
397 case "edit":
398 q.OrderBy = query.OrderByEdit
399 default:
400 return fmt.Errorf("unknown sort flag %s", opts.sortBy)
401 }
402
403 switch opts.sortDirection {
404 case "asc":
405 q.OrderDirection = query.OrderAscending
406 case "desc":
407 q.OrderDirection = query.OrderDescending
408 default:
409 return fmt.Errorf("unknown sort direction %s", opts.sortDirection)
410 }
411
412 return nil
413}