linting

package

v1.2.0 Latest Latest Go to latest Published: Feb 1, 2023 License: MIT Imports: 2 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

View Source

const (
	LEVEL_ERROR   = "error"
	LEVEL_WARNING = "warning"
	LEVEL_INFO    = "info"
)

This section is empty.

This section is empty.

type Issue struct {
	Level   string
	Message string
	Rule    string
}

func Validate(rm *roadmap.Roadmap) []Issue

/ Validate will run all of the registered rules against the provided road map and return / a list of issues that were found.

func (i *Issue) Error() string

func (i *Issue) IsError() bool

func (i *Issue) String() string

type Rule interface {
	Validate(*roadmap.Roadmap) []Issue
}

func RuleFromFunction(fn func(*roadmap.Roadmap) []Issue) Rule

/ RuleFromFunction creates a new rule implementation based on the provided function.