Preparing report...

Report for github.com/typesense/typesense-go

A+    Excellent!    Found 12 issues across 65 files

Tweet

gofmt100%

Gofmt formats Go programs. We run gofmt -s on your code, where -s is for the "simplify" command

No problems detected. Good job!


go_vet100%

go vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.

No problems detected. Good job!


gocyclo98%

Gocyclo calculates cyclomatic complexities of functions in Go source code. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 15.


golint83%

Golint is a linter for Go source code.

    • typesense-go/typesense/api/circuit/http_client.go
    • Line 11: warning: exported type HTTPRequestDoer should have comment or be unexported (golint)
    • Line 20: warning: exported type HTTPClient should have comment or be unexported (golint)
    • Line 28: warning: exported type ClientOption should have comment or be unexported (golint)
    • Line 30: warning: exported function WithHTTPRequestDoer should have comment or be unexported (golint)
    • Line 36: warning: exported function WithCircuitBreaker should have comment or be unexported (golint)
    • Line 42: warning: exported function NewHTTPClient should have comment or be unexported (golint)
    • Line 50: warning: exported method HTTPClient.Do should have comment or be unexported (golint)
    • typesense-go/typesense/client.go
    • Line 14: warning: exported type APIClientInterface should have comment or be unexported (golint)
    • Line 19: warning: exported type Client should have comment or be unexported (golint)
    • Line 26: warning: exported method Client.Collections should have comment or be unexported (golint)
    • Line 30: warning: exported method Client.Collection should have comment or be unexported (golint)
    • Line 34: warning: exported method Client.Aliases should have comment or be unexported (golint)
    • Line 38: warning: exported method Client.Alias should have comment or be unexported (golint)
    • Line 42: warning: exported method Client.Keys should have comment or be unexported (golint)
    • Line 46: warning: exported method Client.Key should have comment or be unexported (golint)
    • Line 50: warning: exported method Client.Operations should have comment or be unexported (golint)
    • Line 54: warning: exported type HTTPError should have comment or be unexported (golint)
    • Line 68: warning: exported type ClientConfig should have comment or be unexported (golint)
    • Line 80: warning: exported type ClientOption should have comment or be unexported (golint)
    • Line 183: warning: exported function NewClient should have comment or be unexported (golint)
    • typesense-go/typesense/api/pointer/pointer.go
    • Line 3: warning: exported function True should have comment or be unexported (golint)
    • Line 8: warning: exported function False should have comment or be unexported (golint)
    • Line 13: warning: exported function Int should have comment or be unexported (golint)
    • Line 17: warning: exported function Interface should have comment or be unexported (golint)
    • Line 21: warning: exported function String should have comment or be unexported (golint)
    • typesense-go/typesense/api/circuit/gobreaker.go
    • Line 9: warning: exported type GoBreaker should have comment or be unexported (golint)
    • Line 17: warning: exported type GoBreakerOption should have comment or be unexported (golint)
    • Line 57: warning: exported type GoBreakerReadyToTripFunc should have comment or be unexported (golint)
    • Line 70: warning: exported type GoBreakerOnStateChangeFunc should have comment or be unexported (golint)
    • Line 80: warning: exported function DefaultReadyToTrip should have comment or be unexported (golint)
    • Line 86: warning: exported const DefaultGoBreakerName should have comment (or a comment on this block) or be unexported (golint)
    • Line 92: warning: exported function NewGoBreaker should have comment or be unexported (golint)
    • Line 109: warning: exported method GoBreaker.Execute should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign100%

IneffAssign detects ineffectual assignments in Go code.

No problems detected. Good job!


misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!