Go Report Card

Preparing report...

Report for github.com/JesusIslam/tldr

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

golint57%

Golint is a linter for Go source code.

    • tldr/tldr.go
    • Line 1: warning: package comment should be of the form "Package tldr ..." (golint)
    • Line 18: warning: exported type Bag should have comment or be unexported (golint)
    • Line 81: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 91: warning: comment on exported method Bag.SetDictionary should be of the form "SetDictionary ..." (golint)
    • Line 93: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 97: warning: exported method Bag.SetCustomAlgorithm should have comment or be unexported (golint)
    • Line 97: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 101: warning: exported method Bag.SetCustomWeighing should have comment or be unexported (golint)
    • Line 101: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 105: warning: exported method Bag.SetWordTokenizer should have comment or be unexported (golint)
    • Line 105: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 110: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 161: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 189: warning: exported type Rank should have comment or be unexported (golint)
    • Line 194: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 222: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 251: warning: exported type Edge should have comment or be unexported (golint)
    • Line 257: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 283: warning: exported type Node should have comment or be unexported (golint)
    • Line 299: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 322: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • Line 342: warning: receiver name bag should be consistent with previous receiver name b for Bag (golint)
    • tldr/util.go
    • Line 16: warning: exported function TokenizeSentences should have comment or be unexported (golint)
    • Line 36: warning: comment on exported function Distance should be of the form "Distance ..." (golint)
    • Line 137: warning: exported function SymmetricDifference should have comment or be unexported (golint)
    • Line 147: warning: exported function Intersection should have comment or be unexported (golint)
    • Line 164: warning: exported function UniqSentences should have comment or be unexported (golint)
    • Line 209: warning: exported function SanitizeWord should have comment or be unexported (golint)
    • tldr/sort.go
    • Line 3: warning: exported type ByWeight should have comment or be unexported (golint)
    • Line 17: warning: exported type ByScore should have comment or be unexported (golint)
    • Line 31: warning: exported function ReverseEdge should have comment or be unexported (golint)
    • Line 37: warning: exported function ReverseRank should have comment or be unexported (golint)

gocyclo85%

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.

    • tldr/util.go
    • Line 40: warning: cyclomatic complexity 25 of function Distance() is high (> 15) (gocyclo)

ineffassign85%

IneffAssign detects ineffectual assignments in Go code.

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!

misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!