Go Report Card

Preparing report...

Report for github.com/spatialcurrent/go-reader-writer

A+    Excellent!    Found 53 issues across 153 files

Tweet
Last refresh:

Refresh now

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!

gocyclo99%

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.

golint67%

Golint is a linter for Go source code.

    • go-reader-writer/pkg/grw/Metadata.go
    • Line 16: warning: exported type Metadata should have comment or be unexported (golint)
    • Line 23: warning: exported function NewMetadataFromHeader should have comment or be unexported (golint)
    • Line 33: warning: exported function NewMetadataFromS3 should have comment or be unexported (golint)
    • go-reader-writer/plugins/grw/main.go
    • Line 31: warning: comment on exported function Version should be of the form "Version ..." (golint)
    • Line 43: warning: comment on exported function Algorithms should be of the form "Algorithms ..." (golint)
    • Line 48: warning: comment on exported function Schemes should be of the form "Schemes ..." (golint)
    • Line 53: warning: comment on exported function ReadString should be of the form "ReadString ..." (golint)
    • Line 74: warning: comment on exported function WriteString should be of the form "WriteString ..." (golint)
    • go-reader-writer/pkg/compress/flate/Writer.go
    • Line 18: warning: exported const NoCompression should have comment (or a comment on this block) or be unexported (golint)
    • Line 25: warning: exported type Writer should have comment or be unexported (golint)
    • Line 34: warning: comment on exported method Writer.Close should be of the form "Close ..." (golint)
    • go-reader-writer/pkg/grw/Builder.go
    • Line 19: warning: exported type Builder should have comment or be unexported (golint)
    • Line 27: warning: exported function NewBuilder should have comment or be unexported (golint)
    • Line 37: warning: exported method Builder.Uri should have comment or be unexported (golint)
    • Line 47: warning: exported method Builder.Algorithm should have comment or be unexported (golint)
    • Line 57: warning: exported method Builder.Dictionary should have comment or be unexported (golint)
    • Line 67: warning: exported method Builder.BufferSize should have comment or be unexported (golint)
    • Line 77: warning: exported method Builder.S3Client should have comment or be unexported (golint)
    • go-reader-writer/pkg/grw/Writer.go
    • Line 25: warning: exported function NewWriter should have comment or be unexported (golint)
    • Line 99: warning: comment on exported method Writer.WriteErrorSafe should be of the form "WriteErrorSafe ..." (golint)
    • go-reader-writer/pkg/cache/Cache.go
    • Line 19: warning: exported type Cache should have comment or be unexported (golint)
    • Line 26: warning: exported function NewCache should have comment or be unexported (golint)
    • Line 37: warning: exported function NewCacheWithContent should have comment or be unexported (golint)
    • Line 47: warning: exported method Cache.ReadByte should have comment or be unexported (golint)
    • Line 81: warning: exported method Cache.ReadBytes should have comment or be unexported (golint)
    • Line 99: warning: exported method Cache.ReadString should have comment or be unexported (golint)
    • Line 153: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • Line 214: warning: exported method Cache.Close should have comment or be unexported (golint)
    • Line 218: warning: exported method Cache.ReadAllAndClose should have comment or be unexported (golint)
    • go-reader-writer/pkg/grw/grw.go
    • Line 62: warning: exported const AlgorithmBzip2 should have comment (or a comment on this block) or be unexported (golint)
    • Line 78: warning: exported var Algorithms should have comment or be unexported (golint)
    • Line 90: warning: exported var Schemes should have comment or be unexported (golint)
    • Line 100: warning: exported var ErrPathMissing should have comment or be unexported (golint)
    • Line 104: warning: exported var DefaultBufferSize should have comment or be unexported (golint)
    • Line 108: warning: exported var NoDict should have comment or be unexported (golint)
    • go-reader-writer/pkg/os/os.go
    • Line 18: warning: comment on exported const O_RDONLY should be of the form "O_RDONLY ..." (golint)
    • Line 20: warning: exported const O_WRONLY should have comment (or a comment on this block) or be unexported (golint)
    • Line 22: warning: comment on exported const O_APPEND should be of the form "O_APPEND ..." (golint)
    • Line 31: warning: exported var ErrPathMissing should have comment or be unexported (golint)
    • Line 35: warning: exported var Stdin should have comment or be unexported (golint)
    • go-reader-writer/pkg/grwjs/Reader.go
    • Line 14: warning: exported type Reader should have comment or be unexported (golint)
    • Line 26: warning: exported method Reader.ReadByte should have comment or be unexported (golint)
    • Line 34: warning: exported method Reader.ReadAt should have comment or be unexported (golint)
    • Line 42: warning: exported method Reader.ReadAll should have comment or be unexported (golint)
    • Line 50: warning: exported method Reader.Close should have comment or be unexported (golint)
    • Line 57: warning: exported method Reader.ReadAllAndClose should have comment or be unexported (golint)
    • go-reader-writer/pkg/compress/zlib/Writer.go
    • Line 19: warning: exported const NoCompression should have comment (or a comment on this block) or be unexported (golint)
    • Line 26: warning: exported type Writer should have comment or be unexported (golint)
    • Line 35: warning: comment on exported method Writer.Close should be of the form "Close ..." (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!

misspell98%

Misspell Finds commonly misspelled English words