ignore

package

v0.1.1 Latest Latest Go to latest Published: May 18, 2025 License: MIT Imports: 6 Imported by: 0

Details

View Source

const ExampleBase = `#.dotatoignore
**/*dotato*
**/README.md
`

View Source

const ExampleGroup = `#.dotatoignore
*
!.bashrc
# !my-dir
# !.my-file
`

This section is empty.

func GetBaseFrom(dir gp.GardenPath) int

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

Ignore wraps RuleTree and implements file read.

func New(base gp.GardenPath, ignoreFileName string) *Ignore

Create an Ignore instance.

func NewWithFS(fs billy.Filesystem, base gp.GardenPath, ignoreFileName string) *Ignore

func (i Ignore) IsIgnored(path gp.GardenPath) bool

func (i Ignore) IsIgnoredWithBaseDir(baseDir gp.GardenPath, path gp.GardenPath) bool

func (i Ignore) Read(dir gp.GardenPath) (bool, error)

Read the ignore file in the given directory.

func (i Ignore) ReadRecur(dir gp.GardenPath) error

Read the ignore file in the given directory and all its subdirectories.

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

func (t *RuleTree) Append(dir gp.GardenPath, rules *Rules)

Add rules to the tree at the given dir.

This function overwrites the existing rules.

If dir is nil, it will do nothing.

func (t RuleTree) IsIgnored(path gp.GardenPath) bool

func (t RuleTree) IsIgnoredWithBase(base int, path gp.GardenPath) bool

func (t RuleTree) IsIgnoredWithBaseDir(baseDir gp.GardenPath, path gp.GardenPath) bool

Use base from the given dir.

func (t *RuleTree) SetBase(base int)

func (t *RuleTree) SetBaseFromDir(dir gp.GardenPath)

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

A wrapper of external gitignore package.

func (r Rules) IsIgnored(relPath string) bool

Ignore rule works with relative path.