From 89970f51970b320430852ed57dcfc9d6c841322e Mon Sep 17 00:00:00 2001 From: Ophestra Date: Sun, 23 Feb 2025 02:25:31 +0900 Subject: [PATCH] command/flag: implement repeatable flag Signed-off-by: Ophestra --- command/flag.go | 20 ++++++++++++++++++++ command/parse_test.go | 19 ++++++++++++++++--- 2 files changed, 36 insertions(+), 3 deletions(-) diff --git a/command/flag.go b/command/flag.go index 8e890a1..cb85a64 100644 --- a/command/flag.go +++ b/command/flag.go @@ -44,6 +44,26 @@ func (v BoolFlag) Define(b *strings.Builder, set *flag.FlagSet, p any, name, usa b.WriteString(" [" + prettyFlag(name) + "]") } +// RepeatableFlag implements an ordered, repeatable string flag. +type RepeatableFlag []string + +func (r *RepeatableFlag) String() string { + if r == nil { + return "" + } + return strings.Join(*r, " ") +} + +func (r *RepeatableFlag) Set(v string) error { + *r = append(*r, v) + return nil +} + +func (r *RepeatableFlag) Define(b *strings.Builder, set *flag.FlagSet, _ any, name, usage string) { + set.Var(r, name, usage) + b.WriteString(" [" + prettyFlag(name) + " ]") +} + // this has no effect on parse outcome func prettyFlag(name string) string { switch len(name) { diff --git a/command/parse_test.go b/command/parse_test.go index 911389a..579edd9 100644 --- a/command/parse_test.go +++ b/command/parse_test.go @@ -83,6 +83,12 @@ func TestParse(t *testing.T) { []string{"--int", "2147483647", "int"}, "2147483647", "", nil, }, + { + "d=0 repeat flag", + buildTestCommand, + []string{"--repeat", "0", "--repeat", "1", "--repeat", "2", "--repeat", "3", "--repeat", "4", "repeat"}, + "[0 1 2 3 4]", "", nil, + }, { "d=0 bool flag", buildTestCommand, @@ -144,13 +150,14 @@ func TestParse(t *testing.T) { buildTestCommand, []string{}, ` -Usage: test [-h | --help] [-v] [--fail] [--string ] [--int ] COMMAND [OPTIONS] +Usage: test [-h | --help] [-v] [--fail] [--string ] [--int ] [--repeat ] COMMAND [OPTIONS] Commands: error return an error print wraps Fprint string print string passed by flag int print int passed by flag + repeat print repeated values passed by flag empty empty subcommand join wraps strings.Join succeed this command succeeds @@ -163,13 +170,14 @@ Commands: buildTestCommand, []string{"-h"}, ` -Usage: test [-h | --help] [-v] [--fail] [--string ] [--int ] COMMAND [OPTIONS] +Usage: test [-h | --help] [-v] [--fail] [--string ] [--int ] [--repeat ] COMMAND [OPTIONS] Commands: error return an error print wraps Fprint string print string passed by flag int print int passed by flag + repeat print repeated values passed by flag empty empty subcommand join wraps strings.Join succeed this command succeeds @@ -180,6 +188,8 @@ Flags: fail early -int int store value for the "int" command (default -1) + -repeat value + store value for the "repeat" command -string string store value for the "string" command (default "default") -v verbose output @@ -269,6 +279,7 @@ func buildTestCommand(wout, wlog io.Writer) (c command.Command) { flagString string flagInt int + flagRepeat command.RepeatableFlag ) logf := newLogFunc(wlog) @@ -297,7 +308,9 @@ func buildTestCommand(wout, wlog io.Writer) (c command.Command) { Flag(&flagString, "string", command.StringFlag("default"), "store value for the \"string\" command"). Command("string", "print string passed by flag", func(args []string) error { _, err := fmt.Fprint(wout, flagString); return err }). Flag(&flagInt, "int", command.IntFlag(-1), "store value for the \"int\" command"). - Command("int", "print int passed by flag", func(args []string) error { _, err := fmt.Fprint(wout, flagInt); return err }) + Command("int", "print int passed by flag", func(args []string) error { _, err := fmt.Fprint(wout, flagInt); return err }). + Flag(nil, "repeat", &flagRepeat, "store value for the \"repeat\" command"). + Command("repeat", "print repeated values passed by flag", func(args []string) error { _, err := fmt.Fprint(wout, flagRepeat); return err }) c.New("empty", "empty subcommand") c.New("hidden", command.UsageInternal)