Merge branch 'gookit:master' into master

arrutil/collection.go

@@ -135,13 +135,13 @@ func Differences[T any](first, second []T, fn Comparer[T]) []T {
 		return CloneSlice(first)
 	}
 
-	max := firstLen
+	maxLn := firstLen
 	if secondLen > firstLen {
-		max = secondLen
+		maxLn = secondLen
 	}
 
 	result := make([]T, 0)
-	for i := 0; i < max; i++ {
+	for i := 0; i < maxLn; i++ {
 		if i < firstLen {
 			s := first[i]
 			if i, _ := TwowaySearch(second, s, fn); i < 0 {

basefn/basefn.go

@@ -54,14 +54,41 @@ func MustOK(err error) {
 	}
 }
 
-// Must if error is not empty, will panic
+// Must return like (v, error). will panic on error, otherwise return v.
+//
+// Usage:
+//
+//	// old
+//	v, err := fn()
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	// new
+//	v := goutil.Must(fn())
 func Must[T any](v T, err error) T {
 	if err != nil {
 		panic(err)
 	}
 	return v
 }
 
+// MustIgnore for return like (v, error). Ignore return v and will panic on error.
+//
+// Useful for io, file operation func: (n int, err error)
+//
+// Usage:
+//
+//	// old
+//	_, err := fn()
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	// new
+//	basefn.MustIgnore(fn())
+func MustIgnore(_ any, err error) { PanicErr(err) }
+
 // ErrOnFail return input error on cond is false, otherwise return nil
 func ErrOnFail(cond bool, err error) error {
 	return OrError(cond, err)

basefn/basefn_test.go

@@ -30,10 +30,19 @@ func TestPanicIf(t *testing.T) {
 }
 
 func TestPanicErr(t *testing.T) {
+	basefn.MustOK(nil)
 	basefn.PanicErr(nil)
 	assert.Panics(t, func() {
 		basefn.PanicErr(errors.New("a error"))
 	})
+
+	// must ignore
+	assert.NotPanics(t, func() {
+		basefn.MustIgnore(nil, nil)
+	})
+	assert.Panics(t, func() {
+		basefn.MustIgnore(nil, errors.New("a error"))
+	})
 }
 
 func TestPanicf(t *testing.T) {

dump/dumper_test.go

@@ -213,7 +213,7 @@ func TestDumper_AccessCantExportedField1(t *testing.T) {
 
 // ------------------------- map -------------------------
 
-func TestDump_Map(t *testing.T) {
+func TestDump_Map(_ *testing.T) {
 	m4 := map[string]any{
 		"key1": 12,
 		"key2": "val1",
@@ -360,11 +360,11 @@ var (
 	s1 = st1{st0{2}, 23, "inhere"}
 )
 
-func TestDump_Struct(t *testing.T) {
+func TestDump_Struct(_ *testing.T) {
 	P(user)
 }
 
-func TestStruct_WithNested(t *testing.T) {
+func TestStruct_WithNested(_ *testing.T) {
 	// buffer := new(bytes.Buffer)
 	dumper := newStd()
 	dumper.IndentChar = '.'
@@ -423,7 +423,7 @@ func TestStruct_WithNested(t *testing.T) {
 	// }
 }
 
-func TestDumper_Dump_userType(t *testing.T) {
+func TestDumper_Dump_userType(_ *testing.T) {
 	type testSt struct {
 		name string
 		mod  fs.FileMode

fsutil/fsutil.go

@@ -6,6 +6,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	"github.com/gookit/goutil/basefn"
 	"github.com/gookit/goutil/internal/comfunc"
 )
 
@@ -54,3 +55,6 @@ func ToAbsPath(p string) string {
 	}
 	return filepath.Join(wd, p)
 }
+
+// Must2 ok for (any, error) result. if has error, will panic
+func Must2(_ any, err error) { basefn.MustOK(err) }

fsutil/opread.go

@@ -27,9 +27,7 @@ func DiscardReader(src io.Reader) {
 }
 
 // ReadFile read file contents, will panic on error
-func ReadFile(filePath string) []byte {
-	return MustReadFile(filePath)
-}
+func ReadFile(filePath string) []byte { return MustReadFile(filePath) }
 
 // MustReadFile read file contents, will panic on error
 func MustReadFile(filePath string) []byte {
@@ -53,9 +51,7 @@ func MustReadReader(r io.Reader) []byte {
 }
 
 // ReadString read contents from path or io.Reader, will panic on in type error
-func ReadString(in any) string {
-	return string(GetContents(in))
-}
+func ReadString(in any) string { return string(GetContents(in)) }
 
 // ReadStringOrErr read contents from path or io.Reader, will panic on in type error
 func ReadStringOrErr(in any) (string, error) {
@@ -78,9 +74,7 @@ func ReadAll(in any) []byte { return MustRead(in) }
 func GetContents(in any) []byte { return MustRead(in) }
 
 // MustRead read contents from path or io.Reader, will panic on in type error
-func MustRead(in any) []byte {
-	return basefn.Must(ReadOrErr(in))
-}
+func MustRead(in any) []byte { return basefn.Must(ReadOrErr(in)) }
 
 // ReadOrErr read contents from path or io.Reader, will panic on in type error
 func ReadOrErr(in any) ([]byte, error) {

fsutil/opwrite.go

@@ -83,6 +83,7 @@ func SaveFile(filePath string, data any, optFns ...OpenOptionFunc) error {
 // Usage:
 //
 //	fsutil.PutContents(filePath, contents, fsutil.FsCWAFlags) // append write
+//	fsutil.Must2(fsutil.PutContents(filePath, contents)) // panic on error
 func PutContents(filePath string, data any, fileFlag ...int) (int, error) {
 	f, err := QuickOpenFile(filePath, basefn.FirstOr(fileFlag, FsCWTFlags))
 	if err != nil {

fsutil/opwrite_test.go

@@ -15,9 +15,7 @@ func TestMustCopyFile(t *testing.T) {
 	assert.NoErr(t, fsutil.RmIfExist(srcPath))
 	assert.NoErr(t, fsutil.RmFileIfExist(dstPath))
 
-	_, err := fsutil.PutContents(srcPath, "hello")
-	assert.NoErr(t, err)
-
+	fsutil.Must2(fsutil.PutContents(srcPath, "hello"))
 	fsutil.MustCopyFile(srcPath, dstPath)
 	assert.Eq(t, []byte("hello"), fsutil.GetContents(dstPath))
 	assert.Eq(t, "hello", fsutil.ReadString(dstPath))

go.mod

@@ -4,9 +4,9 @@ go 1.19
 
 require (
 	github.com/gookit/color v1.5.4
-	golang.org/x/sync v0.5.0
-	golang.org/x/sys v0.15.0
-	golang.org/x/term v0.15.0
+	golang.org/x/sync v0.6.0
+	golang.org/x/sys v0.16.0
+	golang.org/x/term v0.16.0
 	golang.org/x/text v0.14.0
 )
 

go.sum

@@ -6,12 +6,12 @@ github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcU
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
 github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
 golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
-golang.org/x/sync v0.5.0 h1:60k92dhOjHxJkrqnwsfl8KuaHbn/5dl0lUPUklKo3qE=
-golang.org/x/sync v0.5.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
-golang.org/x/sys v0.15.0 h1:h48lPFYpsTvQJZF4EKyI4aLHaev3CxivZmv7yZig9pc=
-golang.org/x/sys v0.15.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/term v0.15.0 h1:y/Oo/a/q3IXu26lQgl04j/gjuBDOBlx7X6Om1j2CPW4=
-golang.org/x/term v0.15.0/go.mod h1:BDl952bC7+uMoWR75FIrCDx79TPU9oHkTZ9yRbYOrX0=
+golang.org/x/sync v0.6.0 h1:5BMeUDZ7vkXGfEr1x9B4bRcTH4lpkTkpdh0T/J+qjbQ=
+golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
+golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/term v0.16.0 h1:m+B6fahuftsE9qjo0VWp2FW0mB3MTJvR0BaMQrq0pmE=
+golang.org/x/term v0.16.0/go.mod h1:yn7UURbUtPyrVJPGPq404EukNFxcm/foM+bV/bfcDsY=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

goutil.go

@@ -23,28 +23,50 @@ func PanicIf(cond bool, fmtAndArgs ...any) {
 	basefn.PanicIf(cond, fmtAndArgs...)
 }
 
-// PanicIfErr if error is not empty, will panic
-func PanicIfErr(err error) {
-	if err != nil {
-		panic(err)
-	}
-}
-
-// PanicErr if error is not empty, will panic
+// PanicErr if error is not empty, will panic.
+// Alias of basefn.PanicErr()
 func PanicErr(err error) {
 	if err != nil {
 		panic(err)
 	}
 }
 
-// MustOK if error is not empty, will panic
-func MustOK(err error) {
-	if err != nil {
-		panic(err)
-	}
-}
+// PanicIfErr if error is not empty, will panic.
+// Alias of basefn.PanicErr()
+func PanicIfErr(err error) { PanicErr(err) }
+
+// MustOK if error is not empty, will panic.
+// Alias of basefn.MustOK()
+func MustOK(err error) { PanicErr(err) }
 
-// Must if error is not empty, will panic
+// MustIgnore for return like (v, error). Ignore return v and will panic on error.
+//
+// Useful for io, file operation func: (n int, err error)
+//
+// Usage:
+//
+//	// old
+//	_, err := fn()
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	// new
+//	goutil.MustIgnore(fn())
+func MustIgnore(_ any, err error) { PanicErr(err) }
+
+// Must return like (v, error). will panic on error, otherwise return v.
+//
+// Usage:
+//
+//	// old
+//	v, err := fn()
+//	if err != nil {
+//		panic(err)
+//	}
+//
+//	// new
+//	v := goutil.Must(fn())
 func Must[T any](v T, err error) T {
 	if err != nil {
 		panic(err)

goutil_test.go

@@ -15,7 +15,7 @@ var testSrvAddr string
 func TestMain(m *testing.M) {
 	s := testutil.NewEchoServer()
 	defer s.Close()
-	testSrvAddr = "http://" + s.Listener.Addr().String()
+	testSrvAddr = s.HTTPHost()
 	fmt.Println("Test server listen on:", testSrvAddr)
 
 	m.Run()
@@ -51,6 +51,13 @@ func TestPanicIfErr(t *testing.T) {
 	assert.Panics(t, func() {
 		goutil.Must("hi", errors.New("a error"))
 	})
+
+	assert.NotPanics(t, func() {
+		goutil.MustIgnore(nil, nil)
+	})
+	assert.Panics(t, func() {
+		goutil.MustIgnore(nil, errors.New("a error"))
+	})
 }
 
 func TestPanicf(t *testing.T) {

internal/TODO.md

@@ -3,4 +3,39 @@
 ## new package
 
 - misc package 杂项
-- syncs package
+- syncs package
+
+## 重新规划包结构和名称
+
+```text
+# tree -L 1 -d                                                                                                                                                                                                            24-01-05 - 20:31:13
+.
+├── arrutil(rename: arrays, arrayx)
+├── basefn
+├── byteutil(rename: bytex)
+├── cliutil
+├── comdef
+├── envutil
+├── fmtutil
+├── fsutil
+├── goinfo
+├── internal
+├── jsonutil
+├── maputil(rename: mapx)
+├── mathutil(rename: numutil, numbers)
+├── netutil
+├── reflects
+├── stdio
+├── structs
+├── strutil(rename: strx, stringx)
+├── syncs
+├── sysutil
+├── testutil(rename: testx)
+├── timex
+├── z
+│   ├── cflag
+│   ├── dump
+│   ├── encodes
+│   ├── errorx
+
+```

strutil/check.go

@@ -290,9 +290,8 @@ func LikeMatch(pattern, s string) bool {
 	if pattern[0] == '%' {
 		if ln > 2 && pattern[ln-1] == '%' {
 			return strings.Contains(s, pattern[1:ln-1])
-		} else {
-			return strings.HasSuffix(s, pattern[1:])
 		}
+		return strings.HasSuffix(s, pattern[1:])
 	}
 
 	// eg `abc%`

strutil/convbase.go

@@ -55,7 +55,7 @@ func BaseConvByTpl(src string, fromBase, toBase string) string {
 	}
 
 	// convert to base 10
-	var dec uint64 = 0
+	var dec uint64
 	if fromBase == Base10Chars {
 		var err error
 		dec, err = strconv.ParseUint(src, 10, 0)

strutil/parse.go

@@ -45,6 +45,8 @@ var layoutMap = map[int][]string{
 }
 
 // ToTime convert date string to time.Time
+//
+// NOTE: always use local timezone.
 func ToTime(s string, layouts ...string) (t time.Time, err error) {
 	// custom layout
 	if len(layouts) > 0 {