Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: modified to inherit end opt flag after parsing until sub command #64

Merged
merged 1 commit into from
Oct 15, 2024
Merged

fix: modified to inherit end opt flag after parsing until sub command #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ type Cmd struct {
Args []string
OptCfgs []OptCfg

opts map[string][]string
opts map[string][]string
isAfterEndOpt bool

_args []string
}
Expand All @@ -40,7 +41,7 @@ func NewCmd() Cmd {
return Cmd{Name: name, Args: []string{}, opts: make(map[string][]string), _args: args}
}

func (cmd Cmd) subCmd(fromIndex int) Cmd {
func (cmd Cmd) subCmd(fromIndex int, isAfterEndOpt bool) Cmd {
var name string
if len(cmd._args) > fromIndex {
name = cmd._args[fromIndex]
Expand All @@ -51,7 +52,13 @@ func (cmd Cmd) subCmd(fromIndex int) Cmd {
args = cmd._args[fromIndex+1:]
}

return Cmd{Name: name, Args: []string{}, opts: make(map[string][]string), _args: args}
return Cmd{
Name: name,
Args: []string{},
opts: make(map[string][]string),
isAfterEndOpt: isAfterEndOpt,
_args: args,
}
}

// HasOpt is the method that checks whether an option with the specified name exists.
Expand Down
6 changes: 3 additions & 3 deletions cmd_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ func TestCmd_subCmd(t *testing.T) {
cmd := NewCmd()
cmd._args = []string{"--foo", "-b", "qux", "--corge"}

subCmd := cmd.subCmd(2)
subCmd := cmd.subCmd(2, false)
assert.Equal(t, subCmd.Name, "qux")
assert.Equal(t, subCmd._args, []string{"--corge"})
}
Expand All @@ -78,7 +78,7 @@ func TestCmd_subCmd_withNoArg(t *testing.T) {
cmd := NewCmd()
cmd._args = []string{"--foo", "-b", "qux"}

subCmd := cmd.subCmd(2)
subCmd := cmd.subCmd(2, false)
assert.Equal(t, subCmd.Name, "qux")
assert.Equal(t, subCmd._args, []string(nil))
}
Expand All @@ -87,7 +87,7 @@ func TestCmd_subCmd_empty(t *testing.T) {
cmd := NewCmd()
cmd._args = []string{"--foo", "-b"}

subCmd := cmd.subCmd(2)
subCmd := cmd.subCmd(2, false)
assert.Equal(t, subCmd.Name, "")
assert.Equal(t, subCmd._args, []string(nil))
}
Expand Down
21 changes: 11 additions & 10 deletions parse-with.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ const anyOption = "*"
// The option configurations used to parsing are set into this Cmd instance, and it can be
// retrieved from its field: Cmd#OptCfgs.
func (cmd *Cmd) ParseWith(optCfgs []OptCfg) error {
_, err := cmd.parseArgsWith(optCfgs, false)
_, _, err := cmd.parseArgsWith(optCfgs, false)
cmd.OptCfgs = optCfgs
return err
}
Expand All @@ -55,18 +55,18 @@ func (cmd *Cmd) ParseWith(optCfgs []OptCfg) error {
// The option configurations used to parsing are set into this Cmd instance, and it can be
// retrieved from its field: Cmd#OptCfgs.
func (cmd *Cmd) ParseUntilSubCmdWith(optCfgs []OptCfg) (Cmd, error) {
idx, err := cmd.parseArgsWith(optCfgs, true)
idx, isAfterEndOpt, err := cmd.parseArgsWith(optCfgs, true)
cmd.OptCfgs = optCfgs
if idx < 0 {
return Cmd{}, err
}
return cmd.subCmd(idx), err
return cmd.subCmd(idx, isAfterEndOpt), err
}

func (cmd *Cmd) parseArgsWith(
optCfgs []OptCfg,
untilFirstArg bool,
) (int, error) {
) (int, bool, error) {

const ANY_OPT = "*"
hasAnyOpt := false
Expand Down Expand Up @@ -109,18 +109,18 @@ func (cmd *Cmd) parseArgsWith(
_, exists := optMap[storeKey]
if exists {
e := errors.StoreKeyIsDuplicated{StoreKey: storeKey, Name: firstName}
return -1, e
return -1, cmd.isAfterEndOpt, e
}
optMap[storeKey] = EMPTY_STRUCT

if !cfg.HasArg {
if cfg.IsArray {
e := errors.ConfigIsArrayButHasNoArg{StoreKey: storeKey, Name: firstName}
return -1, e
return -1, cmd.isAfterEndOpt, e
}
if cfg.Defaults != nil {
e := errors.ConfigHasDefaultsButHasNoArg{StoreKey: storeKey, Name: firstName}
return -1, e
return -1, cmd.isAfterEndOpt, e
}
}

Expand All @@ -131,7 +131,7 @@ func (cmd *Cmd) parseArgsWith(
_, exists := cfgMap[nm]
if exists {
e := errors.OptionNameIsDuplicated{StoreKey: storeKey, Name: nm}
return -1, e
return -1, cmd.isAfterEndOpt, e
}
cfgMap[nm] = i
}
Expand Down Expand Up @@ -231,12 +231,13 @@ func (cmd *Cmd) parseArgsWith(
}
}

idx, err := parseArgs(
idx, isAfterEndOpt, err := parseArgs(
cmd._args,
collectArgs,
collectOpts,
takeOptArgs,
untilFirstArg,
cmd.isAfterEndOpt,
)

for _, cfg := range optCfgs {
Expand Down Expand Up @@ -273,5 +274,5 @@ func (cmd *Cmd) parseArgsWith(
}
}

return idx, err
return idx, isAfterEndOpt, err
}
84 changes: 84 additions & 0 deletions parse-with_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1819,3 +1819,87 @@ func TestParseUntilSubCmdWith_oneCfgUsingValidatorAndSubCmd(t *testing.T) {
assert.Equal(t, subCmd.Name, "def")
assert.Equal(t, subCmd.Args, []string{"ghi"})
}

func TestParseUntilSubCmd_parseWithEndOptMark(t *testing.T) {
defer reset()

optCfgs0 := []cliargs.OptCfg{
cliargs.OptCfg{
Names: []string{"foo"},
},
}
optCfgs1 := []cliargs.OptCfg{
cliargs.OptCfg{
Names: []string{"bar"},
},
}

os.Args = []string{"/path/to/app", "--foo", "sub", "--", "bar", "-@"}

cmd := cliargs.NewCmd()
subCmd, err := cmd.ParseUntilSubCmdWith(optCfgs0)

assert.Nil(t, err)
assert.Equal(t, cmd.Name, "app")
assert.Equal(t, cmd.Args, []string{})
assert.Equal(t, cmd.HasOpt("foo"), true)
assert.Equal(t, cmd.OptArg("foo"), "")
assert.Equal(t, cmd.OptArgs("foo"), []string(nil))
assert.Equal(t, cmd.HasOpt("bar"), false)
assert.Equal(t, cmd.OptArg("bar"), "")
assert.Equal(t, cmd.OptArgs("bar"), []string(nil))

err = subCmd.ParseWith(optCfgs1)

assert.Nil(t, err)
assert.Equal(t, subCmd.Name, "sub")
assert.Equal(t, subCmd.Args, []string{"bar", "-@"})
assert.Equal(t, subCmd.HasOpt("foo"), false)
assert.Equal(t, subCmd.OptArg("foo"), "")
assert.Equal(t, subCmd.OptArgs("foo"), []string(nil))
assert.Equal(t, subCmd.HasOpt("bar"), false)
assert.Equal(t, subCmd.OptArg("bar"), "")
assert.Equal(t, subCmd.OptArgs("bar"), []string(nil))
}

func TestParseUntilSubCmd_parseAfterEndOptMark(t *testing.T) {
defer reset()

optCfgs0 := []cliargs.OptCfg{
cliargs.OptCfg{
Names: []string{"foo"},
},
}
optCfgs1 := []cliargs.OptCfg{
cliargs.OptCfg{
Names: []string{"bar"},
},
}

os.Args = []string{"/path/to/app", "--", "--foo", "sub", "bar", "-@"}

cmd := cliargs.NewCmd()
subCmd, err := cmd.ParseUntilSubCmdWith(optCfgs0)

assert.Nil(t, err)
assert.Equal(t, cmd.Name, "app")
assert.Equal(t, cmd.Args, []string{})
assert.Equal(t, cmd.HasOpt("foo"), false)
assert.Equal(t, cmd.OptArg("foo"), "")
assert.Equal(t, cmd.OptArgs("foo"), []string(nil))
assert.Equal(t, cmd.HasOpt("bar"), false)
assert.Equal(t, cmd.OptArg("bar"), "")
assert.Equal(t, cmd.OptArgs("bar"), []string(nil))

err = subCmd.ParseWith(optCfgs1)

assert.Nil(t, err)
assert.Equal(t, subCmd.Name, "--foo")
assert.Equal(t, subCmd.Args, []string{"sub", "bar", "-@"})
assert.Equal(t, subCmd.HasOpt("foo"), false)
assert.Equal(t, subCmd.OptArg("foo"), "")
assert.Equal(t, subCmd.OptArgs("foo"), []string(nil))
assert.Equal(t, subCmd.HasOpt("bar"), false)
assert.Equal(t, subCmd.OptArg("bar"), "")
assert.Equal(t, subCmd.OptArgs("bar"), []string(nil))
}
23 changes: 12 additions & 11 deletions parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ func (cmd *Cmd) Parse() error {
return nil
}

_, err := parseArgs(cmd._args, collectArgs, collectOpts, takeOptArgs, false)
_, _, err := parseArgs(cmd._args, collectArgs, collectOpts, takeOptArgs, false, cmd.isAfterEndOpt)
return err
}

Expand All @@ -84,11 +84,12 @@ func (cmd *Cmd) ParseUntilSubCmd() (Cmd, error) {
return nil
}

idx, err := parseArgs(cmd._args, collectArgs, collectOpts, takeOptArgs, true)
idx, isAfterEndOpt, err := parseArgs(
cmd._args, collectArgs, collectOpts, takeOptArgs, true, cmd.isAfterEndOpt)
if idx < 0 {
return Cmd{}, err
}
return cmd.subCmd(idx), err
return cmd.subCmd(idx, isAfterEndOpt), err
}

func takeOptArgs(_opt string) bool {
Expand All @@ -101,17 +102,17 @@ func parseArgs(
collectOpts func(string, ...string) error,
takeOptArgs func(string) bool,
untilFirstArg bool,
) (int, error) {
isAfterEndOpt bool,
) (int, bool, error) {

isNonOpt := false
prevOptTakingArgs := ""
var firstErr error = nil

L0:
for iArg, arg := range osArgs {
if isNonOpt {
if isAfterEndOpt {
if untilFirstArg {
return iArg, firstErr
return iArg, isAfterEndOpt, firstErr
}
collectArgs(arg)

Expand All @@ -126,7 +127,7 @@ L0:
}
} else if strings.HasPrefix(arg, "--") {
if len(arg) == 2 {
isNonOpt = true
isAfterEndOpt = true
continue L0
}

Expand Down Expand Up @@ -179,7 +180,7 @@ L0:
} else if strings.HasPrefix(arg, "-") {
if len(arg) == 1 {
if untilFirstArg {
return iArg, firstErr
return iArg, isAfterEndOpt, firstErr
}
collectArgs(arg)
continue L0
Expand Down Expand Up @@ -238,11 +239,11 @@ L0:

} else {
if untilFirstArg {
return iArg, firstErr
return iArg, isAfterEndOpt, firstErr
}
collectArgs(arg)
}
}

return -1, firstErr
return -1, isAfterEndOpt, firstErr
}
Loading
Loading