golinters

README

golinters

golinters generates HTML reports about Go linters. It fetches the linters' source and does static analysis. It also queries the GitHub API to figure out the maintainers.

$ go get github.com/thomasheller/golinters/cmd/golinters
$ golinters
[...]

If a popular linter is missing, please file an issue!

Example output

Download corresponding HTML file

Options

By default, golinters will create a temporary file and open the report in the standard browser.

You can specify -write somefile.html though, if you want golinters to just write to a specific file and not open any browser.

Because golinters uses the GitHub API to figure out the maintainers' names, you might want to supply a GitHub username and API token via -ghuser and -ghtoken so that you don't run into rate limit problems.

If you want to start over, you can use -remove to delete the linters' source in your GOPATH. Be careful, as this deletes entire repositories, even if the linter is just one part of it.

Documentation

Index

• func Analyze(ghUser *string, ghToken *string, out *string)
• func RemoveAllRepos()
• type TemplateData

Functions

func Analyze

func Analyze(ghUser *string, ghToken *string, out *string)

func RemoveAllRepos

func RemoveAllRepos()

RemoveAllRepos deletes the entire source code repository in GOPATH/src for all known linters. Be careful.

Types

type TemplateData

type TemplateData struct {
	Timestamp string
	Results   []result
}