feat: Support custom delimiter (#662)

Author: iksi4prs

internal/cmd/issue/list/list.go

@@ -50,6 +50,9 @@ $ jira issue list --plain --columns key,assignee,status
 # List issues in a plain table view and show all fields
 $ jira issue list --plain --no-truncate
 
+# List issues in a plain table view using custom delimiter (default is "\t")
+$ jira issue list --plain --delimeter "|"
+
 # List issues as raw JSON data
 $ jira issue list --raw
 
@@ -141,6 +144,10 @@ func loadList(cmd *cobra.Command, args []string) {
 	plain, err := cmd.Flags().GetBool("plain")
 	cmdutil.ExitIfError(err)
 
+
+	delimiter, err := cmd.Flags().GetString("delimiter")
+	cmdutil.ExitIfError(err)
+  
 	csv, err := cmd.Flags().GetBool("csv")
 	cmdutil.ExitIfError(err)
 
@@ -174,6 +181,7 @@ func loadList(cmd *cobra.Command, args []string) {
 		},
 		Display: view.DisplayFormat{
 			Plain:        plain,
+			Delimiter:    delimiter,
 			CSV:          csv,
 			NoHeaders:    noHeaders,
 			NoTruncate:   noTruncate,
@@ -236,6 +244,7 @@ func SetFlags(cmd *cobra.Command) {
 	cmd.Flags().Bool("plain", false, "Display output in plain mode")
 	cmd.Flags().Bool("no-headers", false, "Don't display table headers in plain mode. Works only with --plain")
 	cmd.Flags().Bool("no-truncate", false, "Show all available columns in plain mode. Works only with --plain")
+	cmd.Flags().String("delimiter", "\t", "Custom delimeter for 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")

internal/view/helper.go

@@ -152,13 +152,13 @@ func copyKey() tui.CopyKeyFunc {
 	}
 }
 
-func renderPlain(w io.Writer, data tui.TableData) error {
+func renderPlain(w io.Writer, data tui.TableData, delimiter string) error {
 	for _, items := range data {
 		n := len(items)
 		for j, v := range items {
 			_, _ = fmt.Fprintf(w, "%s", unescape(v))
 			if j != n-1 {
-				_, _ = fmt.Fprintf(w, "\t")
+				fmt.Fprintf(w, "%s", delimiter)
 			}
 		}
 		_, _ = fmt.Fprintln(w)

internal/view/issues.go

@@ -16,6 +16,7 @@ import (
 // DisplayFormat is a issue display type.
 type DisplayFormat struct {
 	Plain        bool
+	Delimiter    string
 	CSV          bool
 	NoHeaders    bool
 	NoTruncate   bool
@@ -40,8 +41,13 @@ type IssueList struct {
 // Render renders the view.
 func (l *IssueList) Render() error {
 	if l.Display.Plain || tui.IsDumbTerminal() || tui.IsNotTTY() {
+		// custom delimiter is used only in plain mode, otherwise \t is used
+		delimeter := "\t"
+		if l.Display.Plain {
+			delimeter = l.Display.Delimiter
+		}
 		w := tabwriter.NewWriter(os.Stdout, 0, tabWidth, 1, '\t', 0)
-		return l.renderPlain(w)
+		return l.renderPlain(w, delimeter)
 	}
 
 	if l.Display.CSV {
@@ -129,9 +135,9 @@ func (l *IssueList) Render() error {
 	return view.Paint(data)
 }
 
-// renderPlain renders issues in plain formatted view.
-func (l *IssueList) renderPlain(w io.Writer) error {
-	return renderPlain(w, l.data())
+// renderPlain renders the issue in plain view.
+func (l *IssueList) renderPlain(w io.Writer, delimeter string) error {
+	return renderPlain(w, l.data(), delimeter)
 }
 
 // renderCSV renders issues in csv format.

internal/view/issues_test.go

@@ -52,7 +52,7 @@ func TestIssueRenderInPlainView(t *testing.T) {
 			NoTruncate: false,
 		},
 	}
-	assert.NoError(t, issue.renderPlain(&b))
+	assert.NoError(t, issue.renderPlain(&b, "\t"))
 
 	expected := `TYPE	KEY	SUMMARY	STATUS
 Bug	TEST-1	This is a test	Done
@@ -61,6 +61,29 @@ Story	TEST-2	This is another test	Open
 	assert.Equal(t, expected, b.String())
 }
 
+func TestIssueRenderInPlainViewWithCustomDelimiter(t *testing.T) {
+	var b bytes.Buffer
+
+	issue := IssueList{
+		Total:   2,
+		Project: "TEST",
+		Server:  "https://test.local",
+		Data:    getIssues(),
+		Display: DisplayFormat{
+			Plain:      true,
+			NoHeaders:  false,
+			NoTruncate: false,
+		},
+	}
+	assert.NoError(t, issue.renderPlain(&b, "|"))
+
+	expected := `TYPE|KEY|SUMMARY|STATUS
+Bug|TEST-1|This is a test|Done
+Story|TEST-2|This is another test|Open
+`
+	assert.Equal(t, expected, b.String())
+}
+
 func TestIssueRenderInPlainViewAndNoTruncate(t *testing.T) {
 	var b bytes.Buffer
 
@@ -75,7 +98,7 @@ func TestIssueRenderInPlainViewAndNoTruncate(t *testing.T) {
 			NoTruncate: true,
 		},
 	}
-	assert.NoError(t, issue.renderPlain(&b))
+	assert.NoError(t, issue.renderPlain(&b, "\t"))
 
 	expected := `TYPE	KEY	SUMMARY	STATUS	ASSIGNEE	REPORTER	PRIORITY	RESOLUTION	CREATED	UPDATED	LABELS
 Bug	TEST-1	This is a test	Done	Person A	Person Z	High	Fixed	2020-12-13 14:05:20	2020-12-13 14:07:20	krakatit
@@ -98,7 +121,7 @@ func TestIssueRenderInPlainViewWithoutHeaders(t *testing.T) {
 			NoTruncate: true,
 		},
 	}
-	assert.NoError(t, issue.renderPlain(&b))
+	assert.NoError(t, issue.renderPlain(&b, "\t"))
 
 	expected := `Bug	TEST-1	This is a test	Done	Person A	Person Z	High	Fixed	2020-12-13 14:05:20	2020-12-13 14:07:20	krakatit
 Story	TEST-2	This is another test	Open		Person A	Normal		2020-12-13 14:05:20	2020-12-13 14:07:20	pat,mat
@@ -122,7 +145,7 @@ func TestIssueRenderInPlainViewWithFewColumns(t *testing.T) {
 			Columns:   []string{"key", "type", "status", "created"},
 		},
 	}
-	assert.NoError(t, issue.renderPlain(&b))
+	assert.NoError(t, issue.renderPlain(&b, "\t"))
 
 	expected := `KEY	TYPE	STATUS	CREATED
 TEST-1	Bug	Done	2020-12-13 14:05:20

internal/view/sprint.go

@@ -100,7 +100,8 @@ func (sl *SprintList) RenderInTable() error {
 
 // renderPlain renders the issue in plain view.
 func (sl *SprintList) renderPlain(w io.Writer) error {
-	return renderPlain(w, sl.tableData())
+	// sprint view supports only \t as delimiter, not custom.
+	return renderPlain(w, sl.tableData(), "\t")
 }
 
 func (sl *SprintList) data() []tui.PreviewData {