engine

Documentation

Index

• type Engine
  • func New(src Source) *Engine
  • func (e *Engine) Register(r types.Rule)
  • func (e *Engine) RegisterMany(r []types.Rule)
  • func (e *Engine) Run(root string) ([]types.Issue, error)
• type FileSystem
  • func (f FileSystem) List(root string) ([]string, error)
  • func (FileSystem) ReadFile(path string) ([]byte, error)
• type Source

Types

type Engine

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

func New

func New(src Source) *Engine

func (*Engine) Register

func (e *Engine) Register(r types.Rule)

func (*Engine) RegisterMany

func (e *Engine) RegisterMany(r []types.Rule)

func (*Engine) Run

func (e *Engine) Run(root string) ([]types.Issue, error)

type FileSystem

type FileSystem struct {
	SkipDirs []string
}

func (FileSystem) List

func (f FileSystem) List(root string) ([]string, error)

func (FileSystem) ReadFile

func (FileSystem) ReadFile(path string) ([]byte, error)

type Source

type Source interface {
	List(root string) ([]string, error)
	ReadFile(path string) ([]byte, error)
}