Go Report Card

Preparing report...

Report for github.com/bwplotka/mdox

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

gocyclo82%

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.

    • mdox/pkg/transform/transform.go
    • Line 190: warning: cyclomatic complexity 18 of function (*relLinkTransformer).TransformDestination() is high (> 15) (gocyclo)
    • Line 25: warning: cyclomatic complexity 16 of function Dir() is high (> 15) (gocyclo)

golint58%

Golint is a linter for Go source code.

    • mdox/pkg/gitdiff/print.go
    • Line 17: warning: exported type Diff should have comment or be unexported (golint)
    • Line 26: warning: exported function CompareBytes should have comment or be unexported (golint)
    • Line 30: warning: exported function Compare should have comment or be unexported (golint)
    • Line 39: warning: comment on exported function DiffLines should be of the form "DiffLines ..." (golint)
    • mdox/pkg/extkingpin/app.go
    • Line 4: warning: package comment should be of the form "Package extkingpin ..." (golint)
    • Line 20: warning: exported type FlagClause should have comment or be unexported (golint)
    • Line 24: warning: exported type ArgClause should have comment or be unexported (golint)
    • Line 28: warning: exported type Run should have comment or be unexported (golint)
    • Line 30: warning: exported type AppClause should have comment or be unexported (golint)
    • Line 55: warning: exported method App.Parse should have comment or be unexported (golint)
    • Line 65: warning: exported method App.Command should have comment or be unexported (golint)
    • mdox/pkg/transform/config.go
    • Line 19: warning: exported type LinksStyle should have comment or be unexported (golint)
    • Line 22: warning: exported const None should have comment (or a comment on this block) or be unexported (golint)
    • Line 31: warning: exported type Config should have comment or be unexported (golint)
    • Line 56: warning: exported type TransformationConfig should have comment or be unexported (golint)
    • Line 78: warning: exported type FrontMatterConfig should have comment or be unexported (golint)
    • Line 99: warning: exported function ParseConfig should have comment or be unexported (golint)
    • mdox/pkg/mdformatter/mdformatter.go
    • Line 27: warning: exported type SourceContext should have comment or be unexported (golint)
    • Line 33: warning: exported type FrontMatterTransformer should have comment or be unexported (golint)
    • Line 38: warning: exported type LinkTransformer should have comment or be unexported (golint)
    • Line 43: warning: exported type CodeBlockTransformer should have comment or be unexported (golint)
    • Line 48: warning: exported type Formatter should have comment or be unexported (golint)
    • Line 80: warning: exported function New should have comment or be unexported (golint)
    • Line 91: warning: exported type RemoveFrontMatter should have comment or be unexported (golint)
    • Line 93: warning: exported method RemoveFrontMatter.TransformFrontMatter should have comment or be unexported (golint)
    • Line 97: warning: exported method RemoveFrontMatter.Close should have comment or be unexported (golint)
    • Line 99: warning: exported type FormatFrontMatterTransformer should have comment or be unexported (golint)
    • Line 101: warning: exported method FormatFrontMatterTransformer.TransformFrontMatter should have comment or be unexported (golint)
    • Line 105: warning: exported function FormatFrontMatter should have comment or be unexported (golint)
    • Line 165: warning: exported method FormatFrontMatterTransformer.Close should have comment or be unexported (golint)
    • Line 167: warning: exported type Diffs 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!

misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!