1package commands
2
3import (
4 "encoding/json"
5 "fmt"
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/bug"
13 "github.com/MichaelMure/git-bug/cache"
14 "github.com/MichaelMure/git-bug/query"
15 "github.com/MichaelMure/git-bug/util/colors"
16 "github.com/MichaelMure/git-bug/util/interrupt"
17)
18
19var (
20 lsQuery query.Query
21
22 lsStatusQuery []string
23 lsNoQuery []string
24 lsSortBy string
25 lsSortDirection string
26 lsOutputFormat string
27)
28
29func runLsBug(_ *cobra.Command, args []string) error {
30 backend, err := cache.NewRepoCache(repo)
31 if err != nil {
32 return err
33 }
34 defer backend.Close()
35 interrupt.RegisterCleaner(backend.Close)
36
37 var q *query.Query
38 if len(args) >= 1 {
39 q, err = query.Parse(strings.Join(args, " "))
40
41 if err != nil {
42 return err
43 }
44 } else {
45 err = completeQuery()
46 if err != nil {
47 return err
48 }
49 q = &lsQuery
50 }
51
52 allIds := backend.QueryBugs(q)
53
54 bugExcerpt := make([]*cache.BugExcerpt, len(allIds))
55 for i, id := range allIds {
56 b, err := backend.ResolveBugExcerpt(id)
57 if err != nil {
58 return err
59 }
60 bugExcerpt[i] = b
61 }
62
63 switch lsOutputFormat {
64 case "plain":
65 return lsPlainFormatter(backend, bugExcerpt)
66 case "json":
67 return lsJsonFormatter(backend, bugExcerpt)
68 case "default":
69 return lsDefaultFormatter(backend, bugExcerpt)
70 default:
71 return fmt.Errorf("unknown format %s", lsOutputFormat)
72 }
73}
74
75type JSONBug struct {
76 Id string `json:"id"`
77 HumanId string `json:"human_id"`
78 CreationTime time.Time `json:"creation_time"`
79 LastEdited time.Time `json:"last_edited"`
80
81 Status string `json:"status"`
82 Labels []bug.Label `json:"labels"`
83 Title string `json:"title"`
84 Actors []JSONIdentity `json:"actors"`
85 Participants []JSONIdentity `json:"participants"`
86 Author JSONIdentity `json:"author"`
87
88 Comments int `json:"comments"`
89 Metadata map[string]string `json:"metadata"`
90}
91
92type JSONIdentity struct {
93 Id string `json:"id"`
94 HumanId string `json:"human_id"`
95 Name string `json:"name"`
96 Login string `json:"login"`
97}
98
99func lsJsonFormatter(backend *cache.RepoCache, bugExcerpts []*cache.BugExcerpt) error {
100 jsonBugs := make([]JSONBug, len(bugExcerpts))
101 for i, b := range bugExcerpts {
102 jsonBug := JSONBug{
103 b.Id.String(),
104 b.Id.Human(),
105 time.Unix(b.CreateUnixTime, 0),
106 time.Unix(b.EditUnixTime, 0),
107 b.Status.String(),
108 b.Labels,
109 b.Title,
110 []JSONIdentity{},
111 []JSONIdentity{},
112 JSONIdentity{},
113 b.LenComments,
114 b.CreateMetadata,
115 }
116
117 if b.AuthorId != "" {
118 author, err := backend.ResolveIdentityExcerpt(b.AuthorId)
119 if err != nil {
120 return err
121 }
122
123 jsonBug.Author.Name = author.DisplayName()
124 jsonBug.Author.Login = author.Login
125 jsonBug.Author.Id = author.Id.String()
126 jsonBug.Author.HumanId = author.Id.Human()
127 } else {
128 jsonBug.Author.Name = b.LegacyAuthor.DisplayName()
129 jsonBug.Author.Login = b.LegacyAuthor.Login
130 }
131
132 for _, element := range b.Actors {
133 actor, err := backend.ResolveIdentityExcerpt(element)
134 if err != nil {
135 return err
136 }
137
138 jsonBug.Actors = append(jsonBug.Actors, JSONIdentity{
139 actor.Id.String(),
140 actor.Id.Human(),
141 actor.Name,
142 actor.Login,
143 })
144 }
145
146 for _, element := range b.Participants {
147 participant, err := backend.ResolveIdentityExcerpt(element)
148 if err != nil {
149 return err
150 }
151 jsonBug.Participants = append(jsonBug.Participants, JSONIdentity{
152 participant.Id.String(),
153 participant.Id.Human(),
154 participant.DisplayName(),
155 participant.Login,
156 })
157 }
158
159 jsonBugs[i] = jsonBug
160 }
161 jsonObject, _ := json.MarshalIndent(jsonBugs, "", " ")
162 fmt.Printf("%s\n", jsonObject)
163 return nil
164}
165
166func lsDefaultFormatter(backend *cache.RepoCache, bugExcerpts []*cache.BugExcerpt) error {
167 for _, b := range bugExcerpts {
168 var name string
169 if b.AuthorId != "" {
170 author, err := backend.ResolveIdentityExcerpt(b.AuthorId)
171 if err != nil {
172 return err
173 }
174 name = author.DisplayName()
175 } else {
176 name = b.LegacyAuthor.DisplayName()
177 }
178
179 var labelsTxt strings.Builder
180 for _, l := range b.Labels {
181 lc256 := l.Color().Term256()
182 labelsTxt.WriteString(lc256.Escape())
183 labelsTxt.WriteString(" ◼")
184 labelsTxt.WriteString(lc256.Unescape())
185 }
186
187 // truncate + pad if needed
188 labelsFmt := text.TruncateMax(labelsTxt.String(), 10)
189 titleFmt := text.LeftPadMaxLine(b.Title, 50-text.Len(labelsFmt), 0)
190 authorFmt := text.LeftPadMaxLine(name, 15, 0)
191
192 comments := fmt.Sprintf("%4d 💬", b.LenComments)
193 if b.LenComments > 9999 {
194 comments = " ∞ 💬"
195 }
196
197 fmt.Printf("%s %s\t%s\t%s\t%s\n",
198 colors.Cyan(b.Id.Human()),
199 colors.Yellow(b.Status),
200 titleFmt+labelsFmt,
201 colors.Magenta(authorFmt),
202 comments,
203 )
204 }
205 return nil
206}
207
208func lsPlainFormatter(_ *cache.RepoCache, bugExcerpts []*cache.BugExcerpt) error {
209 for _, b := range bugExcerpts {
210 fmt.Printf("[%s] %s\n", b.Status, b.Title)
211 }
212 return nil
213}
214
215// Finish the command flags transformation into the query.Query
216func completeQuery() error {
217 for _, str := range lsStatusQuery {
218 status, err := bug.StatusFromString(str)
219 if err != nil {
220 return err
221 }
222 lsQuery.Status = append(lsQuery.Status, status)
223 }
224
225 for _, no := range lsNoQuery {
226 switch no {
227 case "label":
228 lsQuery.NoLabel = true
229 default:
230 return fmt.Errorf("unknown \"no\" filter %s", no)
231 }
232 }
233
234 switch lsSortBy {
235 case "id":
236 lsQuery.OrderBy = query.OrderById
237 case "creation":
238 lsQuery.OrderBy = query.OrderByCreation
239 case "edit":
240 lsQuery.OrderBy = query.OrderByEdit
241 default:
242 return fmt.Errorf("unknown sort flag %s", lsSortBy)
243 }
244
245 switch lsSortDirection {
246 case "asc":
247 lsQuery.OrderDirection = query.OrderAscending
248 case "desc":
249 lsQuery.OrderDirection = query.OrderDescending
250 default:
251 return fmt.Errorf("unknown sort direction %s", lsSortDirection)
252 }
253
254 return nil
255}
256
257var lsCmd = &cobra.Command{
258 Use: "ls [<query>]",
259 Short: "List bugs.",
260 Long: `Display a summary of each bugs.
261
262You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language or with flags.`,
263 Example: `List open bugs sorted by last edition with a query:
264git bug ls status:open sort:edit-desc
265
266List closed bugs sorted by creation with flags:
267git bug ls --status closed --by creation
268`,
269 PreRunE: loadRepo,
270 RunE: runLsBug,
271}
272
273func init() {
274 RootCmd.AddCommand(lsCmd)
275
276 lsCmd.Flags().SortFlags = false
277
278 lsCmd.Flags().StringSliceVarP(&lsStatusQuery, "status", "s", nil,
279 "Filter by status. Valid values are [open,closed]")
280 lsCmd.Flags().StringSliceVarP(&lsQuery.Author, "author", "a", nil,
281 "Filter by author")
282 lsCmd.Flags().StringSliceVarP(&lsQuery.Participant, "participant", "p", nil,
283 "Filter by participant")
284 lsCmd.Flags().StringSliceVarP(&lsQuery.Actor, "actor", "A", nil,
285 "Filter by actor")
286 lsCmd.Flags().StringSliceVarP(&lsQuery.Label, "label", "l", nil,
287 "Filter by label")
288 lsCmd.Flags().StringSliceVarP(&lsQuery.Title, "title", "t", nil,
289 "Filter by title")
290 lsCmd.Flags().StringSliceVarP(&lsNoQuery, "no", "n", nil,
291 "Filter by absence of something. Valid values are [label]")
292 lsCmd.Flags().StringVarP(&lsSortBy, "by", "b", "creation",
293 "Sort the results by a characteristic. Valid values are [id,creation,edit]")
294 lsCmd.Flags().StringVarP(&lsSortDirection, "direction", "d", "asc",
295 "Select the sorting direction. Valid values are [asc,desc]")
296 lsCmd.Flags().StringVarP(&lsOutputFormat, "format", "f", "default",
297 "Select the output formatting style. Valid values are [default, plain(text), json]")
298}