chore: updated and relinted

fredbi · fredbi · commit b59e589e657c · 2023-12-06T15:24:38.000+01:00
* updated required go version to 1.19
* update lint config
* relinted code
* ci: updated github actions
* doc: updated README badges

Signed-off-by: Frederic BIDON &lt;fredbi@yahoo.com&gt;
diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml
@@ -1,23 +1,50 @@
-name: Go Test
+name: go test
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: stable
+          check-latest: true
+          cache: true
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: latest
+          only-new-issues: true
 
   test:
-
-    name: Test
+    name: Unit tests
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
         os: [ ubuntu-latest, macos-latest, windows-latest ]
-    steps:
+        go_version: ['oldstable', 'stable' ]
 
-    - uses: actions/setup-go@v2
+    steps:
+    - name: Run unit tests
+      uses: actions/setup-go@v4
       with:
-        go-version: 1.x
+        go-version: '${{ matrix.go_version }}'
+        check-latest: true
+        cache: true
+
+    - uses: actions/checkout@v3
 
-    - uses: actions/checkout@v2
+    - run: go test -v -race -coverprofile="coverage-${{ matrix.os }}.${{ matrix.go_version }}.out" -covermode=atomic ./...
 
-    - run: go test
+    - name: Upload coverage to codecov
+      uses: codecov/codecov-action@v3
+      with:
+        files: './coverage-${{ matrix.os }}.${{ matrix.go_version }}.out'
+        flags: '${{ matrix.go_version }}'
+        os: '${{ matrix.os }}'
+        fail_ci_if_error: false
+        verbose: true
diff --git a/.golangci.yml b/.golangci.yml
@@ -0,0 +1,61 @@
+linters-settings:
+  govet:
+    check-shadowing: true
+  golint:
+    min-confidence: 0
+  gocyclo:
+    min-complexity: 45
+  maligned:
+    suggest-new: true
+  dupl:
+    threshold: 200
+  goconst:
+    min-len: 2
+    min-occurrences: 3
+
+linters:
+  enable-all: true
+  disable:
+    - maligned
+    - unparam
+    - lll
+    - gochecknoinits
+    - gochecknoglobals
+    - funlen
+    - godox
+    - gocognit
+    - whitespace
+    - wsl
+    - wrapcheck
+    - testpackage
+    - nlreturn
+    - gomnd
+    - exhaustivestruct
+    - goerr113
+    - errorlint
+    - nestif
+    - godot
+    - gofumpt
+    - paralleltest
+    - tparallel
+    - thelper
+    - ifshort
+    - exhaustruct
+    - varnamelen
+    - gci
+    - depguard
+    - errchkjson
+    - inamedparam
+    - nonamedreturns
+    - musttag
+    - ireturn
+    - forcetypeassert
+    - cyclop
+    # deprecated linters
+    - deadcode
+    - interfacer
+    - scopelint
+    - varcheck
+    - structcheck
+    - golint
+    - nosnakecase
diff --git a/README.md b/README.md
@@ -1,6 +1,10 @@
-# gojsonpointer [![Build Status](https://travis-ci.org/go-openapi/jsonpointer.svg?branch=master)](https://travis-ci.org/go-openapi/jsonpointer) [![codecov](https://codecov.io/gh/go-openapi/jsonpointer/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/jsonpointer) [![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
+# gojsonpointer [![Build Status](https://github.com/go-openapi/jsonpointer/actions/workflows/go-test.yml/badge.svg)](https://github.com/go-openapi/jsonpointer/actions?query=workflow%3A"go+test") [![codecov](https://codecov.io/gh/go-openapi/jsonpointer/branch/master/graph/badge.svg)](https://codecov.io/gh/go-openapi/jsonpointer)
+
+[![Slack Status](https://slackin.goswagger.io/badge.svg)](https://slackin.goswagger.io)
+[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/jsonpointer/master/LICENSE)
+[![Go Reference](https://pkg.go.dev/badge/github.com/go-openapi/jsonpointer.svg)](https://pkg.go.dev/github.com/go-openapi/jsonpointer)
+[![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/jsonpointer)](https://goreportcard.com/report/github.com/go-openapi/jsonpointer)
 
-[![license](http://img.shields.io/badge/license-Apache%20v2-orange.svg)](https://raw.githubusercontent.com/go-openapi/jsonpointer/master/LICENSE) [![GoDoc](https://godoc.org/github.com/go-openapi/jsonpointer?status.svg)](http://godoc.org/github.com/go-openapi/jsonpointer)
 An implementation of JSON Pointer - Go language
 
 ## Status
diff --git a/go.mod b/go.mod
@@ -1,7 +1,5 @@
 module github.com/go-openapi/jsonpointer
 
-go 1.18
-
 require (
 	github.com/go-openapi/swag v0.22.4
 	github.com/stretchr/testify v1.8.4
@@ -15,3 +13,5 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
+
+go 1.19
diff --git a/pointer.go b/pointer.go
@@ -122,7 +122,7 @@ func getSingleImpl(node any, decodedToken string, nameProvider *swag.NameProvide
 		return r, kind, nil
 	}
 
-	switch kind {
+	switch kind { //nolint:exhaustive
 	case reflect.Struct:
 		nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)
 		if !ok {
@@ -170,7 +170,7 @@ func setSingleImpl(node, data any, decodedToken string, nameProvider *swag.NameP
 		return node.(JSONSetable).JSONSet(decodedToken, data)
 	}
 
-	switch rValue.Kind() {
+	switch rValue.Kind() { //nolint:exhaustive
 	case reflect.Struct:
 		nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)
 		if !ok {
@@ -231,8 +231,7 @@ func (p *Pointer) get(node any, nameProvider *swag.NameProvider) (any, reflect.K
 		if err != nil {
 			return nil, knd, err
 		}
-		node, kind = r, knd
-
+		node = r
 	}
 
 	rValue := reflect.ValueOf(node)
@@ -284,7 +283,7 @@ func (p *Pointer) set(node, data any, nameProvider *swag.NameProvider) error {
 			continue
 		}
 
-		switch kind {
+		switch kind { //nolint:exhaustive
 		case reflect.Struct:
 			nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)
 			if !ok {
@@ -405,11 +404,11 @@ func offsetSingleObject(dec *json.Decoder, decodedToken string) (int64, error) {
 		case json.Delim:
 			switch tk {
 			case '{':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return 0, err
 				}
 			case '[':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return 0, err
 				}
 			}
@@ -435,48 +434,49 @@ func offsetSingleArray(dec *json.Decoder, decodedToken string) (int64, error) {
 		if err != nil {
 			return 0, err
 		}
-		switch tk := tk.(type) {
-		case json.Delim:
-			switch tk {
+
+		if delim, isDelim := tk.(json.Delim); isDelim {
+			switch delim {
 			case '{':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return 0, err
 				}
 			case '[':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return 0, err
 				}
 			}
 		}
 	}
+
 	if !dec.More() {
 		return 0, fmt.Errorf("token reference %q not found", decodedToken)
 	}
 	return dec.InputOffset(), nil
 }
 
 // drainSingle drains a single level of object or array.
-// The decoder has to guarantee the begining delim (i.e. '{' or '[') has been consumed.
+// The decoder has to guarantee the beginning delim (i.e. '{' or '[') has been consumed.
 func drainSingle(dec *json.Decoder) error {
 	for dec.More() {
 		tk, err := dec.Token()
 		if err != nil {
 			return err
 		}
-		switch tk := tk.(type) {
-		case json.Delim:
-			switch tk {
+		if delim, isDelim := tk.(json.Delim); isDelim {
+			switch delim {
 			case '{':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return err
 				}
 			case '[':
-				if err := drainSingle(dec); err != nil {
+				if err = drainSingle(dec); err != nil {
 					return err
 				}
 			}
 		}
 	}
+
 	// Consumes the ending delim
 	if _, err := dec.Token(); err != nil {
 		return err
@@ -498,14 +498,14 @@ const (
 
 // Unescape unescapes a json pointer reference token string to the original representation
 func Unescape(token string) string {
-	step1 := strings.Replace(token, encRefTok1, decRefTok1, -1)
-	step2 := strings.Replace(step1, encRefTok0, decRefTok0, -1)
+	step1 := strings.ReplaceAll(token, encRefTok1, decRefTok1)
+	step2 := strings.ReplaceAll(step1, encRefTok0, decRefTok0)
 	return step2
 }
 
 // Escape escapes a pointer reference token string
 func Escape(token string) string {
-	step1 := strings.Replace(token, decRefTok0, encRefTok0, -1)
-	step2 := strings.Replace(step1, decRefTok1, encRefTok1, -1)
+	step1 := strings.ReplaceAll(token, decRefTok0, encRefTok0)
+	step2 := strings.ReplaceAll(step1, decRefTok1, encRefTok1)
 	return step2
 }
diff --git a/pointer_test.go b/pointer_test.go

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ func getSingleImpl(node any, decodedToken string, nameProvider *swag.NameProvide`
`122`	`122`	`return r, kind, nil`
`123`	`123`	`}`
`124`	`124`
`125`		`- switch kind {`
	`125`	`+ switch kind { //nolint:exhaustive`
`126`	`126`	`case reflect.Struct:`
`127`	`127`	`nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)`
`128`	`128`	`if !ok {`
`@@ -170,7 +170,7 @@ func setSingleImpl(node, data any, decodedToken string, nameProvider *swag.NameP`
`170`	`170`	`return node.(JSONSetable).JSONSet(decodedToken, data)`
`171`	`171`	`}`
`172`	`172`
`173`		`- switch rValue.Kind() {`
	`173`	`+ switch rValue.Kind() { //nolint:exhaustive`
`174`	`174`	`case reflect.Struct:`
`175`	`175`	`nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)`
`176`	`176`	`if !ok {`
`@@ -231,8 +231,7 @@ func (p Pointer) get(node any, nameProvider swag.NameProvider) (any, reflect.K`
`231`	`231`	`if err != nil {`
`232`	`232`	`return nil, knd, err`
`233`	`233`	`}`
`234`		`- node, kind = r, knd`
`235`		`-`
	`234`	`+ node = r`
`236`	`235`	`}`
`237`	`236`
`238`	`237`	`rValue := reflect.ValueOf(node)`
`@@ -284,7 +283,7 @@ func (p Pointer) set(node, data any, nameProvider swag.NameProvider) error {`
`284`	`283`	`continue`
`285`	`284`	`}`
`286`	`285`
`287`		`- switch kind {`
	`286`	`+ switch kind { //nolint:exhaustive`
`288`	`287`	`case reflect.Struct:`
`289`	`288`	`nm, ok := nameProvider.GetGoNameForType(rValue.Type(), decodedToken)`
`290`	`289`	`if !ok {`
`@@ -405,11 +404,11 @@ func offsetSingleObject(dec *json.Decoder, decodedToken string) (int64, error) {`
`405`	`404`	`case json.Delim:`
`406`	`405`	`switch tk {`
`407`	`406`	`case '{':`
`408`		`- if err := drainSingle(dec); err != nil {`
	`407`	`+ if err = drainSingle(dec); err != nil {`
`409`	`408`	`return 0, err`
`410`	`409`	`}`
`411`	`410`	`case '[':`
`412`		`- if err := drainSingle(dec); err != nil {`
	`411`	`+ if err = drainSingle(dec); err != nil {`
`413`	`412`	`return 0, err`
`414`	`413`	`}`
`415`	`414`	`}`
`@@ -435,48 +434,49 @@ func offsetSingleArray(dec *json.Decoder, decodedToken string) (int64, error) {`
`435`	`434`	`if err != nil {`
`436`	`435`	`return 0, err`
`437`	`436`	`}`
`438`		`- switch tk := tk.(type) {`
`439`		`- case json.Delim:`
`440`		`- switch tk {`
	`437`	`+`
	`438`	`+ if delim, isDelim := tk.(json.Delim); isDelim {`
	`439`	`+ switch delim {`
`441`	`440`	`case '{':`
`442`		`- if err := drainSingle(dec); err != nil {`
	`441`	`+ if err = drainSingle(dec); err != nil {`
`443`	`442`	`return 0, err`
`444`	`443`	`}`
`445`	`444`	`case '[':`
`446`		`- if err := drainSingle(dec); err != nil {`
	`445`	`+ if err = drainSingle(dec); err != nil {`
`447`	`446`	`return 0, err`
`448`	`447`	`}`
`449`	`448`	`}`
`450`	`449`	`}`
`451`	`450`	`}`
	`451`	`+`
`452`	`452`	`if !dec.More() {`
`453`	`453`	`return 0, fmt.Errorf("token reference %q not found", decodedToken)`
`454`	`454`	`}`
`455`	`455`	`return dec.InputOffset(), nil`
`456`	`456`	`}`
`457`	`457`
`458`	`458`	`// drainSingle drains a single level of object or array.`
`459`		`-// The decoder has to guarantee the begining delim (i.e. '{' or '[') has been consumed.`
	`459`	`+// The decoder has to guarantee the beginning delim (i.e. '{' or '[') has been consumed.`
`460`	`460`	`func drainSingle(dec *json.Decoder) error {`
`461`	`461`	`for dec.More() {`
`462`	`462`	`tk, err := dec.Token()`
`463`	`463`	`if err != nil {`
`464`	`464`	`return err`
`465`	`465`	`}`
`466`		`- switch tk := tk.(type) {`
`467`		`- case json.Delim:`
`468`		`- switch tk {`
	`466`	`+ if delim, isDelim := tk.(json.Delim); isDelim {`
	`467`	`+ switch delim {`
`469`	`468`	`case '{':`
`470`		`- if err := drainSingle(dec); err != nil {`
	`469`	`+ if err = drainSingle(dec); err != nil {`
`471`	`470`	`return err`
`472`	`471`	`}`
`473`	`472`	`case '[':`
`474`		`- if err := drainSingle(dec); err != nil {`
	`473`	`+ if err = drainSingle(dec); err != nil {`
`475`	`474`	`return err`
`476`	`475`	`}`
`477`	`476`	`}`
`478`	`477`	`}`
`479`	`478`	`}`
	`479`	`+`
`480`	`480`	`// Consumes the ending delim`
`481`	`481`	`if _, err := dec.Token(); err != nil {`
`482`	`482`	`return err`
`@@ -498,14 +498,14 @@ const (`
`498`	`498`
`499`	`499`	`// Unescape unescapes a json pointer reference token string to the original representation`
`500`	`500`	`func Unescape(token string) string {`
`501`		`- step1 := strings.Replace(token, encRefTok1, decRefTok1, -1)`
`502`		`- step2 := strings.Replace(step1, encRefTok0, decRefTok0, -1)`
	`501`	`+ step1 := strings.ReplaceAll(token, encRefTok1, decRefTok1)`
	`502`	`+ step2 := strings.ReplaceAll(step1, encRefTok0, decRefTok0)`
`503`	`503`	`return step2`
`504`	`504`	`}`
`505`	`505`
`506`	`506`	`// Escape escapes a pointer reference token string`
`507`	`507`	`func Escape(token string) string {`
`508`		`- step1 := strings.Replace(token, decRefTok0, encRefTok0, -1)`
`509`		`- step2 := strings.Replace(step1, decRefTok1, encRefTok1, -1)`
	`508`	`+ step1 := strings.ReplaceAll(token, decRefTok0, encRefTok0)`
	`509`	`+ step2 := strings.ReplaceAll(step1, decRefTok1, encRefTok1)`
`510`	`510`	`return step2`
`511`	`511`	`}`