filematcher

Documentation

Index

• func Matches(file string, patterns []string, opts ...Option) (bool, error)
• type Option
  • func WithRegexpProvider(p RegexpProvider) Option
• type Pattern
  • func (p *Pattern) String() string
• type PatternMatcher
  • func NewPatternMatcher(patterns []string, opts ...Option) (*PatternMatcher, error)
  • func (pm *PatternMatcher) Exclusions() []*Pattern
  • func (pm *PatternMatcher) Matches(file string) bool
  • func (pm *PatternMatcher) MatchesAny(files []string) bool
  • func (pm *PatternMatcher) Patterns() []*Pattern
• type RegexpProvider

Functions

func Matches

func Matches(file string, patterns []string, opts ...Option) (bool, error)

Matches returns true if file matches any of the patterns and isn't excluded by any of the subsequent patterns.

Types

type Option

type Option func(*PatternMatcher)

An Option configures a PatternMatcher.

func WithRegexpProvider

func WithRegexpProvider(p RegexpProvider) Option

WithRegexpProvider sets a custom regexp provider.

type Pattern

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

Pattern defines a single regexp used to filter file paths.

func (*Pattern) String

func (p *Pattern) String() string

type PatternMatcher

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

PatternMatcher allows checking paths against a list of patterns.

func NewPatternMatcher

func NewPatternMatcher(patterns []string, opts ...Option) (*PatternMatcher, error)

NewPatternMatcher creates a new matcher object for specific patterns that can be used later to match against patterns against paths.

func (*PatternMatcher) Exclusions

func (pm *PatternMatcher) Exclusions() []*Pattern

Exclusions returns array of negative patterns.

func (*PatternMatcher) Matches

func (pm *PatternMatcher) Matches(file string) bool

Matches matches path against all the patterns. Matches is not safe to be called concurrently.

func (*PatternMatcher) MatchesAny

func (pm *PatternMatcher) MatchesAny(files []string) bool

func (*PatternMatcher) Patterns

func (pm *PatternMatcher) Patterns() []*Pattern

Patterns returns array of active patterns.

type RegexpProvider

type RegexpProvider func(string) (*regexp.Regexp, error)