Preparing report...

Report for github.com/yext/edward

A+    Excellent!    Found 52 issues across 127 files

Tweet

gofmt96%

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!


gocyclo97%

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.


golint66%

Golint is a linter for Go source code.

    • edward/services/backends/fake/loader.go
    • Line 9: warning: exported type Loader should have comment or be unexported (golint)
    • Line 12: warning: exported method Loader.New should have comment or be unexported (golint)
    • Line 16: warning: exported method Loader.Name should have comment or be unexported (golint)
    • Line 20: warning: exported method Loader.Handles should have comment or be unexported (golint)
    • Line 25: warning: exported method Loader.Builder should have comment or be unexported (golint)
    • Line 29: warning: exported method Loader.Runner should have comment or be unexported (golint)
    • edward/services/backends/docker/backend.go
    • Line 15: warning: exported type Backend should have comment or be unexported (golint)
    • Line 26: warning: exported method Backend.MarshalJSON should have comment or be unexported (golint)
    • Line 54: warning: exported method Backend.UnmarshalJSON should have comment or be unexported (golint)
    • Line 82: warning: exported method Backend.HasBuildStep should have comment or be unexported (golint)
    • Line 86: warning: exported method Backend.HasLaunchStep should have comment or be unexported (golint)
    • Line 90: warning: exported type PortMapping should have comment or be unexported (golint)
    • Line 97: warning: exported method PortMapping.MarshalJSON should have comment or be unexported (golint)
    • Line 105: warning: exported method PortMapping.UnmarshalJSON should have comment or be unexported (golint)
    • edward/edward/client.go
    • Line 19: warning: exported type Client should have comment or be unexported (golint)
    • Line 50: warning: exported type TaskFollower should have comment or be unexported (golint)
    • Line 102: warning: exported method Client.BasePath should have comment or be unexported (golint)
    • Line 106: warning: exported method Client.ServiceMap should have comment or be unexported (golint)
    • edward/output/rendering_inprogress.go
    • Line 12: warning: exported type InProgressRenderer should have comment or be unexported (golint)
    • Line 17: warning: exported function NewInProgressRenderer should have comment or be unexported (golint)
    • Line 24: warning: exported method InProgressRenderer.Render should have comment or be unexported (golint)
    • edward/services/legacy.go
    • Line 3: warning: exported type LegacyMarshaler should have comment or be unexported (golint)
    • Line 9: warning: exported function RegisterLegacyMarshaler should have comment or be unexported (golint)
    • edward/output/rendering_completion.go
    • Line 13: warning: exported type CompletionRenderer should have comment or be unexported (golint)
    • Line 19: warning: exported function NewCompletionRenderer should have comment or be unexported (golint)
    • Line 27: warning: exported method CompletionRenderer.Render should have comment or be unexported (golint)
    • edward/services/backends/docker/loader.go
    • Line 9: warning: exported type Loader should have comment or be unexported (golint)
    • Line 12: warning: exported method Loader.New should have comment or be unexported (golint)
    • Line 16: warning: exported method Loader.Name should have comment or be unexported (golint)
    • Line 20: warning: exported method Loader.Handles should have comment or be unexported (golint)
    • Line 25: warning: exported method Loader.Builder should have comment or be unexported (golint)
    • Line 29: warning: exported method Loader.Runner should have comment or be unexported (golint)
    • edward/runner/runner.go
    • Line 41: warning: exported function NewRunner should have comment or be unexported (golint)
    • Line 62: warning: exported method Runner.Run should have comment or be unexported (golint)
    • Line 106: warning: should omit values from range; this loop is equivalent to `for range ...` (golint)
    • edward/services/serviceconfig.go
    • Line 85: warning: exported method BackendConfig.UnmarshalJSON should have comment or be unexported (golint)
    • Line 110: warning: exported method BackendConfig.MarshalJSON should have comment or be unexported (golint)
    • Line 277: warning: exported method ServiceConfig.GetPid should have comment or be unexported (golint)
    • Line 289: warning: exported method ServiceConfig.GetStateBase should have comment or be unexported (golint)
    • Line 293: warning: exported method ServiceConfig.GetStatePath should have comment or be unexported (golint)
    • Line 297: warning: exported method ServiceConfig.GetPidPathLegacy should have comment or be unexported (golint)
    • edward/instance/state.go
    • Line 16: warning: exported type State should have comment or be unexported (golint)
    • Line 19: warning: exported const StateStarting should have comment (or a comment on this block) or be unexported (golint)
    • Line 26: warning: exported type Status should have comment or be unexported (golint)
    • Line 37: warning: exported function LoadStatusForService should have comment or be unexported (golint)
    • Line 69: warning: exported function SaveStatusForService should have comment or be unexported (golint)
    • Line 88: warning: exported function DeleteAllStatusesForService should have comment or be unexported (golint)
    • Line 97: warning: exported function DeleteStatusForService should have comment or be unexported (golint)
    • edward/services/backends/fake/backend.go
    • Line 9: warning: exported type Backend should have comment or be unexported (golint)
    • Line 42: warning: exported method Backend.Name should have comment or be unexported (golint)
    • Line 46: warning: exported method Backend.HasBuildStep should have comment or be unexported (golint)
    • Line 50: warning: exported method Backend.HasLaunchStep should have comment or be unexported (golint)
    • edward/instance/processes/processes.go
    • Line 14: warning: exported type Processes should have comment or be unexported (golint)
    • Line 17: warning: exported method Processes.SendSignal should have comment or be unexported (golint)
    • Line 26: warning: exported method Processes.KillGroup should have comment or be unexported (golint)
    • Line 54: warning: exported method Processes.PidExists should have comment or be unexported (golint)
    • Line 60: warning: exported method Processes.PidCommandMatches should have comment or be unexported (golint)
    • edward/output/tasks.go
    • Line 15: warning: exported type Follower should have comment or be unexported (golint)
    • Line 24: warning: exported function NewFollower should have comment or be unexported (golint)
    • Line 33: warning: exported method Follower.Reset should have comment or be unexported (golint)
    • Line 45: warning: exported method Follower.Handle should have comment or be unexported (golint)
    • Line 77: warning: exported method Follower.Done should have comment or be unexported (golint)
    • Line 85: warning: exported type NonLiveFollower should have comment or be unexported (golint)
    • Line 89: warning: exported function NewNonLiveFollower should have comment or be unexported (golint)
    • Line 96: warning: exported method NonLiveFollower.Handle should have comment or be unexported (golint)
    • Line 105: warning: exported method NonLiveFollower.Done should have comment or be unexported (golint)
    • edward/ui/ui.go
    • Line 9: warning: exported type Provider should have comment or be unexported (golint)
    • Line 22: warning: exported type ServiceStatus should have comment or be unexported (golint)
    • edward/ui/terminal/provider.go
    • Line 14: warning: exported type Provider should have comment or be unexported (golint)
    • Line 17: warning: exported method Provider.Infof should have comment or be unexported (golint)
    • Line 22: warning: exported method Provider.Errorf should have comment or be unexported (golint)
    • Line 27: warning: exported method Provider.Confirm should have comment or be unexported (golint)
    • edward/services/backends/commandline/backend.go
    • Line 12: warning: exported type Backend should have comment or be unexported (golint)
    • Line 20: warning: exported method Backend.UnmarshalJSON should have comment or be unexported (golint)
    • Line 103: warning: exported method Backend.Name should have comment or be unexported (golint)
    • Line 107: warning: exported method Backend.HasBuildStep should have comment or be unexported (golint)
    • Line 111: warning: exported method Backend.HasLaunchStep should have comment or be unexported (golint)
    • Line 115: warning: exported function GetConfigCommandLine should have comment or be unexported (golint)
    • edward/services/backends.go
    • Line 10: warning: exported type Backend should have comment or be unexported (golint)
    • Line 15: warning: exported type BackendLoader should have comment or be unexported (golint)
    • Line 23: warning: exported type Runner should have comment or be unexported (golint)
    • Line 30: warning: exported type BackendStatus should have comment or be unexported (golint)
    • Line 35: warning: exported type Builder should have comment or be unexported (golint)
    • Line 42: warning: exported function RegisterBackend should have comment or be unexported (golint)
    • Line 46: warning: exported function GetBuilder should have comment or be unexported (golint)
    • Line 60: warning: exported function GetRunner should have comment or be unexported (golint)
    • edward/instance/servicelogs/follow.go
    • Line 12: warning: exported type LogFollower should have comment or be unexported (golint)
    • Line 27: warning: exported method LogFollower.Start should have comment or be unexported (golint)
    • Line 55: warning: exported method LogFollower.Stop should have comment or be unexported (golint)
    • edward/home/home.go
    • Line 52: warning: exported method EdwardConfiguration.InitializeWithDir should have comment or be unexported (golint)
    • edward/services/duration.go
    • Line 10: warning: exported type Duration should have comment or be unexported (golint)
    • Line 14: warning: exported method Duration.MarshalJSON should have comment or be unexported (golint)
    • Line 18: warning: exported method Duration.UnmarshalJSON should have comment or be unexported (golint)
    • edward/services/backends/commandline/loader.go
    • Line 8: warning: exported type Loader should have comment or be unexported (golint)
    • Line 11: warning: exported method Loader.New should have comment or be unexported (golint)
    • Line 15: warning: exported method Loader.Name should have comment or be unexported (golint)
    • Line 19: warning: exported method Loader.Handles should have comment or be unexported (golint)
    • Line 24: warning: exported method Loader.Builder should have comment or be unexported (golint)
    • Line 28: warning: exported method Loader.Runner should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign95%

IneffAssign detects ineffectual assignments in Go code.


misspell99%

Misspell Finds commonly misspelled English words