feat: Support CSV when listing issues (#854)

Author: ankitpokhrel

README.md

@@ -177,6 +177,12 @@ $ jira issue list -s"To Do"
 # List recent issues in plain mode
 $ jira issue list --plain
 
+# List recent issues in raw JSON format
+$ jira issue list --raw
+
+# List recent issues in csv format
+$ jira issue list --csv
+
 # List issue in the same order as you see in the UI
 $ jira issue list --order-by rank --reverse
 

internal/cmd/epic/list/list.go

@@ -127,6 +127,9 @@ func singleEpicView(flags query.FlagParser, key, project, projectType, server st
 	plain, err := flags.GetBool("plain")
 	cmdutil.ExitIfError(err)
 
+	csv, err := flags.GetBool("csv")
+	cmdutil.ExitIfError(err)
+
 	noHeaders, err := flags.GetBool("no-headers")
 	cmdutil.ExitIfError(err)
 
@@ -149,6 +152,7 @@ func singleEpicView(flags query.FlagParser, key, project, projectType, server st
 		},
 		Display: view.DisplayFormat{
 			Plain:        plain,
+			CSV:          csv,
 			NoHeaders:    noHeaders,
 			NoTruncate:   noTruncate,
 			FixedColumns: fixedColumns,

internal/cmd/issue/list/list.go

@@ -141,6 +141,9 @@ func loadList(cmd *cobra.Command, args []string) {
 	plain, err := cmd.Flags().GetBool("plain")
 	cmdutil.ExitIfError(err)
 
+	csv, err := cmd.Flags().GetBool("csv")
+	cmdutil.ExitIfError(err)
+
 	noHeaders, err := cmd.Flags().GetBool("no-headers")
 	cmdutil.ExitIfError(err)
 
@@ -171,6 +174,7 @@ func loadList(cmd *cobra.Command, args []string) {
 		},
 		Display: view.DisplayFormat{
 			Plain:        plain,
+			CSV:          csv,
 			NoHeaders:    noHeaders,
 			NoTruncate:   noTruncate,
 			FixedColumns: fixedColumns,
@@ -234,6 +238,7 @@ func SetFlags(cmd *cobra.Command) {
 	cmd.Flags().Bool("no-truncate", false, "Show all available columns in plain mode. Works only with --plain")
 	cmd.Flags().Uint("comments", 1, "Show N comments when viewing the issue")
 	cmd.Flags().Bool("raw", false, "Print raw JSON output")
+	cmd.Flags().Bool("csv", false, "Print output in CSV format")
 
 	if cmd.HasParent() && cmd.Parent().Name() != "sprint" {
 		cmd.Flags().String("columns", "", "Comma separated list of columns to display in the plain mode.\n"+

internal/cmd/sprint/list/list.go

@@ -121,6 +121,9 @@ func singleSprintView(sprintQuery *query.Sprint, flags query.FlagParser, boardID
 	plain, err := flags.GetBool("plain")
 	cmdutil.ExitIfError(err)
 
+	csv, err := flags.GetBool("csv")
+	cmdutil.ExitIfError(err)
+
 	noHeaders, err := flags.GetBool("no-headers")
 	cmdutil.ExitIfError(err)
 
@@ -166,6 +169,7 @@ func singleSprintView(sprintQuery *query.Sprint, flags query.FlagParser, boardID
 		},
 		Display: view.DisplayFormat{
 			Plain:        plain,
+			CSV:          csv,
 			NoHeaders:    noHeaders,
 			NoTruncate:   noTruncate,
 			FixedColumns: fixedColumns,

internal/view/helper.go

@@ -1,6 +1,7 @@
 package view
 
 import (
+	"encoding/csv"
 	"fmt"
 	"io"
 	"os"
@@ -116,7 +117,7 @@ func prepareTitle(text string) string {
 	return tview.Escape(text)
 }
 
-func issueKeyFromTuiData(r int, d interface{}) string {
+func issueKeyFromTuiData(r int, d any) string {
 	var path string
 
 	switch data := d.(type) {
@@ -129,24 +130,24 @@ func issueKeyFromTuiData(r int, d interface{}) string {
 	return path
 }
 
-func jiraURLFromTuiData(server string, r int, d interface{}) string {
+func jiraURLFromTuiData(server string, r int, d any) string {
 	return cmdutil.GenerateServerBrowseURL(server, issueKeyFromTuiData(r, d))
 }
 
 func navigate(server string) tui.SelectedFunc {
-	return func(r, _ int, d interface{}) {
+	return func(r, _ int, d any) {
 		_ = browser.Browse(jiraURLFromTuiData(server, r, d))
 	}
 }
 
 func copyURL(server string) tui.CopyFunc {
-	return func(r, _ int, d interface{}) {
+	return func(r, _ int, d any) {
 		_ = clipboard.WriteAll(jiraURLFromTuiData(server, r, d))
 	}
 }
 
 func copyKey() tui.CopyKeyFunc {
-	return func(r, _ int, d interface{}) {
+	return func(r, _ int, d any) {
 		_ = clipboard.WriteAll(issueKeyFromTuiData(r, d))
 	}
 }
@@ -169,6 +170,22 @@ func renderPlain(w io.Writer, data tui.TableData) error {
 	return nil
 }
 
+func renderCSV(w io.Writer, data tui.TableData) error {
+	csvwrt := csv.NewWriter(w)
+
+	for _, items := range data {
+		if err := csvwrt.Write(items); err != nil {
+			return err
+		}
+	}
+
+	csvwrt.Flush()
+	if err := csvwrt.Error(); err != nil {
+		return err
+	}
+	return nil
+}
+
 func unescape(s string) string {
 	pattern := regexp.MustCompile(`(\[[a-zA-Z0-9_,;: \-\."#]+\[*)\[\]`)
 	return pattern.ReplaceAllString(s, "$1]")

internal/view/issues.go

@@ -16,6 +16,7 @@ import (
 // DisplayFormat is a issue display type.
 type DisplayFormat struct {
 	Plain        bool
+	CSV          bool
 	NoHeaders    bool
 	NoTruncate   bool
 	Columns      []string
@@ -43,6 +44,11 @@ func (l *IssueList) Render() error {
 		return l.renderPlain(w)
 	}
 
+	if l.Display.CSV {
+		w := os.Stdout
+		return l.renderCSV(w)
+	}
+
 	renderer, err := MDRenderer()
 	if err != nil {
 		return err
@@ -123,11 +129,16 @@ func (l *IssueList) Render() error {
 	return view.Paint(data)
 }
 
-// renderPlain renders the issue in plain view.
+// renderPlain renders issues in plain formatted view.
 func (l *IssueList) renderPlain(w io.Writer) error {
 	return renderPlain(w, l.data())
 }
 
+// renderCSV renders issues in csv format.
+func (l *IssueList) renderCSV(w io.Writer) error {
+	return renderCSV(w, l.data())
+}
+
 func (*IssueList) validColumnsMap() map[string]struct{} {
 	columns := ValidIssueColumns()
 	out := make(map[string]struct{}, len(columns))
@@ -177,12 +188,9 @@ func (l *IssueList) data() tui.TableData {
 	var data tui.TableData
 
 	headers := l.header()
-	if !l.Display.Plain || !l.Display.NoHeaders {
+	if (!l.Display.Plain && !l.Display.CSV) || !l.Display.NoHeaders {
 		data = append(data, headers)
 	}
-	if len(headers) == 0 {
-		headers = ValidIssueColumns()
-	}
 	for _, iss := range l.Data {
 		data = append(data, l.assignColumns(headers, iss))
 	}