Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

pathrules

package module

Go to main page

Versions in this module

v0

v0.3.0

Aug 7, 2026

Changes in this version

type MatcherOptions

+ EnableBraceExpansion bool

+ EnableEscaping bool

v0.2.0

Aug 6, 2026

Changes in this version

+ var ErrInvalidParseOptions = errors.New("invalid parse options")

+ type ParseOptions struct

+ CommentPrefix string

+ DisableNegation bool

+ KeepTrailingSpaces bool

+ NegatedAction Action

+ NegationPrefix string

+ PlainAction Action

type ProviderOptions

+ ParseOptions ParseOptions

v0.1.3

Jul 1, 2026

v0.1.2

Feb 21, 2026

Changes in this version

type Rule

+ func ParseExtensions(exts []string) []Rule

v0.1.1

Feb 18, 2026

v0.1.0

Feb 17, 2026

Changes in this version

+ var ErrInvalidEntryName = errors.New("invalid entry name")

+ var ErrInvalidPattern = errors.New("invalid pattern")

+ var ErrInvalidRule = errors.New("invalid rule")

+ var ErrInvalidRulesFileName = errors.New("invalid rules file name")

+ var ErrNilProvider = errors.New("provider is nil")

+ var ErrPathOutsideRoot = errors.New("path is outside provider root")

+ var ErrRulesPathOutsideRoot = errors.New("rules file path is outside provider root")

+ type Action uint8

+ const ActionExclude

+ const ActionInclude

+ const ActionUnknown

+ type DirEntry struct

+ IsDir bool

+ Name string

+ type MatchResult struct

+ Included bool

+ Matched bool

+ RuleIndex int

+ type Matcher struct

+ func NewMatcher(rules []Rule, opts MatcherOptions) (*Matcher, error)

+ func (m *Matcher) Decide(path string, isDir bool) MatchResult

+ func (m *Matcher) Excluded(path string, isDir bool) bool

+ func (m *Matcher) Included(path string, isDir bool) bool

+ type MatcherOptions struct

+ CaseInsensitive bool

+ DefaultAction Action

+ type Provider struct

+ func NewProvider(rootDir string, opts ProviderOptions) (*Provider, error)

+ func (p *Provider) Decide(relPath string, isDir bool) (MatchResult, error)

+ func (p *Provider) DecideInDir(relDir string, entries []DirEntry) ([]MatchResult, error)

+ func (p *Provider) Excluded(relPath string, isDir bool) (bool, error)

+ func (p *Provider) ExcludedInDir(relDir string, entries []DirEntry) ([]bool, error)

+ func (p *Provider) Included(relPath string, isDir bool) (bool, error)

+ func (p *Provider) IncludedInDir(relDir string, entries []DirEntry) ([]bool, error)

+ type ProviderOptions struct

+ BaseRules []Rule

+ EnableSymlinkEscapeCheck bool

+ MatcherOptions MatcherOptions

+ RulesFileName string

+ type Rule struct

+ Action Action

+ Pattern string

+ func LoadRulesFile(path string) ([]Rule, error)

+ func LoadRulesFiles(paths ...string) ([]Rule, error)

+ func MergeRules(ruleSets ...[]Rule) []Rule

+ func ParseRules(r io.Reader) ([]Rule, error)

+ func ParseRulesString(src string) ([]Rule, error)