goprove

README

📃 goprove

Inspect your project for the best practices listed in the Go CheckList.

Get Started

$ go get github.com/karolgorecki/goprove/cmd/goprove
$ goprove .

Usage

Usage:
  SIMPLE:
  	goprove <directory>
  WITH OUTPUT:
  	goprove -output=<output: json or text> <directory>
  WITH EXCLUDE:
  	goprove -exclude=<tasks: separated by comma> <directory>
Available tasks for exclude:
  projectBuilds, isFormatted, hasLicense, isLinted, isVetted, hasReadme,
  testPassing, isDirMatch, hasContributing, hasBenches, hasBlackboxTests

Contributing

Contributions are most welcome. Instructions are documented in CONTRIBUTING.md.

License

MIT

Documentation

Overview

Package goprove contains lib for checking the Golang best practi

Package goprove contains lib for checking the Golang best practises

Index

• func RunTasks(path string, tasksToExlude []string) (successTasks []map[string]interface{}, failedTasks []map[string]interface{})

Functions

func RunTasks

func RunTasks(path string, tasksToExlude []string) (successTasks []map[string]interface{}, failedTasks []map[string]interface{})

RunTasks is a wrapper for running all tasks from the list