goprove

package module

v0.0.0-...-7511a42 Latest Latest Go to latest Published: Dec 5, 2016 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/karolgorecki/goprove

Links

Open Source Insights

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{})

Constants ¶

This section is empty.

Variables ¶

This section is empty.

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

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
goprove
util Package util provides some helper methods.	Package util provides some helper methods.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL