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

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