Add tab:"omit" struct tag

cmoog · cmoog · commit 3b6c702a1f27 · 2020-08-04T10:33:37.000-05:00
diff --git a/cmd/coder/secrets.go b/cmd/coder/secrets.go
@@ -39,7 +39,6 @@ func makeSecretsCmd() cli.Command {
 				Action:    viewSecret,
 			},
 		},
-		Flags: nil,
 	}
 }
 
diff --git a/cmd/coder/sync.go b/cmd/coder/sync.go
@@ -18,10 +18,9 @@ import (
 func makeSyncCmd() cli.Command {
 	var init bool
 	return cli.Command{
-		Name:        "sync",
-		Usage:       "Synchronize local files to a Coder environment",
-		Description: "Establish a one way directory sync to a Coder environment.",
-		ArgsUsage:   "[local directory] [<env name>:<remote directory>]",
+		Name:      "sync",
+		Usage:     "Establish a one way directory sync to a Coder environment",
+		ArgsUsage: "[local directory] [<env name>:<remote directory>]",
 		Before: func(c *cli.Context) error {
 			if c.Args().Get(0) == "" || c.Args().Get(1) == "" {
 				return xerrors.Errorf("[local] and [remote] arguments are required")
diff --git a/cmd/coder/users.go b/cmd/coder/users.go
@@ -31,7 +31,6 @@ func makeUsersCmd() cli.Command {
 				},
 			},
 		},
-		HelpName: "",
 	}
 }
 
diff --git a/internal/entclient/secrets.go b/internal/entclient/secrets.go
@@ -7,12 +7,12 @@ import (
 
 // Secret describes a Coder secret
 type Secret struct {
-	ID          string    `json:"id"`
+	ID          string    `json:"id" tab:"omit"`
 	Name        string    `json:"name"`
 	Value       string    `json:"value,omitempty"`
 	Description string    `json:"description"`
 	CreatedAt   time.Time `json:"created_at"`
-	UpdatedAt   time.Time `json:"updated_at"`
+	UpdatedAt   time.Time `json:"updated_at" tab:"omit"`
 }
 
 // Secrets gets all secrets owned by the authed user
diff --git a/internal/x/xtabwriter/tabwriter.go b/internal/x/xtabwriter/tabwriter.go
@@ -8,27 +8,44 @@ import (
 	"text/tabwriter"
 )
 
-// NewWriter chooses reasonable defaults for a human readable output of tabular data
+const structFieldTagKey = "tab"
+
+// NewWriter chooses reasonable defaults for a human readable output of tabular data.
 func NewWriter() *tabwriter.Writer {
 	return tabwriter.NewWriter(os.Stdout, 0, 0, 4, ' ', 0)
 }
 
-// StructValues tab delimits the values of a given struct
+// StructValues tab delimits the values of a given struct.
+//
+// Tag a field `tab:"omit"` to hide it from output.
 func StructValues(data interface{}) string {
 	v := reflect.ValueOf(data)
 	s := &strings.Builder{}
 	for i := 0; i < v.NumField(); i++ {
+		if shouldHideField(v.Type().Field(i)) {
+			continue
+		}
 		s.WriteString(fmt.Sprintf("%s\t", v.Field(i).Interface()))
 	}
 	return s.String()
 }
 
-// StructFieldNames tab delimits the field names of a given struct
+// StructFieldNames tab delimits the field names of a given struct.
+//
+// Tag a field `tab:"omit"` to hide it from output.
 func StructFieldNames(data interface{}) string {
 	v := reflect.ValueOf(data)
 	s := &strings.Builder{}
 	for i := 0; i < v.NumField(); i++ {
-		s.WriteString(fmt.Sprintf("%s\t", v.Type().Field(i).Name))
+		field := v.Type().Field(i)
+		if shouldHideField(field) {
+			continue
+		}
+		s.WriteString(fmt.Sprintf("%s\t", field.Name))
 	}
 	return s.String()
 }
+
+func shouldHideField(f reflect.StructField) bool {
+	return f.Tag.Get(structFieldTagKey) == "omit"
+}

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,6 @@ func makeSecretsCmd() cli.Command {`
`39`	`39`	`Action: viewSecret,`
`40`	`40`	`},`
`41`	`41`	`},`
`42`		`- Flags: nil,`
`43`	`42`	`}`
`44`	`43`	`}`
`45`	`44`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@ func makeUsersCmd() cli.Command {`
`31`	`31`	`},`
`32`	`32`	`},`
`33`	`33`	`},`
`34`		`- HelpName: "",`
`35`	`34`	`}`
`36`	`35`	`}`
`37`	`36`