Merge branch 'main' into fix-lint-and-test

Author: padiazg

.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

.gitignore

@@ -3,4 +3,5 @@
 #internal/dist/openapi.yaml
 testing_out.yaml
 ./testing_out.yaml
-internal/dist/openapi.yaml
+internal/dist/openapi.yaml
+.vscode

.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:

README.md

@@ -119,7 +119,9 @@ other parts of the system for that matter.
 To run examples, and checkout hosted documentation via Swagger UI, issue the following command:
 
 ```sh
-$ go run ./examples/*.go
+$ go run ./examples/file_output/*.go
+# or uncomment line 40 and comment line 38 in internal/dist/index.html before running:
+$ go run ./examples/stream_output/*.go
 ```
 
 And navigate to `http://localhost:3005/docs/api/` in case that you didn't change anything before running the example

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

@@ -64,7 +64,6 @@ func (oas *OAS) BuildStream(w io.Writer) error {
 	if err != nil {
 		return fmt.Errorf("writing issue occurred: %w", err)
 	}
-
 	return nil
 }
 

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)
 	}
 }