feat(DCP-2580): unified output format flags by cemprolific · Pull Request #393 · prolific-oss/cli

cemprolific · 2026-03-27T16:29:45Z

New shared formatting flags

Creates --table/-t, --csv/-c, --json/-j to use with list commands
ResolveFormat applies priority order: json > csv > table > auto
--non-interactive/-n is kept as a hidden alias for --table for backwards compatibility
Generic TableRenderer[T], CsvRenderer[T], and JSONRenderer[T] in ui/renderers.go replace per-resource renderer implementations

formatting aligns with gh cli usage

$ prolific study list --json
$ prolific study list -j

study list migrated

Replaces ad-hoc ListStrategy/ListRenderer/NonInteractiveRenderer/CsvRenderer in ui/study/list.go with the shared generic renderers
cmd/study/list.go now resolves the output format and owns the default fields (ID,Name,Status)
Added --json/-j output support (previously missing for studies)
Updated command examples to document all three output flags

New TUI view for submission list command

Same as the other commands, adds a TUI based list view for submission

ui package is only for shared ui functions

Moves all the command specific views functions into command packages.

Tests

Renderer tests moved from ui/study/list_test.go to ui/renderers_test.go and updated to use the generic renderers directly

prolific-snyk · 2026-03-27T16:30:07Z

✅ Snyk checks have passed. No issues have been found so far.

Status	Scan Engine	Critical	High	Medium	Low	Total (0)
✅	Open Source Security	0	0	0	0	0 issues
✅	Licenses	0	0	0	0	0 issues
✅	Code Security	0	0	0	0	0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

benmatselby · 2026-03-27T20:19:48Z

cmd/shared/list_format_flags.go

+}
+
+// AddOutputFlags registers --json / -j, --table / -t, --csv / -c on the given command.
+// --non-interactive / -n is registered as a hidden alias for --table for backwards compatibility.


praise: Nice

script-this

Looking good 🙏 - just a couple of minor points to address.

script-this · 2026-03-30T09:23:41Z

ui/study/list_test.go

@@ -1,214 +1 @@
 package study_test


Think this file can go completely now..?

There is a bit of inconsistency in the location of command specific renderers. Most of the commands have renderers in cmd/ dir, but there are also command specific renderers in the ui package. Does it make sense to move command specific renderers to their own packages and keep the ui only for shared components?

Good question, have no strong opinions here other than what makes the most sense.

script-this · 2026-03-30T09:24:51Z

ui/renderers.go

+
+	for _, item := range items {
+		for _, field := range fieldList {
+			fmt.Fprintf(tw, "%v\t", reflect.ValueOf(item).FieldByName(strings.Trim(field, " ")))


What happens if field doesn't exist here..?
Might be good to add some validation.

script-this · 2026-03-30T09:28:22Z

ui/renderers.go

+type CsvRenderer[T any] struct{}
+
+// Render writes items as CSV to w. Values containing commas are wrapped in double quotes.
+func (r CsvRenderer[T]) Render(items []T, fields string, w io.Writer) error {


Think we should probably be using Go's encoding/csv here so it's catches all the edge cases around quoting, escaping and general compliance.

Copilot

Pull request overview

This PR standardizes output formatting for list commands across the CLI by introducing shared --table/-t, --csv/-c, and --json/-j flags and consolidating rendering into generic UI renderers.

Changes:

Added shared output-format flags (--table/--csv/--json) with --non-interactive/-n kept as a hidden alias for --table.
Introduced generic TableRenderer[T], CsvRenderer[T], and JSONRenderer[T] and migrated list commands to use them.
Moved/updated renderer tests to target the new shared renderers and adjusted CSV expectations.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
`cmd/shared/list_format_flags.go`	Adds shared output flags and a format resolver used by list commands.
`ui/renderers.go`	Implements shared generic table/CSV/JSON renderers using reflection.
`ui/renderers_test.go`	Adds tests for shared renderers (currently CSV + table).
`cmd/study/list.go`	Migrates study listing to shared output flags/renderers and supports JSON output.
`cmd/study/list_test.go`	Updates CSV output expectation to match `encoding/csv` output.
`cmd/collection/list.go`	Migrates collection listing to shared output flags/renderers and supports JSON output.
`cmd/submission/list.go`	Migrates submission listing to shared output flags/renderers and adds JSON output support.
`ui/study/list.go`	Removes per-resource non-interactive/CSV rendering, leaving interactive renderer.
`ui/collection/list.go`	Removes per-resource non-interactive/CSV/JSON rendering, leaving interactive renderer.
`ui/study/list_test.go`	Removes study-specific renderer tests (superseded by shared renderer tests).
`ui/collection/list_test.go`	Removes collection-specific renderer tests (superseded by shared renderer tests).
`ui/submission/list.go`	Removes submission-specific renderers (now handled in cmd + shared renderers).
`ui/submission/list_test.go`	Removes submission-specific renderer tests.

Copilot · 2026-03-30T12:34:42Z

cmd/study/list.go

+			default:
+				r := &studyui.InteractiveRenderer{}
+				if err := r.Render(client, *studies, w); err != nil {
+					return fmt.Errorf("error: %s", err)
+				}


The default (auto) format path always launches the Bubble Tea interactive UI. This conflicts with the documented intent of auto mode (TUI if TTY, else table) and can break scripted usage when stdout is piped/non-TTY. Consider detecting whether output is a terminal and falling back to table output (or requiring an explicit format) when not on a TTY.

Copilot · 2026-03-30T12:34:43Z

cmd/collection/list.go

+			default:
+				r := &collectionui.InteractiveRenderer{}
+				if err := r.Render(c, *collections, w); err != nil {
+					return fmt.Errorf("error: %s", err)
+				}


The default (auto) format path always launches the Bubble Tea interactive UI. This conflicts with the documented intent of auto mode (TUI if TTY, else table) and can break scripted usage when stdout is piped/non-TTY. Consider detecting whether output is a terminal and falling back to table output when not on a TTY.

Copilot · 2026-03-30T12:34:43Z

cmd/shared/list_format_flags.go

+// ResolveFormat returns the resolved format string based on the flags set.
+// Priority: json > csv > table. Returns "" to indicate auto (TUI if TTY, else table).
+func ResolveFormat(opts OutputOptions) string {
+	switch {
+	case opts.Json:
+		return "json"
+	case opts.Csv:
+		return "csv"
+	case opts.Table:
+		return "table"
+	default:
+		return ""
+	}


ResolveFormat's docstring says the default ("auto") behavior is "TUI if TTY, else table", but ResolveFormat only returns "" and does not (and cannot, as written) inspect TTY state. Either implement the TTY-based auto-resolution in shared (e.g., by passing an *os.File / io.Writer context) or adjust the comment so callers don't assume this behavior is already handled here.

Copilot · 2026-03-30T12:34:43Z

ui/renderers.go

+	for _, item := range items {
+		for _, field := range fieldList {
+			v := reflect.ValueOf(item).FieldByName(strings.Trim(field, " "))
+			if !v.IsValid() {
+				fmt.Fprintf(tw, "\t")
+				continue
+			}
+			fmt.Fprintf(tw, "%v\t", v)
+		}


TableRenderer uses reflect.ValueOf(item).FieldByName(...) directly. If callers pass pointers (e.g., []*model.Study) or a non-struct type, FieldByName will panic. Since this is a generic, reusable renderer, consider using reflect.Indirect and validating Kind()==Struct (returning a clear error instead of panicking) to make it safe for broader use.

Copilot · 2026-03-30T12:34:43Z

ui/renderers.go

+	for _, item := range items {
+		row := make([]string, len(fieldList))
+		for i, field := range fieldList {
+			v := reflect.ValueOf(item).FieldByName(field)
+			if v.IsValid() {
+				row[i] = fmt.Sprintf("%v", v)
+			}
+		}


CsvRenderer uses reflect.ValueOf(item).FieldByName(field) directly. If callers pass pointers (e.g., []*model.Collection) or a non-struct type, this will panic at runtime. Consider using reflect.Indirect and validating the value is a struct (and returning an error) before accessing fields.

Copilot · 2026-03-30T12:34:44Z

ui/renderers.go

+// JSONRenderer renders a slice of items as indented JSON.
+type JSONRenderer[T any] struct{}
+
+// Render writes items as indented JSON to w.
+func (r JSONRenderer[T]) Render(items []T, w io.Writer) error {
+	encoder := json.NewEncoder(w)
+	encoder.SetIndent("", "  ")
+	return encoder.Encode(items)
+}


JSONRenderer is new shared functionality used by list commands, but ui/renderers_test.go currently only exercises the CSV and table renderers. Add a unit test that renders JSON and verifies the output is valid JSON (and matches expected structure) to prevent regressions.

Copilot · 2026-03-30T12:34:44Z

cmd/study/list.go

-	flags.BoolVarP(&opts.NonInteractive, "non-interactive", "n", false, "Render the list details straight to the terminal.")
-	flags.BoolVarP(&opts.Csv, "csv", "c", false, "Render the list details in a CSV format.")
 	flags.BoolVarP(&opts.Underpaying, "underpaying", "u", false, "Filter by underpaying studies.")
 	flags.StringVarP(&opts.Fields, "fields", "f", "", "Comma separated list of fields you want to display in non-interactive/csv mode.")


The --fields flag help text still references "non-interactive" mode, but this command now uses the unified output flags (--table/--csv/--json) and the non-interactive flag is only a hidden alias for --table. Update the help text to avoid confusing users (e.g., reference table/CSV output instead).

Suggested change

flags.StringVarP(&opts.Fields, "fields", "f", "", "Comma separated list of fields you want to display in non-interactive/csv mode.")

flags.StringVarP(&opts.Fields, "fields", "f", "", "Comma separated list of fields to display for table or CSV output.")

script-this · 2026-03-30T12:57:45Z

cmd/collection/list.go

+			fields := opts.Fields
+			if fields == "" {
+				fields = defaultListFields
+			}


Suggestion (optional): Wondering if we can have a shared helper somehow that means we can drop the format switch from each list command.

I thought the same. However, if we want to customise the renderer for a specific command, this approach gives us the flexibility to use a custom one. So, let's leave it as is for now. We can make a small refactoring later if we want to generalise it.

script-this · 2026-03-30T13:01:41Z

Couple of observations (may be intentional):

Submission default case I think is table not interactive where as collection/study is interactive. May have been like that before but probably a good time to unify.
Old code rendered record count for submissions, new code only show it for table case. Just wanted to check you were aware (likely result of standardisation).

cemprolific · 2026-04-01T08:18:30Z

Couple of observations (may be intentional):

Submission default case I think is table not interactive where as collection/study is interactive. May have been like that before but probably a good time to unify.

Old code rendered record count for submissions, new code only show it for table case. Just wanted to check you were aware (likely result of standardisation).

Created a TUI renderer for submissions.
Submissions count added into the csv output

feat(DCP-2580): unified output format flags

cbeb319

benmatselby reviewed Mar 27, 2026

View reviewed changes

script-this reviewed Mar 30, 2026

View reviewed changes

cemprolific added 3 commits March 30, 2026 11:43

feat(DCP-2580): update collection rendering

25e4b73

feat(DCP-2580): update submission rendering

ca558ce

chore(DCP-2580): Merge branch 'main' into DCP-2580-Global-Output-Flag

5f5120e

cemprolific marked this pull request as ready for review March 30, 2026 12:29

cemprolific requested review from a team as code owners March 30, 2026 12:29

Copilot AI review requested due to automatic review settings March 30, 2026 12:29

cemprolific added team-dct dct-ready-for-review Triggers Slack notification when PR is ready for review labels Mar 30, 2026

Copilot started reviewing on behalf of cemprolific March 30, 2026 12:29 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

script-this reviewed Mar 30, 2026

View reviewed changes

cemprolific added 5 commits March 30, 2026 16:27

feat: move study ui renderer to ./cmd

5ecce63

feat: move collection renderers to /cmd

a305cfc

feat(DCP-2580): move filter view to ./cmd/filters

001d0a5

feat(DCP-2580): Add submissions TUI list view

0740e41

Merge branch 'main' into DCP-2580-Global-Output-Flag

eef8414

feat(CDP-2580): Merge branch 'main' into DCP-2580-Global-Output-Flag

3d99745

script-this approved these changes Apr 1, 2026

View reviewed changes

cemprolific merged commit 18ced0b into main Apr 1, 2026
5 checks passed

cemprolific deleted the DCP-2580-Global-Output-Flag branch April 1, 2026 10:33

script-this linked an issue Apr 2, 2026 that may be closed by this pull request

Global Output Flag (structured JSON by default, GH CLI standard) #357

Closed

	flags.StringVarP(&opts.Fields, "fields", "f", "", "Comma separated list of fields you want to display in non-interactive/csv mode.")
	flags.StringVarP(&opts.Fields, "fields", "f", "", "Comma separated list of fields to display for table or CSV output.")

Conversation

cemprolific commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New shared formatting flags

study list migrated

New TUI view for submission list command

ui package is only for shared ui functions

Tests

Uh oh!

prolific-snyk commented Mar 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Snyk checks have passed. No issues have been found so far.

Uh oh!

benmatselby Mar 27, 2026

Choose a reason for hiding this comment

Uh oh!

script-this left a comment

Choose a reason for hiding this comment

Uh oh!

script-this Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

cemprolific Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

script-this Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

script-this Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

script-this Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

script-this Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

cemprolific Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

script-this commented Mar 30, 2026

Uh oh!

cemprolific commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

cemprolific commented Mar 27, 2026 •

edited

Loading

prolific-snyk commented Mar 27, 2026 •

edited

Loading

script-this Mar 30, 2026 •

edited

Loading

cemprolific commented Apr 1, 2026 •

edited

Loading