formatignore

package

v0.5.0 Latest Latest Go to latest Published: Jul 1, 2026 License: MIT Imports: 7 Imported by: 0

Details

Package formatignore matches formatter ignore files against paths.

This section is empty.

This section is empty.

func MatchPath(fs afero.Fs, path string, isDir bool) (bool, error)

MatchPath reports whether path is ignored by the nearest formatter root.

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

Matcher matches file paths against formatter ignore files.

func ForPath(fs afero.Fs, path string) (Matcher, bool, error)

ForPath returns a matcher rooted at the nearest formatter root for path.

The root is the first parent directory containing .git, .prettierignore, or .scutignore. If no root is found, the returned bool is false.

func (m Matcher) Match(path string, isDir bool) (bool, error)

Match reports whether path is ignored.