go-pkg/cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

final checks on opt values moved after option parsing is complete

Browse Source
This commit is contained in:
Celestino Amoroso 2026-03-06 10:36:07 +01:00
parent 92267aec50
commit 9e28ee6545
11 changed files with 142 additions and 115 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
cli.go
View File

@ -25,7 +25,7 @@ type cliOptionParser interface {
isSet() bool
isHidden() bool
requiresValue() bool
finalCheck(cliValue string) (err error)
finalCheck() (err error)
}
type OptManager interface {
@ -33,7 +33,7 @@ type OptManager interface {
}
type SpecialValueFunc func(manager OptManager, cliValue string, currentValue any) (value any, err error)
type FinalCheckFunc func(cliValue string, currentValue any) (err error)
type FinalCheckFunc func(currentValue any) (err error)
type OptReference interface {
AddSpecialValue(cliValue string, specialFunc SpecialValueFunc)
@ -158,17 +158,12 @@ func (cli *CliParser) addHelpAndVersion() {
}
func (cli *CliParser) Parse() (err error) {
var arg string
var i int
var commandArgs []string
func (cli *CliParser) parseOptions() (commandArgs []string, err error) {
// var commandArgs []string
var optionsAllowed bool = true
cli.addHelpAndVersion()
// first parse options and collect argument in the args array
skipNext := false
for i, arg = range cli.cliArgs[1:] {
for i, arg := range cli.cliArgs[1:] {
if skipNext {
skipNext = false
} else {
@ -186,12 +181,22 @@ func (cli *CliParser) Parse() (err error) {
}
}
}
return
}
// then parse collected arguments
if err == nil {
func (cli *CliParser) checkOptionValues() (err error) {
for _, opt := range cli.options {
if err = opt.finalCheck(); err != nil {
break
}
}
return
}
func (cli *CliParser) parseCommandArgs(commandArgs []string) (err error) {
var n int
i = 0
i := 0
// acquire arguments as required by the argSpecs
specIndex := -1
for index, argSpec := range cli.argSpecs {
@ -225,7 +230,26 @@ func (cli *CliParser) Parse() (err error) {
}
}
}
return
}
func (cli *CliParser) Parse() (err error) {
var commandArgs []string
cli.addHelpAndVersion()
// first parse options and collect command arguments in the args array
if commandArgs, err = cli.parseOptions(); err != nil {
return
}
// do final checks
if err = cli.checkOptionValues(); err != nil {
return
}
// then parse collected arguments
err = cli.parseCommandArgs(commandArgs)
return
}

6
opt-base.go
View File

@ -153,13 +153,13 @@ func (opt *cliOptionBase) fetchOptionValue(parser cliParser, argIndex int, value
return
}
func (opt *cliOptionBase) finalCheck(cliValue string) (err error) {
func (opt *cliOptionBase) finalCheck() (err error) {
return
}
func (opt *cliOptionBase) checkValue(cliValue string, value any) (err error) {
func (opt *cliOptionBase) checkValue(value any) (err error) {
if opt.finalCheckFunc != nil {
err = opt.finalCheckFunc(cliValue, value)
err = opt.finalCheckFunc(value)
}
return
}

4
opt-bool.go
View File

@ -67,9 +67,9 @@ func (opt *cliOptionBool) parse(parser cliParser, argIndex int, valuePtr *string
return
}
func (opt *cliOptionBool) finalCheck(cliValue string) (err error) {
func (opt *cliOptionBool) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddBoolOpt(name, short string, targetVar *bool, description string, aliases ...string) OptReference {

4
opt-int-array.go
View File

@ -97,9 +97,9 @@ func (opt *cliOptionIntArray) parse(parser cliParser, argIndex int, valuePtr *st
return
}
func (opt *cliOptionIntArray) finalCheck(cliValue string) (err error) {
func (opt *cliOptionIntArray) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddIntArrayOpt(name, short string, targetVar *[]int, defaultValue []int, description string, aliases ...string) OptReference {

4
opt-int.go
View File

@ -57,9 +57,9 @@ func (opt *cliOptionInt) parse(parser cliParser, argIndex int, valuePtr *string)
}
return
}
func (opt *cliOptionInt) finalCheck(cliValue string) (err error) {
func (opt *cliOptionInt) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddIntOpt(name, short string, targetVar *int, defaultValue int, description string, aliases ...string) OptReference {

4
opt-multi.go
View File

@ -53,9 +53,9 @@ func (opt *cliOptionMulti) parse(parser cliParser, argIndex int, valuePtr *strin
value = "true"
return
}
func (opt *cliOptionMulti) finalCheck(cliValue string) (err error) {
func (opt *cliOptionMulti) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddMultiOpt(name, short string, targetVar *int, defaultValue int, description string, aliases ...string) OptReference {

4
opt-string-array.go
View File

@ -85,7 +85,7 @@ func (cli *CliParser) AddStringArrayOpt(name, short string, targetVar *[]string,
return opt
}
func (opt *cliOptionStringArray) finalCheck(cliValue string) (err error) {
func (opt *cliOptionStringArray) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}

4
opt-string-map.go
View File

@ -89,9 +89,9 @@ func (opt *cliOptionStringMap) parse(parser cliParser, argIndex int, valuePtr *s
return
}
func (opt *cliOptionStringMap) finalCheck(cliValue string) (err error) {
func (opt *cliOptionStringMap) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddStringMapOpt(name, short string, targetVar *map[string]string, defaultValue map[string]string, description string, aliases ...string) OptReference {

4
opt-string.go
View File

@ -55,9 +55,9 @@ func (opt *cliOptionString) parse(parser cliParser, argIndex int, valuePtr *stri
}
return
}
func (opt *cliOptionString) finalCheck(cliValue string) (err error) {
func (opt *cliOptionString) finalCheck() (err error) {
currentValue, _ := opt.getTargetVar()
return opt.getBase().checkValue(cliValue, currentValue)
return opt.getBase().checkValue(currentValue)
}
func (cli *CliParser) AddStringOpt(name, short string, targetVar *string, defaultValue string, description string, aliases ...string) OptReference {

105
opt_test.go
View File

@ -37,7 +37,7 @@ func TestOneOptWithEqual(t *testing.T) {
func addBoxOption(cli *CliParser, boxPtr *[]int) {
// Define options
optRef := cli.AddIntArrayOpt("box", "b", boxPtr, []int{1, 2, 3, 4}, "Box spec: Left,Width,Top,Height; provide 4 int values")
optRef.OnFinalCheck(func(cliValue string, currentValue any) (err error) {
optRef.OnFinalCheck(func(currentValue any) (err error) {
if array, ok := currentValue.([]int); ok {
if len(array) != 4 {
err = fmt.Errorf("--box option requires exactly 4 items, %d provided", len(array))
@ -49,8 +49,34 @@ func addBoxOption(cli *CliParser, boxPtr *[]int) {
})
}
func TestIntArrayOpt(t *testing.T) {
func testIntArrayOptOk(t *testing.T, n int, args []string) {
var box []int
var cli CliParser
t.Logf("Arg set n. %d", n)
addBoxOption(&cli, &box)
cli.Init(args, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err != nil {
t.Error(err)
} else if len(box) != 4 {
t.Errorf(`Expected 4 items, got %d`, len(box))
}
}
func testIntArrayOptKo(t *testing.T, n int, args []string, msg string) {
var box []int
var cli CliParser
t.Logf("Arg set n. %d", n)
addBoxOption(&cli, &box)
cli.Init(args, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err == nil {
t.Errorf("Expected error, got nil")
} else if err.Error() != msg {
t.Errorf(`Invalid error: %q; expected: %q`, err.Error(), msg)
}
}
func TestIntArrayOpt(t *testing.T) {
var args []string
// Always recover from panic to return error before adding options
defer func() {
if r := recover(); r != nil {
@ -61,68 +87,49 @@ func TestIntArrayOpt(t *testing.T) {
}
}()
args_1 := []string{
n := 0
n++
args = []string{
"TestIntArrayOpt",
"--box=100,200,150,450",
}
testIntArrayOptOk(t, n, args)
if true {
var cli CliParser
t.Logf("Arg set n. 1")
addBoxOption(&cli, &box)
cli.Init(args_1, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err != nil {
t.Error(err)
} else if len(box) != 4 {
t.Errorf(`Expected 4 items, got %d`, len(box))
}
}
args_2 := []string{
n++
args = []string{
"TestIntArrayOpt",
"--box=100,200,150",
}
if true {
var cli CliParser
t.Logf("Arg set n. 2")
addBoxOption(&cli, &box)
cli.Init(args_2, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err == nil {
t.Errorf("Expected error, got nil")
} else if err.Error() != "--box option requires exactly 4 items, 3 provided" {
t.Errorf(`Invalid error: %q; expected: "--box option requires exactly 4 items, 3 provided"`, err.Error())
}
}
testIntArrayOptKo(t, n, args, "--box option requires exactly 4 items, 3 provided")
args_3 := []string{
n++
args = []string{
"TestIntArrayOpt",
"--box", "100,200,150,450",
}
if true {
var cli CliParser
t.Logf("Arg set n. 3")
addBoxOption(&cli, &box)
cli.Init(args_3, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err != nil {
t.Error(err)
} else if len(box) != 4 {
t.Errorf(`Expected 4 items, got %d`, len(box))
}
}
testIntArrayOptOk(t, n, args)
args_4 := []string{
n++
args = []string{
"TestIntArrayOpt",
"--box",
}
if true {
var cli CliParser
t.Logf("Arg set n. 4")
addBoxOption(&cli, &box)
cli.Init(args_4, "1.0.0", "TestIntArrayOpt description")
if err := cli.Parse(); err == nil {
t.Errorf("Expected error, got nil")
} else if err.Error() != `option "box" requires a value` {
t.Errorf(`Invalid error - Expected: 'option "box" requires a value'; got '%s'`, err.Error())
testIntArrayOptKo(t, n, args, `option "box" requires a value`)
n++
args = []string{
"TestIntArrayOpt",
"--box", "100,200,150",
"--box", "450",
}
testIntArrayOptOk(t, n, args)
n++
args = []string{
"TestIntArrayOpt",
"--box", "100,200,150",
"--box", "450,12",
}
testIntArrayOptKo(t, n, args, "--box option requires exactly 4 items, 5 provided")
}

8
parser.go
View File

@ -104,16 +104,12 @@ func (cli *CliParser) parseArg(arg string, index int) (skipNextArg bool, err err
}
for i, optName := range opts {
if opt := cli.findOptionByArg(dashes + optName); opt != nil {
var optValue string
if equalPresent && i == len(opts)-1 {
_, optValue, err = opt.parse(cli, index, &value)
_, _, err = opt.parse(cli, index, &value)
} else if i < len(opts)-1 && opt.requiresValue() {
err = errMissingOptionValue(dashes + optName)
} else {
skipNextArg, optValue, err = opt.parse(cli, index, nil)
}
if err == nil && i == len(opts)-1 {
err = opt.finalCheck(optValue)
skipNextArg, _, err = opt.parse(cli, index, nil)
}
} else {
err = errUnknownOption(dashes + optName)