1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
//! Git ignore rules over repository-relative byte paths.
//!
//! Construct [`Ignore`] with [`Case`] and [`Limits`], add explicitly loaded [`Source`] bytes in
//! precedence order, then call [`Ignore::check`] for a path and its directory kind. A returned
//! [`Match`] explains the decision; `None` means no supplied rule matched. The caller owns source
//! discovery and tracked-file policy. To load the files Git reads for a worktree instead, call
//! [`Repository::ignore_rules`](crate::Repository::ignore_rules), which returns [`WorktreeRules`];
//! [`Repository::status`](crate::Repository::status) applies them to untracked paths.
//!
//! Rule evaluation checks every ancestor before the requested path: an excluded directory prevents
//! child rules from re-including its contents. Callers still own traversal, symlink classification
//! and tracked-file selection.
//! Convert native OS paths to slash-separated repository paths before querying; in particular,
//! backslash is a literal byte here even on Windows. Git for Windows CLI path interpretation is
//! therefore a separate adapter boundary.
//!
//! [`Ignore`] reads no filesystem, index, environment or configuration. Resolve `core.excludesFile`
//! (including home expansion/defaults) and load its bytes explicitly; do the same for the common
//! directory's `info/exclude` and encountered `.gitignore` files. Do not follow worktree
//! `.gitignore` symlinks. Missing optional sources can be omitted; propagate other loading errors.
//! Retained sources describe the supplied observations, not an atomic filesystem snapshot.
//!
//! ```
//! use girt::ignore::{Case, Ignore, Limits, Source};
//!
//! let mut ignore = Ignore::new(Case::Sensitive, Limits::default());
//! ignore.add(Source::Global, b"*.log\n")?;
//! ignore.add(Source::Directory(b""), b"!keep.log\nbuild/\n!build/keep\n")?;
//!
//! assert!(
//! ignore
//! .check(b"keep.log", girt::ignore::InputKind::File)?
//! .is_some_and(|matched| !matched.ignored)
//! );
//! assert!(
//! ignore
//! .check(b"build/keep", girt::ignore::InputKind::File)?
//! .is_some_and(|matched| matched.ignored)
//! );
//! # Ok::<(), girt::ignore::Error>(())
//! ```
#![warn(
clippy::unwrap_used,
clippy::expect_used,
clippy::panic,
clippy::unreachable,
clippy::indexing_slicing,
reason = "parses untrusted repository or network input (#103)"
)]
pub(crate) mod pattern;
mod rules;
mod worktree;
pub use rules::{Case, Error, Ignore, InputKind, Limits, Match, Source};
pub use worktree::{LoadError, SourceFile, SourceKind, WorktreeRules};
#[cfg(test)]
mod tests;