Preparing report...

Report for cdr.dev/coder-doctor

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


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.


golint55%

Golint is a linter for Go source code.

    • /cdr.dev/coder-doctor/internal/humanwriter/human.go
    • Line 13: warning: exported type OutputMode should have comment or be unexported (golint)
    • Line 16: warning: comment on exported const OutputModeText should be of the form "OutputModeText ..." (golint)
    • Line 36: warning: exported type HumanResultWriter should have comment or be unexported (golint)
    • Line 42: warning: exported type Option should have comment or be unexported (golint)
    • Line 44: warning: exported function New should have comment or be unexported (golint)
    • Line 58: warning: exported function WithColors should have comment or be unexported (golint)
    • Line 64: warning: exported function WithMode should have comment or be unexported (golint)
    • Line 70: warning: exported method HumanResultWriter.WriteResult should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/checks/local/local.go
    • Line 19: warning: exported type ExecF should have comment or be unexported (golint)
    • Line 20: warning: exported type LookPathF should have comment or be unexported (golint)
    • Line 22: warning: comment on exported type Checker should be of the form "Checker ..." (with optional leading article) (golint)
    • Line 32: warning: exported type Option should have comment or be unexported (golint)
    • Line 34: warning: exported function NewChecker should have comment or be unexported (golint)
    • Line 54: warning: exported function WithTarget should have comment or be unexported (golint)
    • Line 60: warning: exported function WithWriter should have comment or be unexported (golint)
    • Line 66: warning: exported function WithCoderVersion should have comment or be unexported (golint)
    • Line 72: warning: exported function WithLogger should have comment or be unexported (golint)
    • Line 78: warning: exported function WithExecF should have comment or be unexported (golint)
    • Line 84: warning: exported function WithLookPathF should have comment or be unexported (golint)
    • Line 90: warning: exported method Checker.Validate should have comment or be unexported (golint)
    • Line 98: warning: exported method Checker.Run should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/api/writer.go
    • Line 14: warning: exported method DiscardWriter.WriteResult should have comment or be unexported (golint)
    • Line 26: warning: exported method CaptureWriter.WriteResult should have comment or be unexported (golint)
    • Line 31: warning: exported method CaptureWriter.Clear should have comment or be unexported (golint)
    • Line 35: warning: exported method CaptureWriter.Get should have comment or be unexported (golint)
    • Line 39: warning: exported method CaptureWriter.Empty should have comment or be unexported (golint)
    • Line 43: warning: exported method CaptureWriter.Len should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/filterwriter/filter.go
    • Line 9: warning: exported type FilterWriter should have comment or be unexported (golint)
    • Line 14: warning: exported type Option should have comment or be unexported (golint)
    • Line 16: warning: exported function Must should have comment or be unexported (golint)
    • Line 25: warning: exported function New should have comment or be unexported (golint)
    • Line 42: warning: exported function WithAcceptState should have comment or be unexported (golint)
    • Line 48: warning: exported function WithFilterState should have comment or be unexported (golint)
    • Line 54: warning: exported method FilterWriter.WriteResult should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/summarywriter/summary.go
    • Line 5: warning: exported type SummaryResult should have comment or be unexported (golint)
    • Line 16: warning: exported type SummaryWriter should have comment or be unexported (golint)
    • Line 21: warning: exported function New should have comment or be unexported (golint)
    • Line 27: warning: exported method SummaryWriter.WriteResult should have comment or be unexported (golint)
    • Line 46: warning: exported method SummaryWriter.Reset should have comment or be unexported (golint)
    • Line 50: warning: exported method SummaryWriter.Summary should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/api/types.go
    • Line 11: warning: exported type Checker should have comment or be unexported (golint)
    • Line 28: warning: exported type CheckState should have comment or be unexported (golint)
    • Line 50: warning: exported method CheckState.MustEmoji should have comment or be unexported (golint)
    • Line 58: warning: exported method CheckState.Emoji should have comment or be unexported (golint)
    • Line 75: warning: exported method CheckState.MustText should have comment or be unexported (golint)
    • Line 83: warning: exported method CheckState.Text should have comment or be unexported (golint)
    • Line 117: warning: exported type PrintFunc should have comment or be unexported (golint)
    • Line 121: warning: exported method CheckState.Color should have comment or be unexported (golint)
    • Line 136: warning: exported method CheckState.MustColor should have comment or be unexported (golint)
    • Line 144: warning: exported type CheckResult should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/checks/local/helm.go
    • Line 15: warning: exported const LocalHelmVersionCheck should have comment or be unexported (golint)
    • Line 17: warning: exported type VersionRequirement should have comment or be unexported (golint)
    • Line 33: warning: exported method Checker.CheckLocalHelmVersion should have comment or be unexported (golint)
    • /cdr.dev/coder-doctor/internal/checks/kube/kubernetes.go
    • Line 19: warning: exported type KubernetesChecker should have comment or be unexported (golint)
    • Line 28: warning: exported type Option should have comment or be unexported (golint)
    • Line 30: warning: exported function NewKubernetesChecker should have comment or be unexported (golint)
    • Line 53: warning: exported function WithWriter should have comment or be unexported (golint)
    • Line 59: warning: exported function WithCoderVersion should have comment or be unexported (golint)
    • Line 65: warning: exported function WithLogger should have comment or be unexported (golint)
    • Line 71: warning: exported function WithNamespace should have comment or be unexported (golint)
    • Line 77: warning: exported method KubernetesChecker.Validate should have comment or be unexported (golint)
    • Line 84: warning: exported method KubernetesChecker.Run should have comment or be unexported (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!


misspell97%

Misspell Finds commonly misspelled English words