check

package

v0.0.0-...-73df0bb Latest Latest Go to latest Published: Mar 30, 2018 License: Apache-2.0 Imports: 3 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

This section is empty.

This section is empty.

This section is empty.

type Check interface {
	Description() Description
	Check() ([]Suggestion, error)
	IsEnabled() bool
}

type Config struct {
	Disable bool `yaml:"disable"`
}

func (c Config) IsEnabled() bool

type Context struct {
	// contains filtered or unexported fields
}

func NewRootContext(desc string) Context

func (c Context) Nested(desc string) Context

func (c Context) String() string

type DashedName struct {
	Config
	// contains filtered or unexported fields
}

func NewDashedName(context Context, name string, config Config) DashedName

func (c DashedName) Check() ([]Suggestion, error)

func (c DashedName) Description() Description

type Description struct {
	Context_   Context
	Purpose_   string
	Reasoning_ string
}

func (d Description) Context() Context

func (d Description) Purpose() string

type Simple struct {
	Context_ Context

	Problem_    string
	Resolution_ string

	Details_ string
}

func (s Simple) Context() Context

func (s Simple) Problem() string

func (s Simple) Resolution() string

type Suggestion interface {
	Context() Context
	Problem() string
	Resolution() string
}

type Todo struct {
	Config
	// contains filtered or unexported fields
}

func NewTodo(context Context, content string, config Config) Todo

func (c Todo) Check() ([]Suggestion, error)

func (c Todo) Description() Description