💡 chore: add comment for exported vars, methods.

- re-generate readme docs
- use os and io func instead io/ioutil

dump/dump.go

@@ -19,7 +19,6 @@ const (
 )
 
 const defaultSkip = 3
-const defaultSkip2 = 2
 
 var (
 	// valid flag for print caller info

fsutil/finder/finder.go

@@ -270,7 +270,7 @@ func (f *FileFinder) findInDir(dirPath string) {
 			ok := true
 			for _, df := range f.dirFilters {
 				ok = df.FilterDir(fullPath, baseName)
-				if true == ok { // 有一个满足即可
+				if ok { // 有一个满足即可
 					break
 				}
 			}

fsutil/operate.go

@@ -4,7 +4,6 @@ import (
 	"archive/zip"
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"path"
 	"path/filepath"
@@ -27,12 +26,12 @@ func MkParentDir(fpath string) error {
 
 // DiscardReader anything from the reader
 func DiscardReader(src io.Reader) {
-	_, _ = io.Copy(ioutil.Discard, src)
+	_, _ = io.Copy(io.Discard, src)
 }
 
 // MustReadFile read file contents, will panic on error
 func MustReadFile(filePath string) []byte {
-	bs, err := ioutil.ReadFile(filePath)
+	bs, err := os.ReadFile(filePath)
 	if err != nil {
 		panic(err)
 	}
@@ -42,8 +41,7 @@ func MustReadFile(filePath string) []byte {
 
 // MustReadReader read contents from io.Reader, will panic on error
 func MustReadReader(r io.Reader) []byte {
-	// TODO go 1.16+ bs, err := io.ReadAll(r)
-	bs, err := ioutil.ReadAll(r)
+	bs, err := io.ReadAll(r)
 	if err != nil {
 		panic(err)
 	}
@@ -66,7 +64,7 @@ func GetContents(in any) []byte {
 // ReadExistFile read file contents if existed, will panic on error
 func ReadExistFile(filePath string) []byte {
 	if IsFile(filePath) {
-		bs, err := ioutil.ReadFile(filePath)
+		bs, err := os.ReadFile(filePath)
 		if err != nil {
 			panic(err)
 		}

internal/gendoc/main.go

@@ -242,7 +242,12 @@ func collectPgkFunc(ms []string, basePkg string) *bytes.Buffer {
 		if len(lines) > 0 {
 			bufWriteln(buf, "// source at", filename)
 			for _, line := range lines {
-				bufWriteln(buf, strings.TrimRight(line, "{ "))
+				idx := strings.IndexByte(line, '{')
+				if idx > 0 {
+					bufWriteln(buf, line[:idx])
+				} else {
+					bufWriteln(buf, line)
+				}
 			}
 		}
 	}

jsonutil/jsonutil.go

@@ -5,7 +5,6 @@ import (
 	"bytes"
 	"encoding/json"
 	"io"
-	"io/ioutil"
 	"os"
 	"regexp"
 	"strings"
@@ -18,7 +17,7 @@ func WriteFile(filePath string, data any) error {
 	if err != nil {
 		return err
 	}
-	return ioutil.WriteFile(filePath, jsonBytes, 0664)
+	return os.WriteFile(filePath, jsonBytes, 0664)
 }
 
 // ReadFile Read JSON file data

stdutil/conv_test.go

@@ -66,5 +66,6 @@ func TestBaseTypeVal(t *testing.T) {
 	assert.Err(t, err)
 
 	val, err = stdutil.BaseTypeVal2(reflect.ValueOf(int32(2)))
+	assert.NoErr(t, err)
 	assert.Eq(t, int64(2), val)
 }

structs/setval.go

@@ -163,7 +163,7 @@ func SetValues(ptr any, data map[string]any, optFns ...SetOptFunc) error {
 }
 
 func setValues(rv reflect.Value, data map[string]any, opt *SetOptions) error {
-	if data == nil || len(data) == 0 {
+	if len(data) == 0 {
 		return nil
 	}
 

strutil/secutil/aes_crypt.go

@@ -46,9 +46,9 @@ type AesCrypt struct {
 	iv  []byte
 	key []byte
 
-	init    bool
-	keyLen  int
-	padding string
+	init   bool
+	keyLen int
+	// padding string
 
 	encryptType string
 }

testutil/assert/assertions_methods.go

@@ -13,48 +13,56 @@ func (as *Assertions) NotNil(val any, fmtAndArgs ...any) *Assertions {
 	return as
 }
 
+// True check, please see True()
 func (as *Assertions) True(give bool, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = True(as.t, give, fmtAndArgs...)
 	return as
 }
 
+// False check, please see False()
 func (as *Assertions) False(give bool, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = False(as.t, give, fmtAndArgs...)
 	return as
 }
 
+// Empty check, please see Empty()
 func (as *Assertions) Empty(give any, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = Empty(as.t, give, fmtAndArgs...)
 	return as
 }
 
+// NotEmpty check, please see NotEmpty()
 func (as *Assertions) NotEmpty(give any, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = NotEmpty(as.t, give, fmtAndArgs...)
 	return as
 }
 
+// Panics check, please see Panics()
 func (as *Assertions) Panics(fn PanicRunFunc, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = Panics(as.t, fn, fmtAndArgs...)
 	return as
 }
 
+// NotPanics check, please see NotPanics()
 func (as *Assertions) NotPanics(fn PanicRunFunc, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = NotPanics(as.t, fn, fmtAndArgs...)
 	return as
 }
 
+// PanicsMsg check, please see PanicsMsg()
 func (as *Assertions) PanicsMsg(fn PanicRunFunc, wantVal any, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = PanicsMsg(as.t, fn, wantVal, fmtAndArgs...)
 	return as
 }
 
+// PanicsErrMsg check, please see PanicsErrMsg()
 func (as *Assertions) PanicsErrMsg(fn PanicRunFunc, errMsg string, fmtAndArgs ...any) *Assertions {
 	as.t.Helper()
 	as.ok = PanicsErrMsg(as.t, fn, errMsg, fmtAndArgs...)

testutil/assert/util.go

@@ -58,7 +58,14 @@ func truncatingFormat(data any) string {
 		return "<nil>"
 	}
 
-	value := fmt.Sprintf("%T(%v)", data, data)
+	var value string
+	switch data.(type) {
+	case string:
+		value = fmt.Sprintf("string(%q)", data)
+	default:
+		value = fmt.Sprintf("%T(%v)", data, data)
+	}
+
 	// Give us some space the type info too if needed.
 	max := bufio.MaxScanTokenSize - 100
 	if len(value) > max {