Skip to content

Commit 11a7fb1

Browse files
committed
fix!: modified struct name of an error
1 parent 5876c96 commit 11a7fb1

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

errors/errors.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,19 @@ type InvalidOption interface {
1818
Error() string
1919
}
2020

21-
// OptionHasInvalidChar is the error which indicates that an invalid character
21+
// OptionContainsInvalidChar is the error which indicates that an invalid character
2222
// is found in the option.
23-
type OptionHasInvalidChar struct {
23+
type OptionContainsInvalidChar struct {
2424
Option string
2525
}
2626

2727
// Error is the method to retrieve the message of this error.
28-
func (e OptionHasInvalidChar) Error() string {
29-
return fmt.Sprintf("OptionHasInvalidChar{Option:%s}", e.Option)
28+
func (e OptionContainsInvalidChar) Error() string {
29+
return fmt.Sprintf("OptionContainsInvalidChar{Option:%s}", e.Option)
3030
}
3131

3232
// GetOption is the method to retrieve the name of the option that caused this error.
33-
func (e OptionHasInvalidChar) GetOption() string {
33+
func (e OptionContainsInvalidChar) GetOption() string {
3434
return e.Option
3535
}
3636

errors/errors_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import (
99
"github.com/sttk/cliargs/errors"
1010
)
1111

12-
func TestErrors_OptionHasInvalidChar(t *testing.T) {
13-
e := errors.OptionHasInvalidChar{Option: "foo"}
12+
func TestErrors_OptionContainsInvalidChar(t *testing.T) {
13+
e := errors.OptionContainsInvalidChar{Option: "foo"}
1414
assert.Equal(t, e.Option, "foo")
1515
assert.Equal(t, e.GetOption(), "foo")
16-
assert.Equal(t, e.Error(), "OptionHasInvalidChar{Option:foo}")
16+
assert.Equal(t, e.Error(), "OptionContainsInvalidChar{Option:foo}")
1717

1818
var ee errors.InvalidOption = e
1919
assert.Equal(t, ee.GetOption(), "foo")

parse.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -147,14 +147,14 @@ L0:
147147
}
148148
if !unicode.Is(rangeOfAlNumMarks, r) {
149149
if firstErr == nil {
150-
firstErr = errors.OptionHasInvalidChar{Option: arg}
150+
firstErr = errors.OptionContainsInvalidChar{Option: arg}
151151
}
152152
continue L0
153153
}
154154
} else {
155155
if !unicode.Is(rangeOfAlphabets, r) {
156156
if firstErr == nil {
157-
firstErr = errors.OptionHasInvalidChar{Option: arg}
157+
firstErr = errors.OptionContainsInvalidChar{Option: arg}
158158
}
159159
continue L0
160160
}
@@ -213,7 +213,7 @@ L0:
213213
}
214214
if !unicode.Is(rangeOfAlphabets, r) {
215215
if firstErr == nil {
216-
firstErr = errors.OptionHasInvalidChar{Option: string(r)}
216+
firstErr = errors.OptionContainsInvalidChar{Option: string(r)}
217217
}
218218
name = ""
219219
} else {

parse_test.go

+9-9
Original file line numberDiff line numberDiff line change
@@ -328,9 +328,9 @@ func TestParse_illegalLongOptIfIncludingInvalidChar(t *testing.T) {
328328
err := cmd.Parse()
329329

330330
assert.NotNil(t, err)
331-
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:abc%def}")
331+
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:abc%def}")
332332
switch e := err.(type) {
333-
case errors.OptionHasInvalidChar:
333+
case errors.OptionContainsInvalidChar:
334334
assert.Equal(t, e.Option, "abc%def")
335335
default:
336336
assert.Fail(t, err.Error())
@@ -369,9 +369,9 @@ func TestParse_illegalLongOptIfFirstCharIsNumber(t *testing.T) {
369369
err := cmd.Parse()
370370

371371
assert.NotNil(t, err)
372-
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:1abc}")
372+
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:1abc}")
373373
switch e := err.(type) {
374-
case errors.OptionHasInvalidChar:
374+
case errors.OptionContainsInvalidChar:
375375
assert.Equal(t, e.Option, "1abc")
376376
default:
377377
assert.Fail(t, err.Error())
@@ -410,9 +410,9 @@ func TestParse_illegalLongOptIfFirstCharIsHyphen(t *testing.T) {
410410
err := cmd.Parse()
411411

412412
assert.NotNil(t, err)
413-
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:-aaa=123}")
413+
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:-aaa=123}")
414414
switch e := err.(type) {
415-
case errors.OptionHasInvalidChar:
415+
case errors.OptionContainsInvalidChar:
416416
assert.Equal(t, e.Option, "-aaa=123")
417417
default:
418418
assert.Fail(t, err.Error())
@@ -453,9 +453,9 @@ func TestParse_IllegalCharInShortOpt(t *testing.T) {
453453
err := cmd.Parse()
454454

455455
assert.NotNil(t, err)
456-
assert.Equal(t, err.Error(), "OptionHasInvalidChar{Option:@}")
456+
assert.Equal(t, err.Error(), "OptionContainsInvalidChar{Option:@}")
457457
switch e := err.(type) {
458-
case errors.OptionHasInvalidChar:
458+
case errors.OptionContainsInvalidChar:
459459
assert.Equal(t, e.Option, "@")
460460
default:
461461
assert.Fail(t, err.Error())
@@ -587,7 +587,7 @@ func TestParse_parseAllArgsEvenIfError(t *testing.T) {
587587
err := cmd.Parse()
588588

589589
switch e := err.(type) {
590-
case errors.OptionHasInvalidChar:
590+
case errors.OptionContainsInvalidChar:
591591
assert.Equal(t, e.Option, "1")
592592
default:
593593
assert.Fail(t, err.Error())

0 commit comments

Comments
 (0)