🔨 Versions bumpup

* Upgraded golanglint-ci version and removed deprecated linters
+ Upgraded go version

Signed-off-by: kaynetik <aleksandar@nesovic.dev>

Author: kaynetik

.github/workflows/golangci.yml

@@ -10,4 +10,4 @@ jobs:
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v2
         with:
-          version: v1.36
+          version: v1.49

.golangci.yml

@@ -8,12 +8,8 @@ linters-settings:
       - style
   goimports:
     local-prefixes: github.com/golangci/golangci-lint
-  golint:
-    min-confidence: 0
   govet:
     check-shadowing: true
-  maligned:
-    suggest-new: true
   misspell:
     locale: US
   nakedret:
@@ -25,7 +21,6 @@ linters:
   disable-all: true
   enable:
     - bodyclose
-    - deadcode
     - depguard
     - dogsled
     - dupl
@@ -40,30 +35,25 @@ linters:
     - godot
     - gofmt
     - goimports
-    - golint
     - gomnd
     - gomodguard
     - goprintffuncname
     - gosec
     - gosimple
     - govet
     - ineffassign
-    - interfacer
     - lll
-    - maligned
     - misspell
     - nakedret
     - nestif
     - prealloc
     - rowserrcheck
     - staticcheck
-    - structcheck
     - stylecheck
     - typecheck
     - unconvert
     - unparam
     - unused
-    - varcheck
     - whitespace
     - wsl
     - asciicheck

Makefile

@@ -1,6 +1,5 @@
 lint:
 	gofumpt -w -s ./..
-	golint ./...
 	golangci-lint run --fix
 
 test:

annotations.go

@@ -26,14 +26,14 @@ type (
 // MapAnnotationsInPath scanIn is relevant from initiator calling it.
 //
 // It accepts the path in which to scan for annotations within Go files.
-func (o *OAS) MapAnnotationsInPath(scanIn string, conf ...configAnnotation) error {
+func (oas *OAS) MapAnnotationsInPath(scanIn string, conf ...configAnnotation) error {
 	filesInPath, err := scanForChangesInPath(scanIn, getWDFn(conf), walkFilepath)
 	if err != nil {
 		return fmt.Errorf(" :%w", err)
 	}
 
 	for _, file := range filesInPath {
-		err = o.mapDocAnnotations(file)
+		err = oas.mapDocAnnotations(file)
 		if err != nil {
 			return fmt.Errorf(" :%w", err)
 		}
@@ -103,8 +103,8 @@ func walkFilepath(pathToTraverse string, walker walkerFn) ([]string, error) {
 	return files, nil
 }
 
-func (o *OAS) mapDocAnnotations(path string) error {
-	if o == nil {
+func (oas *OAS) mapDocAnnotations(path string) error {
+	if oas == nil {
 		return errors.New("pointer to OASHandlers can not be nil")
 	}
 
@@ -119,7 +119,7 @@ func (o *OAS) mapDocAnnotations(path string) error {
 	line := 1
 
 	for scanner.Scan() {
-		mapIfLineContainsOASTag(scanner.Text(), o)
+		mapIfLineContainsOASTag(scanner.Text(), oas)
 		line++
 	}
 

build.go

@@ -35,10 +35,10 @@ func getPathFromFirstElement(cbs []ConfigBuilder) string {
 // BuildDocs marshals the OAS struct to YAML and saves it to the chosen output file.
 //
 // Returns an error if there is any.
-func (o *OAS) BuildDocs(conf ...ConfigBuilder) error {
-	o.initCallStackForRoutes()
+func (oas *OAS) BuildDocs(conf ...ConfigBuilder) error {
+	oas.initCallStackForRoutes()
 
-	yml, err := o.marshalToYAML()
+	yml, err := oas.marshalToYAML()
 	if err != nil {
 		return fmt.Errorf("marshaling issue occurred: %w", err)
 	}
@@ -54,8 +54,8 @@ func (o *OAS) BuildDocs(conf ...ConfigBuilder) error {
 // BuildStream marshals the OAS struct to YAML and writes it to a stream.
 //
 // Returns an error if there is any.
-func (o *OAS) BuildStream(w io.Writer) error {
-	yml, err := o.marshalToYAML()
+func (oas *OAS) BuildStream(w io.Writer) error {
+	yml, err := oas.marshalToYAML()
 	if err != nil {
 		return fmt.Errorf("marshaling issue occurred: %w", err)
 	}
@@ -127,17 +127,17 @@ type hybridOAS struct {
 	Components   componentsMap `yaml:"components"`
 }
 
-func (o *OAS) transformToHybridOAS() hybridOAS {
+func (oas *OAS) transformToHybridOAS() hybridOAS {
 	ho := hybridOAS{}
 
-	ho.OpenAPI = o.OASVersion
-	ho.Info = o.Info
-	ho.ExternalDocs = o.ExternalDocs
-	ho.Servers = o.Servers
-	ho.Tags = o.Tags
+	ho.OpenAPI = oas.OASVersion
+	ho.Info = oas.Info
+	ho.ExternalDocs = oas.ExternalDocs
+	ho.Servers = oas.Servers
+	ho.Tags = oas.Tags
 
-	ho.Paths = makeAllPathsMap(&o.Paths)
-	ho.Components = makeComponentsMap(&o.Components)
+	ho.Paths = makeAllPathsMap(&oas.Paths)
+	ho.Components = makeComponentsMap(&oas.Components)
 
 	return ho
 }

caller.go

@@ -8,8 +8,8 @@ import (
 const routePostfix = "Route"
 
 // Call is used init registered functions that already exist in the *OAS, and return results if there are any.
-func (o *OAS) Call(name string, params ...interface{}) (result []reflect.Value) {
-	f := reflect.ValueOf(o.RegisteredRoutes[name])
+func (oas *OAS) Call(name string, params ...interface{}) (result []reflect.Value) {
+	f := reflect.ValueOf(oas.RegisteredRoutes[name])
 
 	in := make([]reflect.Value, len(params))
 	for k, param := range params {
@@ -21,8 +21,8 @@ func (o *OAS) Call(name string, params ...interface{}) (result []reflect.Value)
 	return result
 }
 
-func (o *OAS) initCallStackForRoutes() {
-	for oasPathIndex := range o.Paths {
-		o.Call(o.Paths[oasPathIndex].HandlerFuncName+routePostfix, oasPathIndex, o)
+func (oas *OAS) initCallStackForRoutes() {
+	for oasPathIndex := range oas.Paths {
+		oas.Call(oas.Paths[oasPathIndex].HandlerFuncName+routePostfix, oasPathIndex, oas)
 	}
 }

go.mod

@@ -1,9 +1,10 @@
 module github.com/go-oas/docs
 
-go 1.15
+go 1.18
+
+require gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 
 require (
 	github.com/kr/pretty v0.1.0 // indirect
 	gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b
 )

routing.go

@@ -19,28 +19,27 @@ type (
 // AttachRoutes if used for attaching pre-defined API documentation routes.
 //
 // fns param is a slice of functions that satisfy RouteFn signature.
-func (o *OAS) AttachRoutes(fns []RouteFn) {
+func (oas *OAS) AttachRoutes(fns []RouteFn) {
 	for _, fn := range fns {
 		fnDeclaration := runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name()
 		fields := strings.SplitAfter(fnDeclaration, ".")
 		fnName := fields[len(fields)-1]
 
-		o.RegisteredRoutes[fnName] = fn
+		oas.RegisteredRoutes[fnName] = fn
 	}
 }
 
 // GetRegisteredRoutes returns a map of registered RouteFn functions - in layman terms "routes".
-func (o *OAS) GetRegisteredRoutes() RegRoutes {
-	return o.RegisteredRoutes
+func (oas *OAS) GetRegisteredRoutes() RegRoutes {
+	return oas.RegisteredRoutes
 }
 
 // GetPathByIndex returns ptr to Path structure, by its index in the parent struct of OAS.
-func (o *OAS) GetPathByIndex(index int) *Path {
-	return &o.Paths[index]
+func (oas *OAS) GetPathByIndex(index int) *Path {
+	return &oas.Paths[index]
 }
 
 // AddRoute is used for add API documentation routes.
-//
-func (o *OAS) AddRoute(path Path) {
-	o.Paths = append(o.Paths, path)
+func (oas *OAS) AddRoute(path Path) {
+	oas.Paths = append(oas.Paths, path)
 }

routing_test.go

@@ -270,7 +270,6 @@ func TestQuickUnitAttachRoutes(t *testing.T) {
 }
 
 func TestOAS_AddRoute(t *testing.T) {
-
 	var (
 		respose200         = Response{Code: 200, Description: "Ok"}
 		respose404         = Response{Code: 404, Description: "Not Found"}

server.go

@@ -21,7 +21,8 @@ const (
 )
 
 // ConfigSwaggerUI represents a structure which will be used to pass required configuration params to
-//		the ServeSwaggerUI func.
+//
+//	the ServeSwaggerUI func.
 type ConfigSwaggerUI struct {
 	Route string
 	Port  string

setters.go

@@ -1,13 +1,13 @@
 package docs
 
 // SetOASVersion sets the OAS version, by casting string to OASVersion type.
-func (o *OAS) SetOASVersion(ver string) {
-	o.OASVersion = OASVersion(ver)
+func (oas *OAS) SetOASVersion(ver string) {
+	oas.OASVersion = OASVersion(ver)
 }
 
 // GetInfo returns pointer to the Info struct.
-func (o *OAS) GetInfo() *Info {
-	return &o.Info
+func (oas *OAS) GetInfo() *Info {
+	return &oas.Info
 }
 
 // SetContact setts the contact on the Info struct.