file_ignore

Documentation

Index

• func DefaultIgnoreFunc(worktree_root fs.FS, fpath string, d fs.DirEntry, err error) error
• func FnMatch(name, pat string) (bool, error)
• func FnMatchCase(name, pat string) (bool, error)
• func GetWorkTreeRoot(start_dir string) (string, error)
• func IsRoot(fpath string) bool
• func Parent()
• func ParentDirs(fpath string) []string
• func ReverseInplace[T any](slice []T) []T
• func WalkWorktree(worktree_fs fs.FS, start_dir string, fn, fn_ignore WalkDirFunc) error
• type IgnoreCache
  • func NewIgnoreCache(worktree_root fs.FS) *IgnoreCache
  • func (ic *IgnoreCache) MatchesIgnore(fpath string, de fs.DirEntry) bool
• type IgnorePattern
  • func ParseIgnoreFile(worktree_root fs.FS, ignore_file_path string) ([]IgnorePattern, error)
• type WalkDirFunc

Functions

func DefaultIgnoreFunc

func DefaultIgnoreFunc(worktree_root fs.FS, fpath string, d fs.DirEntry, err error) error

Skip ignored directories. Do nothing with ignored files.

func FnMatch

func FnMatch(name, pat string) (bool, error)

func FnMatchCase

func FnMatchCase(name, pat string) (bool, error)

func GetWorkTreeRoot

func GetWorkTreeRoot(start_dir string) (string, error)

func IsRoot

func IsRoot(fpath string) bool

func Parent

func Parent()

func ParentDirs

func ParentDirs(fpath string) []string

func ReverseInplace

func ReverseInplace[T any](slice []T) []T

ReverseInplace reverses a slice in place, then returns it.

func WalkWorktree

func WalkWorktree(worktree_fs fs.FS, start_dir string, fn, fn_ignore WalkDirFunc) error

Similar to `fs.WalkDir`, but calls a separate func for ignored files.

Types

type IgnoreCache

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

func NewIgnoreCache

func NewIgnoreCache(worktree_root fs.FS) *IgnoreCache

func (*IgnoreCache) MatchesIgnore

func (ic *IgnoreCache) MatchesIgnore(fpath string, de fs.DirEntry) bool

type IgnorePattern

type IgnorePattern struct {
	IgnoreRoot      string
	OriginalPattern string
	Pattern         string
	AsDir           bool
	Rooted          bool
	Negated         bool
}

func ParseIgnoreFile

func ParseIgnoreFile(worktree_root fs.FS, ignore_file_path string) ([]IgnorePattern, error)

For gitignore matching rules ee URL: https://git-scm.com/docs/gitignore

type WalkDirFunc

type WalkDirFunc func(worktree_root fs.FS, fpath string, d fs.DirEntry, err error) error