浏览代码

fix: 解决golint 部分警告 (#897)

* feat:  解决goreportcard的警报
ps: warning: if block ends with a return statement, so drop this else and outdent its block (golint)

* feat: 优化golint警告,将processFieldPrimitiveWithJsonNumber 改成 processFieldPrimitiveWithJSONNumber
unmarshaler.go:248:23: method processFieldPrimitiveWithJsonNumber should be processFieldPrimitiveWithJSONNumber

* feat: 添加 WithCanonicalKeyFunc 注释

* feat: 添加DisableStat的注释

* feat: 添加 RegisterGoctlHome 注释

* feat: 添加 PostgreSqlJoin 注释

* feat: 解决goline警告should not use basic type string as key in context.WithValue问题

* feat: 解决golint警告信息: should not use basic type string as key in context.WithValue

* fix: 定义自定义字段类型,导致go test fail 问题

* update: 恢复原有测试用例

* fix golint warning
市民233 3 年之前
父节点
当前提交
0b0406f41a

+ 4 - 1
core/contextx/unmarshaler_test.go

@@ -8,6 +8,7 @@ import (
 )
 
 func TestUnmarshalContext(t *testing.T) {
+
 	type Person struct {
 		Name string `ctx:"name"`
 		Age  int    `ctx:"age"`
@@ -47,9 +48,11 @@ func TestUnmarshalContextWithMissing(t *testing.T) {
 		Name string `ctx:"name"`
 		Age  int    `ctx:"age"`
 	}
+	type name string
+	const PersonNameKey name = "name"
 
 	ctx := context.Background()
-	ctx = context.WithValue(ctx, "name", "kevin")
+	ctx = context.WithValue(ctx, PersonNameKey, "kevin")
 
 	var person Person
 	err := For(ctx, &person)

+ 3 - 1
core/contextx/valueonlycontext_test.go

@@ -9,7 +9,9 @@ import (
 )
 
 func TestContextCancel(t *testing.T) {
-	c := context.WithValue(context.Background(), "key", "value")
+	type key string
+	var nameKey key = "name"
+	c := context.WithValue(context.Background(), nameKey, "value")
 	c1, cancel := context.WithCancel(c)
 	o := ValueOnlyFrom(c1)
 	c2, cancel2 := context.WithCancel(o)

+ 1 - 0
core/logx/logs.go

@@ -197,6 +197,7 @@ func Disable() {
 	})
 }
 
+// DisableStat to disable stat logs
 func DisableStat() {
 	atomic.StoreUint32(&disableStat, 1)
 }

+ 4 - 2
core/mapping/unmarshaler.go

@@ -230,7 +230,7 @@ func (u *Unmarshaler) processFieldPrimitive(field reflect.StructField, value ref
 	default:
 		switch v := mapValue.(type) {
 		case json.Number:
-			return u.processFieldPrimitiveWithJsonNumber(field, value, v, opts, fullName)
+			return u.processFieldPrimitiveWithJSONNumber(field, value, v, opts, fullName)
 		default:
 			if typeKind == valueKind {
 				if err := validateValueInOptions(opts.options(), mapValue); err != nil {
@@ -245,7 +245,7 @@ func (u *Unmarshaler) processFieldPrimitive(field reflect.StructField, value ref
 	return newTypeMismatchError(fullName)
 }
 
-func (u *Unmarshaler) processFieldPrimitiveWithJsonNumber(field reflect.StructField, value reflect.Value,
+func (u *Unmarshaler) processFieldPrimitiveWithJSONNumber(field reflect.StructField, value reflect.Value,
 	v json.Number, opts *fieldOptionsWithContext, fullName string) error {
 	fieldType := field.Type
 	fieldKind := fieldType.Kind()
@@ -524,6 +524,7 @@ func (u *Unmarshaler) fillSliceValue(slice reflect.Value, index int, baseKind re
 			return errTypeMismatch
 		}
 
+
 		ithVal.Set(reflect.ValueOf(value))
 		return nil
 	}
@@ -626,6 +627,7 @@ func WithStringValues() UnmarshalOption {
 	}
 }
 
+// WithCanonicalKeyFunc customizes a Unmarshaler with Canonical Key func
 func WithCanonicalKeyFunc(f func(string) string) UnmarshalOption {
 	return func(opt *unmarshalOptions) {
 		opt.canonicalKey = f

+ 1 - 0
tools/goctl/model/sql/builderx/builder.go

@@ -121,6 +121,7 @@ func RawFieldNames(in interface{}, postgresSql ...bool) []string {
 	return out
 }
 
+//PostgreSqlJoin concatenate the given elements into a string
 func PostgreSqlJoin(elems []string) string {
 	b := new(strings.Builder)
 	for index, e := range elems {

+ 1 - 0
tools/goctl/util/file.go

@@ -19,6 +19,7 @@ const (
 
 var goctlHome string
 
+// RegisterGoctlHome register goctl home path
 func RegisterGoctlHome(home string) {
 	goctlHome = home
 }