flags

Documentation

Index

• Variables
• func FieldsFlag(availableFields, defaultFields []string) *cli.StringFlag
• func GetFields(ctx *cli.Context, validFields []string) ([]string, error)
• func GetIssuePREditFlags(ctx *context.TeaContext) (*gitea.CreateIssueOption, error)

Variables

var AllDefaultFlags = append([]cli.Flag{
	&RepoFlag,
	&RemoteFlag,
}, LoginOutputFlags...)

AllDefaultFlags defines flags that should be available for all subcommands working with dedicated repositories to work around issue and provide --login, --repo and --output: https://github.com/urfave/cli/issues/585

var IssuePREditFlags = append([]cli.Flag{
	&cli.StringFlag{
		Name:    "title",
		Aliases: []string{"t"},
	},
	&cli.StringFlag{
		Name:    "description",
		Aliases: []string{"d"},
	},
	&cli.StringFlag{
		Name:    "assignees",
		Aliases: []string{"a"},
		Usage:   "Comma-separated list of usernames to assign",
	},
	&cli.StringFlag{
		Name:    "labels",
		Aliases: []string{"L"},
		Usage:   "Comma-separated list of labels to assign",
	},
	&cli.StringFlag{
		Name:    "deadline",
		Aliases: []string{"D"},
		Usage:   "Deadline timestamp to assign",
	},
	&cli.StringFlag{
		Name:    "milestone",
		Aliases: []string{"m"},
		Usage:   "Milestone to assign",
	},
}, LoginRepoFlags...)

IssuePREditFlags defines flags for properties of issues and PRs

var IssuePRFlags = append([]cli.Flag{
	&StateFlag,
	&PaginationPageFlag,
	&PaginationLimitFlag,
}, AllDefaultFlags...)

IssuePRFlags defines flags that should be available on issue & pr listing flags.

var LoginFlag = cli.StringFlag{
	Name:    "login",
	Aliases: []string{"l"},
	Usage:   "Use a different Gitea Login. Optional",
}

LoginFlag provides flag to specify tea login profile

var LoginOutputFlags = []cli.Flag{
	&LoginFlag,
	&OutputFlag,
}

LoginOutputFlags defines login and output flags that should added to all subcommands and appended to the flags of the subcommand to work around issue and provide --login and --output: https://github.com/urfave/cli/issues/585

var LoginRepoFlags = []cli.Flag{
	&LoginFlag,
	&RepoFlag,
	&RemoteFlag,
}

LoginRepoFlags defines login and repo flags that should be used for all subcommands and appended to the flags of the subcommand to work around issue and provide --login and --repo: https://github.com/urfave/cli/issues/585

var OutputFlag = cli.StringFlag{
	Name:    "output",
	Aliases: []string{"o"},
	Usage:   "Output format. (csv, simple, table, tsv, yaml)",
}

OutputFlag provides flag to specify output type

var PaginationLimitFlag = cli.StringFlag{
	Name:    "limit",
	Aliases: []string{"lm"},
	Usage:   "specify limit of items per page",
}

PaginationLimitFlag provides flag for pagination options

var PaginationPageFlag = cli.StringFlag{
	Name:    "page",
	Aliases: []string{"p"},
	Usage:   "specify page, default is 1",
}

PaginationPageFlag provides flag for pagination options

var RemoteFlag = cli.StringFlag{
	Name:    "remote",
	Aliases: []string{"R"},
	Usage:   "Discover Gitea login from remote. Optional",
}

RemoteFlag provides flag to specify remote repository

var RepoFlag = cli.StringFlag{
	Name:    "repo",
	Aliases: []string{"r"},
	Usage:   "Override local repository path or gitea repository slug to interact with. Optional",
}

RepoFlag provides flag to specify repository

var StateFlag = cli.StringFlag{
	Name:        "state",
	Usage:       "Filter by state (all|open|closed)",
	DefaultText: "open",
}

StateFlag provides flag to specify issue/pr state, defaulting to "open"

Functions

func FieldsFlag

func FieldsFlag(availableFields, defaultFields []string) *cli.StringFlag

FieldsFlag generates a flag selecting printable fields. To retrieve the value, use GetFields()

func GetFields

func GetFields(ctx *cli.Context, validFields []string) ([]string, error)

GetFields parses the values provided in a fields flag, and optionally validates against valid values.

func GetIssuePREditFlags

func GetIssuePREditFlags(ctx *context.TeaContext) (*gitea.CreateIssueOption, error)

GetIssuePREditFlags parses all IssuePREditFlags