ignore

Documentation

Index

• type Rules
  • func Empty(ignoreFile string) *Rules
  • func Parse(file io.Reader) (*Rules, error)
  • func (r *Rules) Ignore(path string, d fs.DirEntry) bool

Types

type Rules

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

rules is a collection of pattern matching rules.

func Empty

func Empty(ignoreFile string) *Rules

Empty builds an empty ruleset.

func Parse

func Parse(file io.Reader) (*Rules, error)

Parse parses a rules file and return empty rules

func (*Rules) Ignore

func (r *Rules) Ignore(path string, d fs.DirEntry) bool

Ignore evaluates the file at the given path, and returns true if it should be ignored.

Ignore evaluates path against the rules in order. Evaluation stops when a match is found. Matching a negative rule will stop evaluation.