Preparing report...

Report for github.com/vito/booklit

A+    Excellent!    Found 23 issues across 62 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!


gocyclo96%

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.


golint77%

Golint is a linter for Go source code.

    • booklit/docs/hello/go/plugin.go
    • Line 9: warning: exported type Example should have comment or be unexported (golint)
    • Line 13: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 17: warning: exported method Example.Quote should have comment or be unexported (golint)
    • booklit/tests/fixtures/erroring-plugin/plugin.go
    • Line 13: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 19: warning: exported type Plugin should have comment or be unexported (golint)
    • Line 23: warning: exported method Plugin.SingleFail should have comment or be unexported (golint)
    • Line 27: warning: exported method Plugin.MultiFail should have comment or be unexported (golint)
    • booklit/tests/example.go
    • Line 9: warning: should not use dot imports (golint)
    • Line 17: warning: exported type Example should have comment or be unexported (golint)
    • Line 25: warning: exported type Files should have comment or be unexported (golint)
    • Line 27: warning: exported method Example.Run should have comment or be unexported (golint)
    • booklit/baselit/plugin.go
    • Line 18: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 24: warning: exported type Plugin should have comment or be unexported (golint)
    • Line 28: warning: exported method Plugin.UsePlugin should have comment or be unexported (golint)
    • Line 39: warning: exported method Plugin.Styled should have comment or be unexported (golint)
    • Line 43: warning: exported method Plugin.Title should have comment or be unexported (golint)
    • Line 63: warning: exported method Plugin.Aux should have comment or be unexported (golint)
    • Line 69: warning: exported method Plugin.Section should have comment or be unexported (golint)
    • Line 82: warning: exported method Plugin.IncludeSection should have comment or be unexported (golint)
    • Line 95: warning: exported method Plugin.SinglePage should have comment or be unexported (golint)
    • Line 99: warning: exported method Plugin.SplitSections should have comment or be unexported (golint)
    • Line 107: warning: exported method Plugin.OmitChildrenFromTableOfContents should have comment or be unexported (golint)
    • Line 111: warning: exported method Plugin.TableOfContents should have comment or be unexported (golint)
    • Line 117: warning: exported method Plugin.Code should have comment or be unexported (golint)
    • Line 124: warning: exported method Plugin.Italic should have comment or be unexported (golint)
    • Line 131: warning: exported method Plugin.Bold should have comment or be unexported (golint)
    • Line 138: warning: exported method Plugin.Larger should have comment or be unexported (golint)
    • Line 145: warning: exported method Plugin.Smaller should have comment or be unexported (golint)
    • Line 152: warning: exported method Plugin.Strike should have comment or be unexported (golint)
    • Line 159: warning: exported method Plugin.Superscript should have comment or be unexported (golint)
    • Line 166: warning: exported method Plugin.Subscript should have comment or be unexported (golint)
    • Line 173: warning: exported method Plugin.Inset should have comment or be unexported (golint)
    • Line 180: warning: exported method Plugin.Aside should have comment or be unexported (golint)
    • Line 187: warning: exported method Plugin.Link should have comment or be unexported (golint)
    • Line 194: warning: exported method Plugin.Reference should have comment or be unexported (golint)
    • Line 208: warning: exported method Plugin.Target should have comment or be unexported (golint)
    • Line 227: warning: exported method Plugin.List should have comment or be unexported (golint)
    • Line 233: warning: exported method Plugin.OrderedList should have comment or be unexported (golint)
    • Line 240: warning: exported method Plugin.Image should have comment or be unexported (golint)
    • Line 252: warning: exported method Plugin.SetPartial should have comment or be unexported (golint)
    • Line 256: warning: exported method Plugin.Table should have comment or be unexported (golint)
    • Line 271: warning: exported method Plugin.TableRow should have comment or be unexported (golint)
    • Line 275: warning: exported method Plugin.Definitions should have comment or be unexported (golint)
    • Line 296: warning: exported method Plugin.Definition should have comment or be unexported (golint)
    • booklit/chroma/plugin.go
    • Line 32: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 38: warning: exported type Plugin should have comment or be unexported (golint)
    • Line 42: warning: exported method Plugin.Syntax should have comment or be unexported (golint)
    • Line 51: warning: exported type Transformer should have comment or be unexported (golint)
    • Line 56: warning: exported method Transformer.TransformAll should have comment or be unexported (golint)
    • Line 78: warning: exported method Plugin.SyntaxTransform should have comment or be unexported (golint)
    • booklit/tests/fixtures/partials-style-plugin/plugin.go
    • Line 9: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 15: warning: exported type Plugin should have comment or be unexported (golint)
    • Line 19: warning: exported type MyStruct should have comment or be unexported (golint)
    • Line 23: warning: exported method Plugin.BlockStyle should have comment or be unexported (golint)
    • Line 36: warning: exported method Plugin.InlineStyle should have comment or be unexported (golint)
    • booklit/docs/go/plugin.go
    • Line 43: warning: exported function NewPlugin should have comment or be unexported (golint)
    • Line 51: warning: exported type Plugin should have comment or be unexported (golint)
    • Line 57: warning: exported method Plugin.OutputFrame should have comment or be unexported (golint)
    • Line 70: warning: exported method Plugin.SyntaxHl should have comment or be unexported (golint)
    • Line 77: warning: exported method Plugin.ColumnHeader should have comment or be unexported (golint)
    • Line 85: warning: exported method Plugin.Columns should have comment or be unexported (golint)
    • Line 127: warning: exported method Plugin.LitSyntax should have comment or be unexported (golint)
    • Line 144: warning: exported method Plugin.Godoc should have comment or be unexported (golint)
    • Line 161: warning: exported method Plugin.TemplateLink should have comment or be unexported (golint)
    • Line 171: warning: exported method Plugin.Define should have comment or be unexported (golint)
    • Line 219: warning: exported method Plugin.DescribeFruit should have comment or be unexported (golint)
    • booklit/booklitcmd/command.go
    • Line 18: warning: exported type Command should have comment or be unexported (golint)
    • Line 47: warning: exported method Command.Execute should have comment or be unexported (golint)
    • Line 73: warning: exported method Command.Serve should have comment or be unexported (golint)
    • Line 94: warning: exported method Command.Build should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!


ineffassign87%

IneffAssign detects ineffectual assignments in Go code.

    • /home/shawn/mygo/src/github.com/gojp/goreportcard/_repos/src/github.com/vito/booklit/errors.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)
    • booklit/render/html.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/html; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/html (invalid package name: "") (ineffassign)
    • booklit/render/text.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/text; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/text (invalid package name: "") (ineffassign)
    • /home/shawn/mygo/src/github.com/gojp/goreportcard/_repos/src/github.com/vito/booklit/render/html.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/html; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/html (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/html; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/html (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/html; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/html (invalid package name: "") (ineffassign)
    • /home/shawn/mygo/src/github.com/gojp/goreportcard/_repos/src/github.com/vito/booklit/render/text.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/text; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/text (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/text; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/text (invalid package name: "") (ineffassign)
    • Line 16: warning: no required module provides package github.com/vito/booklit/render/text; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/render/text (invalid package name: "") (ineffassign)
    • booklit/errors.go
    • Line 16: warning: no required module provides package github.com/vito/booklit/errhtml; to add it: (ineffassign)
    • Line 16: warning: could not import github.com/vito/booklit/errhtml (invalid package name: "") (ineffassign)

misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!