ignore

Documentation

Index

• func IsParseError(err error) bool
• func WriteIgnores(filesystem fs.Filesystem, path string, content []string) error
• type ChangeDetector
• type Matcher
  • func New(fs fs.Filesystem, opts ...Option) *Matcher
  • func (m *Matcher) Hash() string
  • func (m *Matcher) Lines() []string
  • func (m *Matcher) Load(file string) error
  • func (m *Matcher) Match(file string) (result Result)
  • func (m *Matcher) Parse(r io.Reader, file string) error
  • func (m *Matcher) Patterns() []string
  • func (m *Matcher) ShouldIgnore(filename string) bool
  • func (m *Matcher) SkipIgnoredDirs() bool
  • func (m *Matcher) Stop()
  • func (m *Matcher) String() string
• type Option
  • func WithCache(v bool) Option
  • func WithChangeDetector(cd ChangeDetector) Option
• type ParseError
  • func (e *ParseError) Error() string
  • func (e *ParseError) Unwrap() error
• type Pattern
  • func (p Pattern) String() string
• type Result
  • func (r Result) IsCaseFolded() bool
  • func (r Result) IsDeletable() bool
  • func (r Result) IsIgnored() bool

Functions

func IsParseError

func IsParseError(err error) bool

func WriteIgnores

func WriteIgnores(filesystem fs.Filesystem, path string, content []string) error

WriteIgnores is a convenience function to avoid code duplication

Types

type ChangeDetector

type ChangeDetector interface {
	Remember(fs fs.Filesystem, name string, modtime time.Time)
	Seen(fs fs.Filesystem, name string) bool
	Changed() bool
	Reset()
}

The ChangeDetector is responsible for determining if files have changed on disk. It gets told to Remember() files (name and modtime) and will then get asked if a file has been Seen() (i.e., Remember() has been called on it) and if any of the files have Changed(). To forget all files, call Reset().

type Matcher

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

func New

func New(fs fs.Filesystem, opts ...Option) *Matcher

func (*Matcher) Hash

func (m *Matcher) Hash() string

func (*Matcher) Lines

func (m *Matcher) Lines() []string

Lines return a list of the unprocessed lines in .stignore at last load

func (*Matcher) Load

func (m *Matcher) Load(file string) error

Load and parse a file. The returned error may be of type *ParseError in which case a file was loaded from disk but the patterns could not be parsed. In this case the contents of the file are nonetheless available in the Lines() method.

func (*Matcher) Match

func (m *Matcher) Match(file string) (result Result)

func (*Matcher) Parse

func (m *Matcher) Parse(r io.Reader, file string) error

Load and parse an io.Reader. See Load() for notes on the returned error.

func (*Matcher) Patterns

func (m *Matcher) Patterns() []string

Patterns return a list of the loaded patterns, as they've been parsed

func (*Matcher) ShouldIgnore

func (m *Matcher) ShouldIgnore(filename string) bool

ShouldIgnore returns true when a file is temporary, internal or ignored

func (*Matcher) SkipIgnoredDirs

func (m *Matcher) SkipIgnoredDirs() bool

func (*Matcher) Stop

func (m *Matcher) Stop()

func (*Matcher) String

func (m *Matcher) String() string

type Option

type Option func(*Matcher)

An Option can be passed to New()

func WithCache

func WithCache(v bool) Option

WithCache enables or disables lookup caching. The default is disabled.

func WithChangeDetector

func WithChangeDetector(cd ChangeDetector) Option

WithChangeDetector sets a custom ChangeDetector. The default is to simply use the on disk modtime for comparison.

type ParseError

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

A ParseError signifies an error with contents of an ignore file, including I/O errors on included files. An I/O error on the root level ignore file is not a ParseError.

func (*ParseError) Error

func (e *ParseError) Error() string

func (*ParseError) Unwrap

func (e *ParseError) Unwrap() error

type Pattern

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

func (Pattern) String

func (p Pattern) String() string

type Result

type Result uint8

func (Result) IsCaseFolded

func (r Result) IsCaseFolded() bool

func (Result) IsDeletable

func (r Result) IsDeletable() bool

func (Result) IsIgnored

func (r Result) IsIgnored() bool