Preparing report...

Report for github.com/rydesun/awesome-github

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


gocyclo100%

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.

No problems detected. Good job!


golint33%

Golint is a linter for Go source code.

    • awesome-github/test/fake-github/data.go
    • Line 14: warning: exported type DataHolder should have comment or be unexported (golint)
    • Line 18: warning: exported function NewDataHolder should have comment or be unexported (golint)
    • Line 24: warning: exported method DataHolder.GetUser should have comment or be unexported (golint)
    • Line 29: warning: exported method DataHolder.GetHtmlAwesomeReadme should have comment or be unexported (golint)
    • Line 34: warning: exported method DataHolder.GetJsonRepo should have comment or be unexported (golint)
    • Line 39: warning: exported method DataHolder.GetOutput should have comment or be unexported (golint)
    • awesome-github/web/app/route.go
    • Line 19: warning: exported type Router should have comment or be unexported (golint)
    • Line 28: warning: exported function NewRouter should have comment or be unexported (golint)
    • Line 37: warning: exported method Router.Init should have comment or be unexported (golint)
    • Line 48: warning: exported method Router.Route should have comment or be unexported (golint)
    • Line 67: warning: exported function FetchHTMLReadme should have comment or be unexported (golint)
    • Line 77: warning: don't use underscores in Go names; func parameter data_url should be dataURL (golint)
    • Line 77: warning: don't use underscores in Go names; func parameter script_url should be scriptURL (golint)
    • awesome-github/lib/cohttp/lib.go
    • Line 12: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • Line 17: warning: exported function IsNetowrkError should have comment or be unexported (golint)
    • awesome-github/awg/client.go
    • Line 12: warning: exported type Client should have comment or be unexported (golint)
    • Line 16: warning: comment on exported function NewClient should be of the form "NewClient ..." (golint)
    • Line 23: warning: exported method Client.GetUser should have comment or be unexported (golint)
    • Line 38: warning: comment on exported method Client.GetHTMLReadme should be of the form "GetHTMLReadme ..." (golint)
    • awesome-github/lib/errcode/errcode.go
    • Line 9: warning: exported type Error should have comment or be unexported (golint)
    • Line 22: warning: exported function New should have comment or be unexported (golint)
    • Line 37: warning: exported function Wrap should have comment or be unexported (golint)
    • awesome-github/cmd/awg/view.go
    • Line 12: warning: exported type Output should have comment or be unexported (golint)
    • Line 19: warning: exported function LoadOutputFile should have comment or be unexported (golint)
    • Line 29: warning: exported method Output.IsValid should have comment or be unexported (golint)
    • awesome-github/lib/cohttp/http.go
    • Line 14: warning: exported type Reporter should have comment or be unexported (golint)
    • Line 18: warning: exported type Client should have comment or be unexported (golint)
    • Line 28: warning: exported function NewClient should have comment or be unexported (golint)
    • Line 49: warning: exported method Client.Do should have comment or be unexported (golint)
    • Line 95: warning: exported method Client.DoBetter should have comment or be unexported (golint)
    • Line 155: warning: exported method Client.Text should have comment or be unexported (golint)
    • Line 183: warning: exported method Client.Json should have comment or be unexported (golint)
    • awesome-github/awg/parser.go
    • Line 20: warning: exported type Parser should have comment or be unexported (golint)
    • Line 31: warning: exported function NewParser should have comment or be unexported (golint)
    • Line 84: warning: comment on exported method Parser.Parse should be of the form "Parse ..." (golint)
    • Line 140: warning: comment on exported method Parser.FetchRepos should be of the form "FetchRepos ..." (golint)
    • awesome-github/awg/reporter.go
    • Line 10: warning: exported type Reporter should have comment or be unexported (golint)
    • Line 19: warning: exported method Reporter.ConReqNum should have comment or be unexported (golint)
    • Line 23: warning: exported method Reporter.GetConReqNum should have comment or be unexported (golint)
    • Line 27: warning: exported method Reporter.TotalRepoNum should have comment or be unexported (golint)
    • Line 31: warning: exported method Reporter.GetTotalRepoNum should have comment or be unexported (golint)
    • Line 35: warning: exported method Reporter.Done should have comment or be unexported (golint)
    • Line 39: warning: exported method Reporter.GetFinishedRepoNum should have comment or be unexported (golint)
    • Line 43: warning: exported method Reporter.RepoWaiting should have comment or be unexported (golint)
    • Line 47: warning: exported method Reporter.GetWaitingRepo should have comment or be unexported (golint)
    • Line 51: warning: exported method Reporter.InvalidRepo should have comment or be unexported (golint)
    • Line 57: warning: exported method Reporter.GetInvalidRepo should have comment or be unexported (golint)
    • awesome-github/lib/errcode/const.go
    • Line 3: warning: exported type ErrScope should have comment or be unexported (golint)
    • Line 6: warning: exported const ScopeUnknown should have comment (or a comment on this block) or be unexported (golint)
    • Line 10: warning: exported type ErrCode should have comment or be unexported (golint)
    • Line 13: warning: exported const CodeUnknown should have comment (or a comment on this block) or be unexported (golint)
    • awesome-github/exch/config/yaml.go
    • Line 13: warning: exported type YAMLParser should have comment or be unexported (golint)
    • Line 17: warning: exported function NewYAMLParser should have comment or be unexported (golint)
    • Line 35: warning: exported method YAMLParser.Parse should have comment or be unexported (golint)
    • awesome-github/exch/github/client.go
    • Line 17: warning: exported type HTTPClient should have comment or be unexported (golint)
    • Line 22: warning: exported type ClientOption should have comment or be unexported (golint)
    • Line 30: warning: exported type Client should have comment or be unexported (golint)
    • Line 39: warning: exported function NewClient should have comment or be unexported (golint)
    • Line 74: warning: comment on exported method Client.GetUser should be of the form "GetUser ..." (golint)
    • Line 118: warning: comment on exported method Client.GetRepo should be of the form "GetRepo ..." (golint)
    • Line 163: warning: comment on exported method Client.GetHTMLReadme should be of the form "GetHTMLReadme ..." (golint)
    • Line 183: warning: comment on exported method Client.GetHTML should be of the form "GetHTML ..." (golint)
    • Line 219: warning: exported function IsAbuseError should have comment or be unexported (golint)
    • awesome-github/exch/github/const.go
    • Line 4: warning: exported const ErrScope should have comment (or a comment on this block) or be unexported (golint)
    • Line 14: warning: exported const HTMLHost should have comment (or a comment on this block) or be unexported (golint)
    • Line 20: warning: exported function NewDefaultClientOption should have comment or be unexported (golint)
    • Line 29: warning: exported const QueryRepo should have comment or be unexported (golint)
    • Line 31: warning: exported const QueryUser should have comment or be unexported (golint)
    • awesome-github/cmd/awg/worker.go
    • Line 22: warning: exported type Worker should have comment or be unexported (golint)
    • Line 34: warning: exported function NewWorker should have comment or be unexported (golint)
    • Line 41: warning: exported method Worker.Init should have comment or be unexported (golint)
    • Line 68: warning: exported method Worker.Work should have comment or be unexported (golint)
    • awesome-github/exch/github/model.go
    • Line 8: warning: exported type RepoID should have comment or be unexported (golint)
    • Line 17: warning: exported type Repo should have comment or be unexported (golint)
    • Line 48: warning: exported type User should have comment or be unexported (golint)
    • awesome-github/awg/view.go
    • Line 10: warning: exported type Repo should have comment or be unexported (golint)
    • Line 22: warning: exported type AwesomeRepo should have comment or be unexported (golint)
    • Line 27: warning: exported method Repo.Aggregate should have comment or be unexported (golint)
    • Line 42: warning: exported type RateLimit should have comment or be unexported (golint)
    • Line 48: warning: exported type User should have comment or be unexported (golint)
    • awesome-github/exch/config/model.go
    • Line 13: warning: exported type Config should have comment or be unexported (golint)
    • Line 26: warning: exported type StartPoint should have comment or be unexported (golint)
    • Line 32: warning: exported type Net should have comment or be unexported (golint)
    • Line 37: warning: exported type Output should have comment or be unexported (golint)
    • Line 41: warning: exported function NewProtectedConfig should have comment or be unexported (golint)
    • Line 46: warning: exported type Github should have comment or be unexported (golint)
    • Line 51: warning: exported type Cli should have comment or be unexported (golint)
    • Line 55: warning: exported type Loggers should have comment or be unexported (golint)
    • Line 60: warning: exported type Logger should have comment or be unexported (golint)
    • Line 66: warning: exported method Config.Validate should have comment or be unexported (golint)
    • Line 91: warning: exported function SplitID should have comment or be unexported (golint)
    • awesome-github/exch/config/parser.go
    • Line 13: warning: exported type ConfigParser should have comment or be unexported (golint)
    • Line 17: warning: exported function GetConfig should have comment or be unexported (golint)
    • Line 56: warning: comment on exported function CheckFileWritable should be of the form "CheckFileWritable ..." (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!