Preparing report...

Report for github.com/PremiereGlobal/mkdocs-generator

A    Great!    Found 10 issues across 16 files

Tweet

gofmt87%

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


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!


gocyclo93%

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.


golint56%

Golint is a linter for Go source code.

    • mkdocs-generator/navList.go
    • Line 3: warning: exported type NavList should have comment or be unexported (golint)
    • Line 12: warning: should omit 2nd value from range; this loop is equivalent to `for key := range ...` (golint)
    • Line 17: warning: should omit 2nd value from range; this loop is equivalent to `for key := range ...` (golint)
    • mkdocs-generator/utils.go
    • Line 66: warning: exported function IsRegularFile should have comment or be unexported (golint)
    • Line 89: warning: exported function IsDirEmpty should have comment or be unexported (golint)
    • Line 111: warning: exported function NewTaskQueue should have comment or be unexported (golint)
    • mkdocs-generator/bitbucket/bbcloud.go
    • Line 63: warning: exported type ProjectBBCloud should have comment or be unexported (golint)
    • Line 74: warning: exported method ProjectBBCloud.GetKey should have comment or be unexported (golint)
    • Line 77: warning: exported method ProjectBBCloud.GetId should have comment or be unexported (golint)
    • Line 80: warning: exported method ProjectBBCloud.GetName should have comment or be unexported (golint)
    • Line 83: warning: exported method ProjectBBCloud.GetDescription should have comment or be unexported (golint)
    • Line 86: warning: exported method ProjectBBCloud.IsPublic should have comment or be unexported (golint)
    • Line 89: warning: exported method ProjectBBCloud.GetProjectType should have comment or be unexported (golint)
    • Line 93: warning: comment on exported method ProjectBBCloud.ListReposURL should be of the form "ListReposURL ..." (golint)
    • Line 107: warning: exported method ProjectBBCloud.GetBBClient should have comment or be unexported (golint)
    • Line 111: warning: exported method ProjectBBCloud.ListRepos should have comment or be unexported (golint)
    • Line 164: warning: exported type RepoBBCloud should have comment or be unexported (golint)
    • Line 177: warning: exported type RepoBBCloudLinks should have comment or be unexported (golint)
    • Line 181: warning: exported method RepoBBCloud.GetSlug should have comment or be unexported (golint)
    • Line 184: warning: exported method RepoBBCloud.GetId should have comment or be unexported (golint)
    • Line 187: warning: exported method RepoBBCloud.GetName should have comment or be unexported (golint)
    • Line 190: warning: exported method RepoBBCloud.GetScmId should have comment or be unexported (golint)
    • Line 193: warning: exported method RepoBBCloud.GetState should have comment or be unexported (golint)
    • Line 196: warning: exported method RepoBBCloud.GetStatusMessage should have comment or be unexported (golint)
    • Line 199: warning: exported method RepoBBCloud.GetForkable should have comment or be unexported (golint)
    • Line 202: warning: exported method RepoBBCloud.GetBBProject should have comment or be unexported (golint)
    • Line 205: warning: exported method RepoBBCloud.IsPublic should have comment or be unexported (golint)
    • Line 208: warning: exported method RepoBBCloud.GetFilesURL should have comment or be unexported (golint)
    • Line 218: warning: exported method RepoBBCloud.GetDir should have comment or be unexported (golint)
    • Line 258: warning: exported method RepoBBCloud.GetFile should have comment or be unexported (golint)
    • Line 269: warning: should replace errors.New(fmt.Sprintf(...)) with fmt.Errorf(...) (golint)
    • Line 272: warning: exported type BBCloudFileList should have comment or be unexported (golint)
    • Line 281: warning: exported type BBCloudFile should have comment or be unexported (golint)
    • Line 290: warning: exported method BBCloudFile.GetBasePath should have comment or be unexported (golint)
    • Line 293: warning: exported method BBCloudFile.GetFullPath should have comment or be unexported (golint)
    • Line 296: warning: exported method BBCloudFile.GetName should have comment or be unexported (golint)
    • Line 299: warning: exported method BBCloudFile.GetFileType should have comment or be unexported (golint)
    • Line 307: warning: exported method BBCloudFile.GetSize should have comment or be unexported (golint)
    • Line 310: warning: exported method BBCloudFile.GetBBRepo should have comment or be unexported (golint)
    • Line 313: warning: exported method BBCloudFile.GetURL should have comment or be unexported (golint)
    • Line 324: warning: exported method BBCloudFile.GetData should have comment or be unexported (golint)
    • mkdocs-generator/bitbucket/bbserver.go
    • Line 11: warning: exported type ProjectBBServerList should have comment or be unexported (golint)
    • Line 19: warning: exported method ProjectBBServerList.GetValues should have comment or be unexported (golint)
    • Line 47: warning: exported type ProjectBBServer should have comment or be unexported (golint)
    • Line 57: warning: exported method ProjectBBServer.GetKey should have comment or be unexported (golint)
    • Line 60: warning: exported method ProjectBBServer.GetId should have comment or be unexported (golint)
    • Line 63: warning: exported method ProjectBBServer.GetName should have comment or be unexported (golint)
    • Line 66: warning: exported method ProjectBBServer.GetDescription should have comment or be unexported (golint)
    • Line 69: warning: exported method ProjectBBServer.IsPublic should have comment or be unexported (golint)
    • Line 72: warning: exported method ProjectBBServer.GetProjectType should have comment or be unexported (golint)
    • Line 75: warning: exported method ProjectBBServer.ListReposURL should have comment or be unexported (golint)
    • Line 83: warning: exported method ProjectBBServer.ListRepos should have comment or be unexported (golint)
    • Line 101: warning: exported method ProjectBBServer.GetBBClient should have comment or be unexported (golint)
    • Line 105: warning: exported type RepoBBServerList should have comment or be unexported (golint)
    • Line 113: warning: exported method RepoBBServerList.GetValues should have comment or be unexported (golint)
    • Line 121: warning: exported type RepoBBServer should have comment or be unexported (golint)
    • Line 134: warning: exported method RepoBBServer.GetSlug should have comment or be unexported (golint)
    • Line 137: warning: exported method RepoBBServer.GetId should have comment or be unexported (golint)
    • Line 140: warning: exported method RepoBBServer.GetName should have comment or be unexported (golint)
    • Line 143: warning: exported method RepoBBServer.GetScmId should have comment or be unexported (golint)
    • Line 146: warning: exported method RepoBBServer.GetState should have comment or be unexported (golint)
    • Line 149: warning: exported method RepoBBServer.GetStatusMessage should have comment or be unexported (golint)
    • Line 152: warning: exported method RepoBBServer.GetForkable should have comment or be unexported (golint)
    • Line 155: warning: exported method RepoBBServer.GetBBProject should have comment or be unexported (golint)
    • Line 158: warning: exported method RepoBBServer.IsPublic should have comment or be unexported (golint)
    • Line 161: warning: exported method RepoBBServer.GetFilesURL should have comment or be unexported (golint)
    • Line 168: warning: exported method RepoBBServer.GetDir should have comment or be unexported (golint)
    • Line 190: warning: exported method RepoBBServer.GetFile should have comment or be unexported (golint)
    • Line 213: warning: should replace errors.New(fmt.Sprintf(...)) with fmt.Errorf(...) (golint)
    • Line 216: warning: exported type BBServerBrowseList should have comment or be unexported (golint)
    • Line 222: warning: exported type BBServerBrowsePaginatedList should have comment or be unexported (golint)
    • Line 230: warning: exported type BBServerFile should have comment or be unexported (golint)
    • Line 239: warning: exported type Path should have comment or be unexported (golint)
    • Line 247: warning: exported method BBServerFile.GetFullPath should have comment or be unexported (golint)
    • Line 251: warning: exported method BBServerFile.GetBasePath should have comment or be unexported (golint)
    • Line 255: warning: exported method BBServerFile.GetName should have comment or be unexported (golint)
    • Line 259: warning: exported method BBServerFile.GetContentId should have comment or be unexported (golint)
    • Line 263: warning: exported method BBServerFile.GetFileType should have comment or be unexported (golint)
    • Line 267: warning: exported method BBServerFile.GetSize should have comment or be unexported (golint)
    • Line 270: warning: exported method BBServerFile.GetBBRepo should have comment or be unexported (golint)
    • Line 274: warning: exported method BBServerFile.GetURL should have comment or be unexported (golint)
    • Line 285: warning: exported method BBServerFile.GetData should have comment or be unexported (golint)
    • mkdocs-generator/bitbucket/bbstructs.go
    • Line 5: warning: exported type BBProject should have comment or be unexported (golint)
    • Line 17: warning: exported type BBRepo should have comment or be unexported (golint)
    • Line 32: warning: exported type BBFile should have comment or be unexported (golint)
    • mkdocs-generator/bitbucket/client.go
    • Line 18: warning: exported type BitbucketClientConfig should have comment or be unexported (golint)
    • Line 45: warning: exported function NewBitbucketClient should have comment or be unexported (golint)
    • Line 121: warning: exported type WrappedLeveledLogger should have comment or be unexported (golint)
    • Line 128: warning: exported method WrappedLeveledLogger.Info should have comment or be unexported (golint)
    • Line 131: warning: exported method WrappedLeveledLogger.Debug should have comment or be unexported (golint)
    • Line 134: warning: exported method WrappedLeveledLogger.Warn should have comment or be unexported (golint)

license0%

Checks whether your project has a LICENSE file.


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!