feat(cli): preserve order of table columns

mtojek · mtojek · commit 89dcb39f735c · 2025-03-07T11:26:36.000+01:00
diff --git a/cli/cliui/table.go b/cli/cliui/table.go
@@ -31,10 +31,33 @@ func Table() table.Writer {
 // e.g. `[]any{someRow, TableSeparator, someRow}`
 type TableSeparator struct{}
 
-// filterTableColumns returns configurations to hide columns
+// filterHeaders filters the headers to only include the columns
+// that are provided in the array. If the array is empty, all
+// headers are included.
+func filterHeaders(header table.Row, columns []string) table.Row {
+	if len(columns) == 0 {
+		return header
+	}
+
+	filteredHeaders := make(table.Row, len(columns))
+	for i, column := range columns {
+		column = strings.ReplaceAll(column, "_", " ")
+
+		for _, headerTextRaw := range header {
+			headerText, _ := headerTextRaw.(string)
+			if strings.EqualFold(column, headerText) {
+				filteredHeaders[i] = headerText
+				break
+			}
+		}
+	}
+	return filteredHeaders
+}
+
+// createColumnConfigs returns configuration to hide columns
 // that are not provided in the array. If the array is empty,
 // no filtering will occur!
-func filterTableColumns(header table.Row, columns []string) []table.ColumnConfig {
+func createColumnConfigs(header table.Row, columns []string) []table.ColumnConfig {
 	if len(columns) == 0 {
 		return nil
 	}
@@ -157,10 +180,13 @@ func DisplayTable(out any, sort string, filterColumns []string) (string, error)
 func renderTable(out any, sort string, headers table.Row, filterColumns []string) (string, error) {
 	v := reflect.Indirect(reflect.ValueOf(out))
 
+	headers = filterHeaders(headers, filterColumns)
+	columnConfigs := createColumnConfigs(headers, filterColumns)
+
 	// Setup the table formatter.
 	tw := Table()
 	tw.AppendHeader(headers)
-	tw.SetColumnConfigs(filterTableColumns(headers, filterColumns))
+	tw.SetColumnConfigs(columnConfigs)
 	if sort != "" {
 		tw.SortBy([]table.SortBy{{
 			Name: sort,
