rules

package

v0.0.0-...-bd26d79 Latest Latest Go to latest Published: Aug 17, 2023 License: MIT Imports: 1 Imported by: 2

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

Package rules contains specific rules as subpackages to check a Makefile against

This section is empty.

This section is empty.

func RegisterRule(r Rule)

RegisterRule let's you register a rule for inclusion in the validator

type Rule interface {
	Name() string
	Description() string
	Run(parser.Makefile, RuleConfig) RuleViolationList
}

Rule is the type of a rule function

type RuleConfig map[string]string

RuleConfig is a simple string/string map to hold key/value configuration for rules.

type RuleConfigMap map[string]RuleConfig

RuleConfigMap is a map that stores RuleConfig maps keyed by the rule name

type RuleRegistry map[string]Rule

RuleRegistry is the type to hold rules keyed by their name

func GetRegisteredRules() RuleRegistry

GetRegisteredRules returns the internal ruleRegistry

type RuleViolation struct {
	Rule       string
	Violation  string
	FileName   string
	LineNumber int
}

RuleViolation represents a basic validation failure

type RuleViolationList []RuleViolation

RuleViolationList is a list of Violation types and the return type of a Rule function

Path	Synopsis
maxbodylength Package maxbodylength implements the ruleset for making sure target bodies are kept short and thus hopefully somewhat not complex.	Package maxbodylength implements the ruleset for making sure target bodies are kept short and thus hopefully somewhat not complex.
minphony Package minphony implements the ruleset for making sure required minimum phony targets are present	Package minphony implements the ruleset for making sure required minimum phony targets are present
phonydeclared Package phonydeclared implements the ruleset for making sure all targets that don't have a rule body are marked PHONY	Package phonydeclared implements the ruleset for making sure all targets that don't have a rule body are marked PHONY
timestampexpanded Package timestampexpanded implements the ruleset for making sure a variable that likely represents a timestamp is simply expanded so it doesn't change in between rule executions.	Package timestampexpanded implements the ruleset for making sure a variable that likely represents a timestamp is simply expanded so it doesn't change in between rule executions.