Fixing the coding style warning which report by golint and revive

example/backend-service/mirror/mirror.go

@@ -8,14 +8,17 @@ import (
 	"time"
 )
 
+// TeeWriter is an io.Writer wapper.
 type TeeWriter struct {
 	writers []io.Writer
 }
 
+// NewTeeWriter returns a TeeWriter.
 func NewTeeWriter(writers ...io.Writer) *TeeWriter {
 	return &TeeWriter{writers: writers}
 }
 
+// Write writes the data.
 func (tw *TeeWriter) Write(p []byte) (n int, err error) {
 	for _, w := range tw.writers {
 		w.Write(p)

pkg/api/api.go

@@ -46,20 +46,20 @@ const (
 
 var (
 	apisMutex      = sync.Mutex{}
-	apis           = make(map[string]*APIGroup)
+	apis           = make(map[string]*Group)
 	apisChangeChan = make(chan struct{}, 10)
 
-	appendAddonAPIs []func(s *Server, group *APIGroup)
+	appendAddonAPIs []func(s *Server, group *Group)
 )
 
-type apisbyOrder []*APIGroup
+type apisbyOrder []*Group
 
 func (a apisbyOrder) Less(i, j int) bool { return a[i].Group < a[j].Group }
 func (a apisbyOrder) Len() int           { return len(a) }
 func (a apisbyOrder) Swap(i, j int)      { a[i], a[j] = a[j], a[i] }
 
 // RegisterAPIs registers global admin APIs.
-func RegisterAPIs(apiGroup *APIGroup) {
+func RegisterAPIs(apiGroup *Group) {
 	apisMutex.Lock()
 	defer apisMutex.Unlock()
 
@@ -73,6 +73,7 @@ func RegisterAPIs(apiGroup *APIGroup) {
 	apisChangeChan <- struct{}{}
 }
 
+// UnregisterAPIs unregisters the API group.
 func UnregisterAPIs(group string) {
 	apisMutex.Lock()
 	defer apisMutex.Unlock()
@@ -90,7 +91,7 @@ func UnregisterAPIs(group string) {
 }
 
 func (s *Server) registerAPIs() {
-	group := &APIGroup{
+	group := &Group{
 		Group: "admin",
 	}
 	group.Entries = append(group.Entries, s.listAPIEntries()...)
@@ -107,8 +108,8 @@ func (s *Server) registerAPIs() {
 	RegisterAPIs(group)
 }
 
-func (s *Server) listAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) listAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			Path:    "",
 			Method:  "GET",
@@ -117,8 +118,8 @@ func (s *Server) listAPIEntries() []*APIEntry {
 	}
 }
 
-func (s *Server) healthAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) healthAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			// https://stackoverflow.com/a/43381061/1705845
 			Path:    "/healthz",
@@ -128,8 +129,8 @@ func (s *Server) healthAPIEntries() []*APIEntry {
 	}
 }
 
-func (s *Server) aboutAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) aboutAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			Path:   "/about",
 			Method: "GET",
@@ -145,7 +146,7 @@ func (s *Server) listAPIs(w http.ResponseWriter, r *http.Request) {
 	apisMutex.Lock()
 	defer apisMutex.Unlock()
 
-	apiGroups := []*APIGroup{}
+	apiGroups := []*Group{}
 
 	for _, group := range apis {
 		apiGroups = append(apiGroups, group)

pkg/api/dynamicmux.go

@@ -50,7 +50,7 @@ func (m *dynamicMux) reloadAPIs() {
 	apisMutex.Lock()
 	defer apisMutex.Unlock()
 
-	apiGroups := []*APIGroup{}
+	apiGroups := []*Group{}
 
 	for _, group := range apis {
 		apiGroups = append(apiGroups, group)

pkg/api/error.go

@@ -26,8 +26,8 @@ import (
 type (
 	clusterErr string
 
-	// APIErr is the standard return of error.
-	APIErr struct {
+	// Err is the standard return of error.
+	Err struct {
 		Code    int    `yaml:"code"`
 		Message string `yaml:"message"`
 	}
@@ -45,7 +45,7 @@ func ClusterPanic(err error) {
 // HandleAPIError handles api error.
 func HandleAPIError(w http.ResponseWriter, r *http.Request, code int, err error) {
 	w.WriteHeader(code)
-	buff, err := yaml.Marshal(APIErr{
+	buff, err := yaml.Marshal(Err{
 		Code:    code,
 		Message: err.Error(),
 	})

pkg/api/member.go

@@ -28,8 +28,8 @@ import (
 	"github.com/megaease/easegress/pkg/cluster"
 )
 
-func (s *Server) memberAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) memberAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			Path:    "/status/members",
 			Method:  "GET",

pkg/api/metadata.go

@@ -72,8 +72,8 @@ func (s *Server) initMetadata() {
 
 }
 
-func (s *Server) metadataAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) metadataAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			Path:    FilterMetaPrefix,
 			Method:  "GET",

pkg/api/object.go

@@ -40,8 +40,8 @@ const (
 	StatusObjectPrefix = "/status/objects"
 )
 
-func (s *Server) objectAPIEntries() []*APIEntry {
-	return []*APIEntry{
+func (s *Server) objectAPIEntries() []*Entry {
+	return []*Entry{
 		{
 			Path:    ObjectKindsPrefix,
 			Method:  "GET",

pkg/api/server.go

@@ -42,13 +42,14 @@ type (
 		mutexMutex sync.Mutex
 	}
 
-	APIGroup struct {
+	// Group is the API group
+	Group struct {
 		Group   string
-		Entries []*APIEntry
+		Entries []*Entry
 	}
 
-	// APIEntry is the entry of API.
-	APIEntry struct {
+	// Entry is the entry of API.
+	Entry struct {
 		Path    string           `yaml:"path"`
 		Method  string           `yaml:"method"`
 		Handler http.HandlerFunc `yaml:"-"`

pkg/cluster/syncer.go

@@ -171,6 +171,7 @@ func (s *Syncer) run(key string, prefix bool, send func(data map[string]*mvccpb.
 	}
 }
 
+// Sync syncs a given Etcd key's value through the returned channel.
 func (s *Syncer) Sync(key string) (<-chan *string, error) {
 	ch := make(chan *string, 10)
 
@@ -191,6 +192,7 @@ func (s *Syncer) Sync(key string) (<-chan *string, error) {
 	return ch, nil
 }
 
+// SyncRaw syncs a given Etcd key's raw Etcd mvccpb structure through the returned channel.
 func (s *Syncer) SyncRaw(key string) (<-chan *mvccpb.KeyValue, error) {
 	ch := make(chan *mvccpb.KeyValue, 10)
 
@@ -206,6 +208,7 @@ func (s *Syncer) SyncRaw(key string) (<-chan *mvccpb.KeyValue, error) {
 	return ch, nil
 }
 
+// SyncPrefix syncs Etcd keys' values with the same prefix through the returned channel.
 func (s *Syncer) SyncPrefix(prefix string) (<-chan map[string]string, error) {
 	ch := make(chan map[string]string, 10)
 
@@ -225,6 +228,7 @@ func (s *Syncer) SyncPrefix(prefix string) (<-chan map[string]string, error) {
 	return ch, nil
 }
 
+// SyncRawPrefix syncs Etcd keys' values with the same prefix in raw Etcd mvccpb structure format through the returned channel.
 func (s *Syncer) SyncRawPrefix(prefix string) (<-chan map[string]*mvccpb.KeyValue, error) {
 	ch := make(chan map[string]*mvccpb.KeyValue, 10)
 
@@ -245,6 +249,7 @@ func (s *Syncer) SyncRawPrefix(prefix string) (<-chan map[string]*mvccpb.KeyValu
 	return ch, nil
 }
 
+// Close closes the syncer.
 func (s *Syncer) Close() {
 	close(s.done)
 }

pkg/common/callback.go

@@ -18,34 +18,40 @@
 package common
 
 const (
+	// CallbacksInitCapacity is the capacity of callback functions.
 	CallbacksInitCapacity = 20
 
-	NormalPriorityCallback   = "__NoRmAl_PrIoRiTy_CaLlBaCk"
+	// NormalPriorityCallback is the name of normal priority callback.
+	NormalPriorityCallback = "__NoRmAl_PrIoRiTy_CaLlBaCk"
+	// CriticalPriorityCallback is the name of critical priority callback.
 	CriticalPriorityCallback = "__CrItIcAl_PrIoRiTy_CaLlBaCk"
 )
 
-////
-
+// NamedCallback is the named callback struct
 type NamedCallback struct {
 	name     string
 	callback interface{}
 }
 
+// NewNamedCallback returns a new named callback.
 func NewNamedCallback(name string, callback interface{}) *NamedCallback {
 	return &NamedCallback{
 		name:     name,
 		callback: callback,
 	}
 }
 
+// Name returns callback name
 func (cb *NamedCallback) Name() string {
 	return cb.name
 }
 
+// Callback returns callback function
 func (cb *NamedCallback) Callback() interface{} {
 	return cb.callback
 }
 
+// SetCallback sets the callback function
 func (cb *NamedCallback) SetCallback(callback interface{}) interface{} {
 	oriCallback := cb.callback
 	cb.callback = callback
@@ -57,32 +63,37 @@ type namedCallbackWithIdx struct {
 	idxOfOrder int
 }
 
+// NamedCallbackSet is a set of NamedCallback
 type NamedCallbackSet struct {
 	// critical callback takes low index, normal callback takes high index
 	callbacks []*NamedCallback                 // index for access by order
 	names     map[string]*namedCallbackWithIdx // index for access by callback constant
 
 }
 
+// NewNamedCallbackSet returns a new NamedCallbackSet
 func NewNamedCallbackSet() *NamedCallbackSet {
 	return &NamedCallbackSet{
 		names:     make(map[string]*namedCallbackWithIdx, CallbacksInitCapacity),
 		callbacks: make([]*NamedCallback, 0, CallbacksInitCapacity),
 	}
 }
 
+// CopyCallbacks copies the current callbacks
 func (cbs *NamedCallbackSet) CopyCallbacks() []*NamedCallback {
 	ret := make([]*NamedCallback, len(cbs.callbacks))
 	copy(ret, cbs.callbacks)
 	return ret
 }
 
+// GetCallbacks get callbacks
 func (cbs *NamedCallbackSet) GetCallbacks() []*NamedCallback {
 	return cbs.callbacks
 }
 
 ////
 
+// AddCallback adds a callback into a callback set with priority
 func AddCallback(cbs *NamedCallbackSet, name string, callback interface{}, priority string) *NamedCallbackSet {
 	if cbs == nil {
 		return nil
@@ -123,6 +134,7 @@ func AddCallback(cbs *NamedCallbackSet, name string, callback interface{}, prior
 	return cbs
 }
 
+// DeleteCallback deletes a callback in callback set
 func DeleteCallback(cbs *NamedCallbackSet, name string) *NamedCallbackSet {
 	if cbs == nil {
 		return nil

pkg/common/go.go

@@ -25,6 +25,7 @@ import (
 	"strings"
 )
 
+// GoID returns goroutine ID
 func GoID() (int, error) {
 	var buf [64]byte
 	n := runtime.Stack(buf[:], false)
@@ -36,6 +37,7 @@ func GoID() (int, error) {
 	return id, nil
 }
 
+// CloseChan closes a channel
 func CloseChan(c interface{}) (ret bool) {
 	val := reflect.ValueOf(c)
 	if val.IsNil() {

pkg/common/lazybuf.go

@@ -29,19 +29,22 @@ type Lazybuf struct {
 	w   int
 }
 
+// NewLazybuf returns lazy buffer
 func NewLazybuf(s string) *Lazybuf {
 	return &Lazybuf{
 		s: s,
 	}
 }
 
+// Index returns a byte by its index
 func (b *Lazybuf) Index(i int) byte {
 	if b.buf != nil {
 		return b.buf[i]
 	}
 	return b.s[i]
 }
 
+// Append appends a byte into buffer
 func (b *Lazybuf) Append(c byte) {
 	if b.buf == nil {
 		if b.w < len(b.s) && b.s[b.w] == c {
@@ -55,6 +58,7 @@ func (b *Lazybuf) Append(c byte) {
 	b.w++
 }
 
+// String returns the string of lazybuf
 func (b *Lazybuf) String() string {
 	if b.buf == nil {
 		return b.s[:b.w]