chore: add desc commonts for const, vars and package

cliutil/cmdline/cmdline.go

@@ -0,0 +1,2 @@
+// Package cmdline provide quick build and parse cmd line string.
+package cmdline

fmtutil/fmtutil.go

@@ -0,0 +1,2 @@
+// Package fmtutil provide some format util functions.
+package fmtutil

fsutil/finder/finder.go

@@ -1,3 +1,4 @@
+// Package finder provide a finder tool for find files
 package finder
 
 import (

fsutil/fsutil.go

@@ -1,3 +1,4 @@
+// Package fsutil Filesystem util functions, quick create, read and write file. eg: file and dir check, operate
 package fsutil
 
 import (

fsutil/info.go

@@ -70,13 +70,15 @@ func GlobWithFunc(pattern string, fn func(filePath string) error) (err error) {
 	return
 }
 
-// filter and handle func for FindInDir
 type (
+	// FilterFunc type for FindInDir
 	FilterFunc func(fPath string, fi os.FileInfo) bool
+	// HandleFunc type for FindInDir
 	HandleFunc func(fPath string, fi os.FileInfo) error
 )
 
 // FindInDir code refer the go pkg: path/filepath.glob()
+//
 // filters: return false will skip the file.
 func FindInDir(dir string, handleFn HandleFunc, filters ...FilterFunc) (e error) {
 	fi, err := os.Stat(dir)

jsonutil/jsonutil.go

@@ -1,3 +1,4 @@
+// Package jsonutil provide some util functions for quick operate JSON data
 package jsonutil
 
 import (

maputil/README.md

@@ -1,5 +1,7 @@
 # Map Utils
 
+`maputil` provide map data util functions. eg: convert, sub-value get, simple merge
+
 - use `map[string]any` as Data
 - deep get value by key path
 - deep set value by key path

maputil/maputil.go

@@ -1,3 +1,4 @@
+// Package maputil provide map data util functions. eg: convert, sub-value get, simple merge
 package maputil
 
 import (

netutil/netutil.go

@@ -1,11 +1,13 @@
+// Package netutil provide some network util functions.
 package netutil
 
 import (
 	"net"
+	"net/netip"
 )
 
-// InternalIP get internal IP
-func InternalIP() (ip string) {
+// InternalIPOld get internal IP buy old logic
+func InternalIPOld() (ip string) {
 	addrs, err := net.InterfaceAddrs()
 	if err != nil {
 		panic("Oops: " + err.Error())
@@ -22,3 +24,38 @@ func InternalIP() (ip string) {
 	}
 	return
 }
+
+// InternalIP get internal IP
+func InternalIP() (ip string) {
+	addr := netip.IPv4Unspecified()
+	if addr.IsValid() {
+		return addr.String()
+	}
+
+	addr = netip.IPv6Unspecified()
+	if addr.IsValid() {
+		return addr.String()
+	}
+
+	return ""
+}
+
+// InternalIPv4 get internal IPv4
+func InternalIPv4() (ip string) {
+	addr := netip.IPv4Unspecified()
+
+	if addr.IsValid() {
+		return addr.String()
+	}
+	return ""
+}
+
+// InternalIPv6 get internal IPv6
+func InternalIPv6() (ip string) {
+	addr := netip.IPv6Unspecified()
+
+	if addr.IsValid() {
+		return addr.String()
+	}
+	return ""
+}

reflects/README.md

@@ -1,5 +1,7 @@
 # Reflects
 
+`reflects` Provide extends reflect util functions.
+
 - some features
 
 ## Install

reflects/reflects.go

@@ -0,0 +1,2 @@
+// Package reflects Provide extends reflect util functions.
+package reflects

stdio/README.md

@@ -0,0 +1,29 @@
+# Stdio
+
+`stdio` provide some standard IO util functions.
+
+## Install
+
+```bash
+go get github.com/gookit/goutil/stdio
+```
+
+## Go docs
+
+- [Go docs](https://pkg.go.dev/github.com/gookit/goutil/stdio)
+
+## Usage
+
+Please see tests.
+
+## Testings
+
+```shell
+go test -v ./stdio/...
+```
+
+Test limit by regexp:
+
+```shell
+go test -v -run ^TestSetByKeys ./stdio/...
+```

stdio/stdio.go

@@ -0,0 +1,2 @@
+// Package stdio provide some standard IO util functions.
+package stdio

stdio/writer.go

@@ -5,7 +5,7 @@ import (
 	"io"
 )
 
-// WriteWrapper struct
+// WriteWrapper warp io.Writer support more operate methods.
 type WriteWrapper struct {
 	Out io.Writer
 }

testutil/README.md

@@ -1,13 +1,15 @@
 # Test Utils
 
+`testutil` provide some test help util functions. eg: http test, mock ENV value
+
 - `assert` go tests helper
 - env variable mocks
 - http request mock 
 
 ## Install
 
 ```bash
-go get github.com/gookit/goutil/sysutil
+go get github.com/gookit/goutil/testutil
 ```
 
 ## [`assert`](./assert) tests

testutil/testutil.go

@@ -1,3 +1,4 @@
+// Package testutil provide some test help util functions. eg: http test, mock ENV value
 package testutil
 
 import (

testutil/writer.go

@@ -21,18 +21,21 @@ func NewTestWriter() *TestWriter {
 }
 
 // SetErrOnWrite method
-func (w *TestWriter) SetErrOnWrite() {
+func (w *TestWriter) SetErrOnWrite() *TestWriter {
 	w.ErrOnWrite = true
+	return w
 }
 
 // SetErrOnFlush method
-func (w *TestWriter) SetErrOnFlush() {
+func (w *TestWriter) SetErrOnFlush() *TestWriter {
 	w.ErrOnFlush = true
+	return w
 }
 
 // SetErrOnClose method
-func (w *TestWriter) SetErrOnClose() {
+func (w *TestWriter) SetErrOnClose() *TestWriter {
 	w.ErrOnClose = true
+	return w
 }
 
 // Flush implements