WIP

ethanndickson · ethanndickson · commit a93efdb1371b · 2024-06-05T05:26:38.000Z
diff --git a/cli/cliui/output.go b/cli/cliui/output.go
@@ -143,7 +143,7 @@ func (f *tableFormat) AttachOptions(opts *serpent.OptionSet) {
 
 // Format implements OutputFormat.
 func (f *tableFormat) Format(_ context.Context, data any) (string, error) {
-	return doDisplayTable(data, f.sort, f.columns, nil)
+	return renderTable(data, f.sort, f.columns, nil)
 }
 
 type jsonFormat struct{}
diff --git a/cli/cliui/table.go b/cli/cliui/table.go
@@ -76,18 +76,18 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)
 	if v.Kind() != reflect.Slice {
 		return "", xerrors.Errorf("DisplayTable called with a non-slice type")
 	}
-	var fst reflect.Type
+	var tableType reflect.Type
 	if v.Type().Elem().Kind() == reflect.Interface {
 		if v.Len() == 0 {
 			return "", xerrors.Errorf("DisplayTable called with empty interface slice")
 		}
-		fst = reflect.Indirect(reflect.ValueOf(v.Index(0).Interface())).Type()
+		tableType = reflect.Indirect(reflect.ValueOf(v.Index(0).Interface())).Type()
 	} else {
-		fst = v.Type().Elem()
+		tableType = v.Type().Elem()
 	}
 
 	// Get the list of table column headers.
-	headersRaw, defaultSort, err := typeToTableHeaders(fst, true)
+	headersRaw, defaultSort, err := typeToTableHeaders(tableType, true)
 	if err != nil {
 		return "", xerrors.Errorf("get table headers recursively for type %q: %w", v.Type().Elem().String(), err)
 	}
@@ -142,10 +142,10 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)
 			return "", xerrors.Errorf("specified sort column %q not found in table headers, available columns are %q", sort, strings.Join(headersRaw, `", "`))
 		}
 	}
-	return doDisplayTable(out, sort, headersRaw, filterColumns)
+	return renderTable(out, sort, headersRaw, filterColumns)
 }
 
-func doDisplayTable(out any, sort string, headersRaw []string, filterColumns []string) (string, error) {
+func renderTable(out any, sort string, headersRaw []string, filterColumns []string) (string, error) {
 	v := reflect.Indirect(reflect.ValueOf(out))
 
 	headers := make(table.Row, len(headersRaw))
diff --git a/cli/speedtest.go b/cli/speedtest.go
@@ -36,6 +36,7 @@ type speedtestTableItem struct {
 	Throughput string `table:"Throughput"`
 }
 
+// Attaches a CLI arg with table output
 type speedtestTableFormatter struct {
 	tableFormatter cliui.OutputFormat
 }

Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ func (f tableFormat) AttachOptions(opts serpent.OptionSet) {`
`143`	`143`
`144`	`144`	`// Format implements OutputFormat.`
`145`	`145`	`func (f *tableFormat) Format(_ context.Context, data any) (string, error) {`
`146`		`- return doDisplayTable(data, f.sort, f.columns, nil)`
	`146`	`+ return renderTable(data, f.sort, f.columns, nil)`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`type jsonFormat struct{}`
Original file line number	Diff line number	Diff line change
`@@ -76,18 +76,18 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)`
`76`	`76`	`if v.Kind() != reflect.Slice {`
`77`	`77`	`return "", xerrors.Errorf("DisplayTable called with a non-slice type")`
`78`	`78`	`}`
`79`		`- var fst reflect.Type`
	`79`	`+ var tableType reflect.Type`
`80`	`80`	`if v.Type().Elem().Kind() == reflect.Interface {`
`81`	`81`	`if v.Len() == 0 {`
`82`	`82`	`return "", xerrors.Errorf("DisplayTable called with empty interface slice")`
`83`	`83`	`}`
`84`		`- fst = reflect.Indirect(reflect.ValueOf(v.Index(0).Interface())).Type()`
	`84`	`+ tableType = reflect.Indirect(reflect.ValueOf(v.Index(0).Interface())).Type()`
`85`	`85`	`} else {`
`86`		`- fst = v.Type().Elem()`
	`86`	`+ tableType = v.Type().Elem()`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`// Get the list of table column headers.`
`90`		`- headersRaw, defaultSort, err := typeToTableHeaders(fst, true)`
	`90`	`+ headersRaw, defaultSort, err := typeToTableHeaders(tableType, true)`
`91`	`91`	`if err != nil {`
`92`	`92`	`return "", xerrors.Errorf("get table headers recursively for type %q: %w", v.Type().Elem().String(), err)`
`93`	`93`	`}`
`@@ -142,10 +142,10 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)`
`142`	`142`	return "", xerrors.Errorf("specified sort column %q not found in table headers, available columns are %q", sort, strings.Join(headersRaw, `", "`))
`143`	`143`	`}`
`144`	`144`	`}`
`145`		`- return doDisplayTable(out, sort, headersRaw, filterColumns)`
	`145`	`+ return renderTable(out, sort, headersRaw, filterColumns)`
`146`	`146`	`}`
`147`	`147`
`148`		`-func doDisplayTable(out any, sort string, headersRaw []string, filterColumns []string) (string, error) {`
	`148`	`+func renderTable(out any, sort string, headersRaw []string, filterColumns []string) (string, error) {`
`149`	`149`	`v := reflect.Indirect(reflect.ValueOf(out))`
`150`	`150`
`151`	`151`	`headers := make(table.Row, len(headersRaw))`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ type speedtestTableItem struct {`
`36`	`36`	Throughput string `table:"Throughput"`
`37`	`37`	`}`
`38`	`38`
	`39`	`+// Attaches a CLI arg with table output`
`39`	`40`	`type speedtestTableFormatter struct {`
`40`	`41`	`tableFormatter cliui.OutputFormat`
`41`	`42`	`}`