feat: Support CSV when listing issues#854
Merged
ankitpokhrel merged 4 commits intomainfrom May 25, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for CSV output when listing issues across various commands.
- Introduce a
CSVflag inDisplayFormatand wire it through issue, sprint, and epic list commands - Implement
renderCSVto output table data in CSV format - Update README to document the new
--csvflag
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/view/issues.go | Add CSV branch in renderer and header logic |
| internal/view/helper.go | Import encoding/csv and add renderCSV |
| internal/cmd/sprint/list/list.go | Add --csv flag handling in sprint list |
| internal/cmd/issue/list/list.go | Add --csv flag handling in issue list |
| internal/cmd/epic/list/list.go | Add --csv flag handling in epic list |
| README.md | Document --csv usage for issue list |
Comments suppressed due to low confidence (2)
internal/view/helper.go:173
- Consider adding unit tests for renderCSV to verify CSV formatting, header inclusion/exclusion, and error handling.
func renderCSV(w io.Writer, data tui.TableData) error {
internal/cmd/sprint/list/list.go:124
- [nitpick] The local variable name
csvcan be confused with theencoding/csvpackage; consider renaming it tocsvFlagfor clarity.
csv, err := flags.GetBool("csv")
| @@ -169,6 +170,22 @@ func renderPlain(w io.Writer, data tui.TableData) error { | |||
| return nil | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
[nitpick] The comment for renderCSV should follow Go doc conventions and start with the function name and proper capitalization: "// renderCSV renders issues in CSV format."
Suggested change
| // renderCSV renders the provided table data in CSV format and writes it to the given writer. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
tmeijn
pushed a commit
to tmeijn/dotfiles
that referenced
this pull request
Sep 2, 2025
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [ankitpokhrel/jira-cli](https://github.com/ankitpokhrel/jira-cli) | minor | `v1.6.0` -> `v1.7.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>ankitpokhrel/jira-cli (ankitpokhrel/jira-cli)</summary> ### [`v1.7.0`](https://github.com/ankitpokhrel/jira-cli/releases/tag/v1.7.0) [Compare Source](ankitpokhrel/jira-cli@v1.6.0...v1.7.0) This release adds CSV and JSON output support for issue listings and upgrades deprecated endpoints to ensure compatibility with the latest Jira APIs. > \[!IMPORTANT] > > - The [new API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-jql-get) does not return the total number of entries anymore, so the total issue count is no longer displayed in the search results. > - Consequently, the `startAt` parameter in the new API is unsupported. Therefore, the `from` part of the `--paginate=<from>:<limit>` flag is effectively ignored. Users can still paginate using the maxResults parameter (e.g., --paginate=10). #### 🥷 What's added? - feat: Add option to list issues in raw JSON by [@​evg656e](https://github.com/evg656e) in [#​840](ankitpokhrel/jira-cli#840) - feat: Add releases Subcommand by [@​vkhitrin](https://github.com/vkhitrin) in [#​851](ankitpokhrel/jira-cli#851) - feat: Support num comments in issue list cmd by [@​ankitpokhrel](https://github.com/ankitpokhrel) in [#​853](ankitpokhrel/jira-cli#853) - feat: Support CSV when listing issues by [@​ankitpokhrel](https://github.com/ankitpokhrel) in [#​854](ankitpokhrel/jira-cli#854) - feat: Allow skipping notification on edit by [@​ankitpokhrel](https://github.com/ankitpokhrel) in [#​855](ankitpokhrel/jira-cli#855) - feat: Add command line arg delimiter for custom delimiter instead of tab. by [@​iksi4prs](https://github.com/iksi4prs) in [#​662](ankitpokhrel/jira-cli#662) - feat: Add support for environment variable to specify config file path by [@​aazon](https://github.com/aazon) in [#​858](ankitpokhrel/jira-cli#858) #### 🐞 What's fixed? - fix: usernames can be 2 chars by [@​jontyq](https://github.com/jontyq) in [#​890](ankitpokhrel/jira-cli#890) - fix: Update deprecated endpoint by [@​ankitpokhrel](https://github.com/ankitpokhrel) in [#​892](ankitpokhrel/jira-cli#892) - fix: csv format priority by [@​ciricc](https://github.com/ciricc) in [#​882](ankitpokhrel/jira-cli#882) #### ☕️ Other changes - chore(docs): Add packaging stats to Installation section in README.md by [@​kskarthik](https://github.com/kskarthik) in [#​857](ankitpokhrel/jira-cli#857) #### New Contributors - [@​evg656e](https://github.com/evg656e) made their first contribution in [#​840](ankitpokhrel/jira-cli#840) - [@​vkhitrin](https://github.com/vkhitrin) made their first contribution in [#​851](ankitpokhrel/jira-cli#851) - [@​iksi4prs](https://github.com/iksi4prs) made their first contribution in [#​662](ankitpokhrel/jira-cli#662) - [@​aazon](https://github.com/aazon) made their first contribution in [#​858](ankitpokhrel/jira-cli#858) - [@​jontyq](https://github.com/jontyq) made their first contribution in [#​890](ankitpokhrel/jira-cli#890) - [@​ciricc](https://github.com/ciricc) made their first contribution in [#​882](ankitpokhrel/jira-cli#882) - [@​kskarthik](https://github.com/kskarthik) made their first contribution in [#​857](ankitpokhrel/jira-cli#857) **Full Changelog**: <ankitpokhrel/jira-cli@v1.6.0...v1.7.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS45MS4zIiwidXBkYXRlZEluVmVyIjoiNDEuOTEuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90Il19-->
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Relates to #820