validator

Documentation

Index

• Constants
• type Check
  • func (chk Check) ValidateImports(path string, imports []*ast.ImportSpec, debug bool) []ValidationError
• type Config
• type Reason
• type Rule
• type ValidationError
  • func Validate(root string, checks []Check, debug bool) ([]ValidationError, error)

Constants

const (
	ReasonNotAllow = iota + 1
	ReasonRejected
)

Types

type Check

type Check struct {
	Folder      string `yaml:"folder"`
	Subpackages bool   `yaml:"subpackages"`
	Rules       []Rule `yaml:"rules"`
}

func (Check) ValidateImports

func (chk Check) ValidateImports(path string, imports []*ast.ImportSpec, debug bool) []ValidationError

type Config

type Config struct {
	Checks []Check `yaml:"imports-checks"`
}

type Reason

type Reason int

type Rule

type Rule struct {
	Prefix string   `yaml:"prefix"`
	Reject []string `yaml:"reject"`
	Allow  []string `yaml:"allow"`
}

type ValidationError

type ValidationError struct {
	Path       string
	Check      Check
	Rule       Rule
	ImportPath string
	Reason     Reason
}

func Validate

func Validate(root string, checks []Check, debug bool) ([]ValidationError, error)