ignore-files 3.0.7

Find, parse, and interpret ignore files
Documentation 
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
61
62
63
64

//! 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.

#![cfg_attr(not(test), warn(unused_crate_dependencies))]

use std::path::{Path, PathBuf};

use normalize_path::NormalizePath;
use project_origins::ProjectType;

#[doc(inline)]
pub use discover::*;
mod discover;

#[doc(inline)]
pub use error::*;
mod error;

#[doc(inline)]
pub use filter::*;
mod filter;

/// Directory names treated as version-control metadata.
///
/// Used internally for ignore-file discovery. Reuse this list when ignoring VCS metadata to
/// automatically follow additions to the crate's discovery support.
pub const VCS_DIR_NAMES: &[&str] = &[
	".bzr",
	"_darcs",
	".fossil-settings",
	".git",
	".hg",
	".pijul",
	".svn",
];

/// An ignore file.
///
/// This records both the path to the ignore file and some basic metadata about it: which project
/// type it applies to if any, and which subtree it applies in if any (`None` = global ignore file).
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct IgnoreFile {
	/// The path to the ignore file.
	pub path: PathBuf,

	/// The path to the subtree the ignore file applies to, or `None` for global ignores.
	pub applies_in: Option<PathBuf>,

	/// Which project type the ignore file applies to, or was found through.
	pub applies_to: Option<ProjectType>,
}

pub(crate) fn simplify_path(path: &Path) -> PathBuf {
	dunce::simplified(path).normalize()
}