Expand description
Find, parse, and interpret ignore files.
Ignore files are files that contain ignore patterns, often following the .gitignore format.
There may be one or more global ignore files, which apply everywhere, and one or more per-folder
ignore files, which apply to a specific folder and its subfolders. Furthermore, there may be
more ignore files in these subfolders, and so on. Discovering and interpreting all of these in
a single context is not a simple task: this is what this crate provides.
Discovery and loading are explicit snapshots. This crate does not watch ignore files for edits or
automatically rediscover files created later; call the discovery/loading APIs again, or update an
unfinished IgnoreFilter with its mutation methods.
Structs§
- Ignore
File - An ignore file.
- Ignore
Files From Origin Args - Arguments for finding ignored files in a given directory and subdirectories
- Ignore
Filter - A mutable filter dedicated to ignore files and trees of ignore files.
Enums§
Constants§
- VCS_
DIR_ NAMES - Directory names treated as version-control metadata.
Functions§
- discover_
file - Utility function to handle looking for an ignore file and adding it to a list if found.
- from_
environment - Finds all ignore files that apply to the current runtime.
- from_
origin - Finds all ignore files in the given directory and subdirectories.