cmd/flags/csvflag.go

@@ -0,0 +1,46 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package flags
+
+import (
+	"fmt"
+	"strings"
+
+	"code.gitea.io/tea/modules/utils"
+	"github.com/urfave/cli/v2"
+)
+
+// CsvFlag is a wrapper around cli.StringFlag, with an added GetValues() method
+// to retrieve comma separated string values as a slice.
+type CsvFlag struct {
+	cli.StringFlag
+	AvailableFields []string
+}
+
+func NewCsvFlag(name, usage string, aliases, availableFields, defaultFields []string) *CsvFlag {
+	return &CsvFlag{
+		AvailableFields: availableFields,
+		StringFlag: cli.StringFlag{
+			Name:    name,
+			Aliases: aliases,
+			Value:   strings.Join(defaultFields, ","),
+			Usage: fmt.Sprintf(`Comma-separated list of %s. Available values:
+			%s
+		`, usage, strings.Join(availableFields, ",")),
+		},
+	}
+}
+
+func (f CsvFlag) GetValues(ctx *cli.Context) ([]string, error) {
+	selection := strings.Split(ctx.String(f.Name), ",")
+	if f.AvailableFields != nil {
+		for _, field := range selection {
+			if !utils.Contains(f.AvailableFields, field) {
+				return nil, fmt.Errorf("Invalid field '%s'", field)
+			}
+		}
+	}
+	return selection, nil
+}

cmd/flags/flags.go

@@ -11,7 +11,6 @@ import (
 	"code.gitea.io/sdk/gitea"
 	"code.gitea.io/tea/modules/context"
 	"code.gitea.io/tea/modules/task"
-	"code.gitea.io/tea/modules/utils"
 
 	"github.com/araddon/dateparse"
 	"github.com/urfave/cli/v2"
@@ -189,28 +188,7 @@ func GetIssuePREditFlags(ctx *context.TeaContext) (*gitea.CreateIssueOption, err
 }
 
 // FieldsFlag generates a flag selecting printable fields.
-// To retrieve the value, use GetFields()
-func FieldsFlag(availableFields, defaultFields []string) *cli.StringFlag {
-	return &cli.StringFlag{
-		Name:    "fields",
-		Aliases: []string{"f"},
-		Usage: fmt.Sprintf(`Comma-separated list of fields to print. Available values:
-			%s
-		`, strings.Join(availableFields, ",")),
-		Value: strings.Join(defaultFields, ","),
-	}
-}
-
-// GetFields parses the values provided in a fields flag, and
-// optionally validates against valid values.
-func GetFields(ctx *cli.Context, validFields []string) ([]string, error) {
-	selection := strings.Split(ctx.String("fields"), ",")
-	if validFields != nil {
-		for _, field := range selection {
-			if !utils.Contains(validFields, field) {
-				return nil, fmt.Errorf("Invalid field '%s'", field)
-			}
-		}
-	}
-	return selection, nil
+// To retrieve the value, use f.GetValues()
+func FieldsFlag(availableFields, defaultFields []string) *CsvFlag {
+	return NewCsvFlag("fields", "fields to print", []string{"f"}, availableFields, defaultFields)
 }

cmd/issues/list.go

@@ -13,6 +13,10 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+var issueFieldsFlag = flags.FieldsFlag(print.IssueFields, []string{
+	"index", "title", "state", "author", "milestone", "labels",
+})
+
 // CmdIssuesList represents a sub command of issues to list issues
 var CmdIssuesList = cli.Command{
 	Name:        "list",
@@ -20,11 +24,7 @@ var CmdIssuesList = cli.Command{
 	Usage:       "List issues of the repository",
 	Description: `List issues of the repository`,
 	Action:      RunIssuesList,
-	Flags: append([]cli.Flag{
-		flags.FieldsFlag(print.IssueFields, []string{
-			"index", "title", "state", "author", "milestone", "labels",
-		}),
-	}, flags.IssuePRFlags...),
+	Flags:       append([]cli.Flag{issueFieldsFlag}, flags.IssuePRFlags...),
 }
 
 // RunIssuesList list issues
@@ -52,7 +52,7 @@ func RunIssuesList(cmd *cli.Context) error {
 		return err
 	}
 
-	fields, err := flags.GetFields(cmd, print.IssueFields)
+	fields, err := issueFieldsFlag.GetValues(cmd)
 	if err != nil {
 		return err
 	}

cmd/milestones/issues.go

@@ -16,6 +16,10 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+var msIssuesFieldsFlag = flags.FieldsFlag(print.IssueFields, []string{
+	"index", "kind", "title", "state", "updated", "labels",
+})
+
 // CmdMilestonesIssues represents a sub command of milestones to manage issue/pull of an milestone
 var CmdMilestonesIssues = cli.Command{
 	Name:        "issues",
@@ -40,9 +44,7 @@ var CmdMilestonesIssues = cli.Command{
 		},
 		&flags.PaginationPageFlag,
 		&flags.PaginationLimitFlag,
-		flags.FieldsFlag(print.IssueFields, []string{
-			"index", "kind", "title", "state", "updated", "labels",
-		}),
+		msIssuesFieldsFlag,
 	}, flags.AllDefaultFlags...),
 }
 
@@ -110,7 +112,7 @@ func runMilestoneIssueList(cmd *cli.Context) error {
 		return err
 	}
 
-	fields, err := flags.GetFields(cmd, print.IssueFields)
+	fields, err := msIssuesFieldsFlag.GetValues(cmd)
 	if err != nil {
 		return err
 	}

cmd/repos/list.go

@@ -13,6 +13,10 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+var repoFieldsFlag = flags.FieldsFlag(print.RepoFields, []string{
+	"owner", "name", "type", "ssh",
+})
+
 // CmdReposListFlags contains all flags needed for repo listing
 var CmdReposListFlags = append([]cli.Flag{
 	&cli.BoolFlag{
@@ -27,9 +31,7 @@ var CmdReposListFlags = append([]cli.Flag{
 		Required: false,
 		Usage:    "List your starred repos instead",
 	},
-	flags.FieldsFlag(print.RepoFields, []string{
-		"owner", "name", "type", "ssh",
-	}),
+	repoFieldsFlag,
 	&typeFilterFlag,
 	&flags.PaginationPageFlag,
 	&flags.PaginationLimitFlag,
@@ -82,7 +84,7 @@ func RunReposList(cmd *cli.Context) error {
 		reposFiltered = filterReposByType(rps, typeFilter)
 	}
 
-	fields, err := flags.GetFields(cmd, print.RepoFields)
+	fields, err := repoFieldsFlag.GetValues(cmd)
 	if err != nil {
 		return err
 	}

cmd/repos/search.go

@@ -50,9 +50,7 @@ var CmdReposSearch = cli.Command{
 			Required: false,
 			Usage:    "Filter archived repos (true|false)",
 		},
-		flags.FieldsFlag(print.RepoFields, []string{
-			"owner", "name", "type", "ssh",
-		}),
+		repoFieldsFlag,
 		&flags.PaginationPageFlag,
 		&flags.PaginationLimitFlag,
 	}, flags.LoginOutputFlags...),
@@ -125,7 +123,7 @@ func runReposSearch(cmd *cli.Context) error {
 		return err
 	}
 
-	fields, err := flags.GetFields(cmd, nil)
+	fields, err := repoFieldsFlag.GetValues(cmd)
 	if err != nil {
 		return err
 	}

cmd/times/list.go

@@ -19,6 +19,17 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
+// NOTE: not using NewCsvFlag, as we don't want an alias & default value.
+var timeFieldsFlag = &flags.CsvFlag{
+	AvailableFields: print.TrackedTimeFields,
+	StringFlag: cli.StringFlag{
+		Name: "fields",
+		Usage: fmt.Sprintf(`Comma-separated list of fields to print. Available values:
+	%s
+`, strings.Join(print.TrackedTimeFields, ",")),
+	},
+}
+
 // CmdTrackedTimesList represents a sub command of times to list them
 var CmdTrackedTimesList = cli.Command{
 	Name:    "list",
@@ -53,12 +64,7 @@ Depending on your permissions on the repository, only your own tracked times mig
 			Aliases: []string{"m"},
 			Usage:   "Show all times tracked by you across all repositories (overrides command arguments)",
 		},
-		&cli.StringFlag{
-			Name: "fields",
-			Usage: fmt.Sprintf(`Comma-separated list of fields to print. Available values:
-			%s
-		`, strings.Join(print.TrackedTimeFields, ",")),
-		},
+		timeFieldsFlag,
 	}, flags.AllDefaultFlags...),
 }
 
@@ -116,7 +122,7 @@ func RunTimesList(cmd *cli.Context) error {
 	}
 
 	if ctx.IsSet("fields") {
-		if fields, err = flags.GetFields(cmd, print.TrackedTimeFields); err != nil {
+		if fields, err = timeFieldsFlag.GetValues(cmd); err != nil {
 			return err
 		}
 	}