💡 chore: add package comment or exported var comment

cliutil/termctrl/keyboard.go

@@ -74,5 +74,8 @@ const (
 	KeyAlt  = ' '
 )
 
-var PasteStart = []byte{KeyEscape, '[', '2', '0', '0', '~'}
-var PasteEnd = []byte{KeyEscape, '[', '2', '0', '1', '~'}
+// special chars on paste start or end
+var (
+	PasteStart = []byte{KeyEscape, '[', '2', '0', '0', '~'}
+	PasteEnd   = []byte{KeyEscape, '[', '2', '0', '1', '~'}
+)

cliutil/termctrl/termctrl.go

@@ -0,0 +1,2 @@
+// Package termctrl provide some simple term control utils
+package termctrl

envutil/envutil.go

@@ -1,3 +1,4 @@
+// Package envutil provide some commonly ENV util functions.
 package envutil
 
 import (

errorx/errors.go

@@ -110,6 +110,8 @@ func (e ErrMap) One() error {
 
 // Errors multi error list
 type Errors []error
+
+// ErrList alias for Errors
 type ErrList = Errors
 
 // Error string

fsutil/check.go

@@ -6,12 +6,14 @@ import (
 	"path"
 )
 
+// perm for create dir or file
 var (
-	// DefaultDirPerm perm and flags for create log file
 	DefaultDirPerm   os.FileMode = 0775
 	DefaultFilePerm  os.FileMode = 0665
 	OnlyReadFilePerm os.FileMode = 0444
+)
 
+var (
 	// DefaultFileFlags for create and write
 	DefaultFileFlags = os.O_CREATE | os.O_WRONLY | os.O_APPEND
 	// OnlyReadFileFlags open file for read

mathutil/mathutil.go

@@ -1,3 +1,4 @@
+// Package mathutil provide math(int, number) util functions. eg: convert, math calc, random
 package mathutil
 
 import "math"

netutil/httpctype/content_type.go

@@ -3,7 +3,7 @@ package httpctype
 
 const Key = "Content-Type"
 
-// HTTP Content-Type with charset of the most common data formats.
+// there are some HTTP Content-Type with charset of the most common data formats.
 const (
 	CSS  = "text/css; charset=utf-8"
 	HTML = "text/html; charset=utf-8"

netutil/httpctype/mime_type.go

@@ -1,6 +1,6 @@
 package httpctype
 
-// Content-Type MIME of the most common data formats.
+// there are some Content-Type MIME of the most common data formats.
 const (
 	MIMEHTML  = "text/html"
 	MIMEText  = "text/plain" // equals MIMEPlain

netutil/httpreq/response.go

@@ -77,10 +77,10 @@ func (r *Resp) BodyBuffer() *bytes.Buffer {
 	return buf
 }
 
-// BindJsonOnOk body data on status is 200
+// BindJSONOnOk body data on status is 200
 //
 // NOTICE: must close resp body.
-func (r *Resp) BindJsonOnOk(ptr any) error {
+func (r *Resp) BindJSONOnOk(ptr any) error {
 	// NOTICE: must close resp body.
 	defer r.QuiteCloseBody()
 
@@ -96,10 +96,10 @@ func (r *Resp) BindJsonOnOk(ptr any) error {
 	return json.NewDecoder(r.Body).Decode(ptr)
 }
 
-// BindJson body data to a ptr
+// BindJSON body data to a ptr
 //
 // NOTICE: must close resp body.
-func (r *Resp) BindJson(ptr any) error {
+func (r *Resp) BindJSON(ptr any) error {
 	// NOTICE: must close resp body.
 	defer r.QuiteCloseBody()
 

sysutil/cmdr/runner.go

@@ -24,6 +24,7 @@ type Task struct {
 	PrevCond  func(prev *Task) bool
 }
 
+// NewTask instance
 func NewTask(cmd *Cmd) *Task {
 	return &Task{
 		Cmd: cmd,