Preparing report...

Report for github.com/Financial-Times/draft-annotations-api

A+    Excellent!    Found 8 issues across 19 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!


gocyclo94%

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.


golint57%

Golint is a linter for Go source code.

    • draft-annotations-api/concept/read_api.go
    • Line 15: warning: exported type ReadAPI should have comment or be unexported (golint)
    • Line 28: warning: exported function NewReadAPI should have comment or be unexported (golint)
    • Line 37: warning: exported var ErrUnexpectedResponse should have comment or be unexported (golint)
    • draft-annotations-api/annotations/annotations_rw.go
    • Line 17: warning: exported const DocumentHashHeader should have comment or be unexported (golint)
    • Line 18: warning: exported const PreviousDocumentHashHeader should have comment or be unexported (golint)
    • Line 20: warning: exported type RW should have comment or be unexported (golint)
    • Line 32: warning: exported function NewRW should have comment or be unexported (golint)
    • Line 36: warning: exported var ErrUnexpectedStatusRead should have comment or be unexported (golint)
    • Line 37: warning: exported var ErrUnexpectedStatusWrite should have comment or be unexported (golint)
    • Line 38: warning: exported var ErrGTGNotOK should have comment or be unexported (golint)
    • draft-annotations-api/annotations/augmenter.go
    • Line 13: warning: exported type Augmenter should have comment or be unexported (golint)
    • Line 17: warning: exported function NewAugmenter should have comment or be unexported (golint)
    • Line 21: warning: exported method Augmenter.AugmentAnnotations should have comment or be unexported (golint)
    • draft-annotations-api/annotations/canonicalizer.go
    • Line 12: warning: exported type Canonicalizer should have comment or be unexported (golint)
    • Line 20: warning: exported function NewCanonicalizer should have comment or be unexported (golint)
    • Line 24: warning: exported method Canonicalizer.Canonicalize should have comment or be unexported (golint)
    • Line 49: warning: exported function NewCanonicalAnnotationSorter should have comment or be unexported (golint)
    • draft-annotations-api/mapper/mapper.go
    • Line 13: warning: exported const PredicateIsClassifiedBy should have comment (or a comment on this block) or be unexported (golint)
    • Line 33: warning: exported function ConvertPredicates should have comment or be unexported (golint)
    • Line 123: warning: exported function IsValidPACPredicate should have comment or be unexported (golint)
    • Line 142: warning: exported function TransformConceptID should have comment or be unexported (golint)
    • draft-annotations-api/health/healthcheck.go
    • Line 18: warning: exported type HealthService should have comment or be unexported (golint)
    • Line 25: warning: exported function NewHealthService should have comment or be unexported (golint)
    • Line 43: warning: exported method HealthService.HealthCheckHandleFunc should have comment or be unexported (golint)
    • Line 104: warning: exported method HealthService.GTG 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!