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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
//! Implements parsing and applying .gitignore and .ignore files.
// TODO rename without the "Git" prefix, as it's not only for gitignore
use {
git2,
glob,
id_arena::{
Arena,
Id,
},
lazy_regex::regex,
once_cell::sync::Lazy,
std::{
fmt,
fs::File,
io::{
BufRead,
BufReader,
Result,
},
path::{
Path,
PathBuf,
},
},
};
#[derive(Default)]
pub struct Ignorer {
files: Arena<IgnoreFile>,
}
#[derive(Debug, Clone, Default)]
pub struct IgnoreChain {
in_repo: bool,
file_ids: Vec<Id<IgnoreFile>>,
}
/// The rules of a gitignore file
#[derive(Debug, Clone)]
pub struct IgnoreFile {
rules: Vec<IgnoreRule>,
/// whether this is a git dedicated file (as opposed to a .ignore file)
git: bool,
local_git_ignore: bool,
}
/// a simple rule of a gitignore file
#[derive(Clone)]
struct IgnoreRule {
ok: bool, // does this rule when matched means the file is good? (usually false)
directory: bool, // whether this rule only applies to directories
filename: bool, // does this rule apply to just the filename
pattern: glob::Pattern,
pattern_options: glob::MatchOptions,
}
impl fmt::Debug for IgnoreRule {
fn fmt(
&self,
f: &mut fmt::Formatter<'_>,
) -> fmt::Result {
f.debug_struct("IgnoreRule")
.field("ok", &self.ok)
.field("directory", &self.directory)
.field("filename", &self.filename)
.field("pattern", &self.pattern.as_str())
.finish_non_exhaustive()
}
}
impl IgnoreRule {
/// parse a line of a .gitignore file.
/// The `ref_dir` is used if the line starts with '/'
fn from(
line: &str,
ref_dir: &Path,
) -> Option<IgnoreRule> {
if line.starts_with('#') {
return None; // comment line
}
let r = regex!(
r"(?x)
^\s*
(!)? # 1 : negation
(.+?) # 2 : pattern
(/)? # 3 : directory
\s*$
"
);
if let Some(c) = r.captures(line) {
if let Some(p) = c.get(2) {
let p = p.as_str();
let has_separator = p.contains('/');
let p = if has_separator {
if p.starts_with('/') {
format!("{}{}", ref_dir.to_string_lossy(), p)
} else {
format!("**/{p}")
}
} else {
p.to_string()
};
match glob::Pattern::new(&p) {
Ok(pattern) => {
let pattern_options = glob::MatchOptions {
case_sensitive: true,
require_literal_leading_dot: false,
require_literal_separator: has_separator,
};
return Some(IgnoreRule {
ok: c.get(1).is_some(), // if negation
pattern,
directory: c.get(3).is_some(),
filename: !has_separator,
pattern_options,
});
}
Err(e) => {
info!(" wrong glob pattern {:?} : {}", &p, e);
}
}
}
}
None
}
}
impl IgnoreFile {
/// build a new gitignore file, from either a global ignore file or
/// a .gitignore file found inside a git repository.
/// The `ref_dir` is either:
/// - the path of the current repository for the global gitignore
/// - the directory containing the .gitignore file
pub fn new(
file_path: &Path,
ref_dir: &Path,
local_git_ignore: bool,
) -> Result<IgnoreFile> {
let f = File::open(file_path)?;
let git = file_path.file_name().is_some_and(|f| f == ".gitignore");
let mut rules: Vec<IgnoreRule> = Vec::new();
for line in BufReader::new(f).lines() {
if let Some(rule) = IgnoreRule::from(&line?, ref_dir) {
rules.push(rule);
}
}
// the last rule applicable to a path is the right one. So
// we reverse the list to easily iterate from the last one to the first one
rules.reverse();
Ok(IgnoreFile {
rules,
git,
local_git_ignore,
})
}
/// return the global gitignore file interpreted for
/// the given repo dir
pub fn global(repo_dir: &Path) -> Option<IgnoreFile> {
static GLOBAL_GI_PATH: Lazy<Option<PathBuf>> = Lazy::new(find_global_ignore);
if let Some(path) = &*GLOBAL_GI_PATH {
IgnoreFile::new(path, repo_dir, true).ok()
} else {
None
}
}
}
pub fn find_global_ignore() -> Option<PathBuf> {
git2::Config::open_default()
.and_then(|global_config| global_config.get_path("core.excludesfile"))
.ok()
.or_else(|| {
directories::BaseDirs::new()
.map(|base_dirs| base_dirs.config_dir().join("git/ignore"))
.filter(|path| path.exists())
})
.or_else(|| {
directories::UserDirs::new()
.map(|user_dirs| user_dirs.home_dir().join(".config/git/ignore"))
.filter(|path| path.exists())
})
}
impl IgnoreChain {
pub fn push(
&mut self,
id: Id<IgnoreFile>,
) {
self.file_ids.push(id);
}
}
impl Ignorer {
pub fn root_chain(
&mut self,
mut dir: &Path,
) -> IgnoreChain {
let mut chain = IgnoreChain::default();
loop {
let is_repo = is_repo(dir);
if is_repo {
if let Some(gif) = IgnoreFile::global(dir) {
chain.push(self.files.alloc(gif));
}
}
for (filename, local_git_ignore) in [
(".gitignore", true),
(".git/info/exclude", true),
(".ignore", false),
] {
if chain.in_repo && local_git_ignore {
// we don't add outside .gitignore files when we're in a repo
continue;
}
let file = dir.join(filename);
if let Ok(gif) = IgnoreFile::new(&file, dir, local_git_ignore) {
chain.push(self.files.alloc(gif));
}
}
if is_repo {
chain.in_repo = true;
}
if let Some(parent) = dir.parent() {
dir = parent;
} else {
break;
}
}
chain
}
/// Build a new chain by going deeper in the file system.
///
/// The chain contains
/// - the global gitignore file (if any)
/// - all the .ignore files found in the current directory and in parents
/// - the .git/info/exclude file of the current git repository
/// - all the .gitignore files found in the current directory and in parents but not outside
/// the current git repository
///
/// Deeper file have a bigger priority.
/// .ignore files have a bigger priority than .gitignore files.
pub fn deeper_chain(
&mut self,
parent_chain: &IgnoreChain,
dir: &Path,
) -> IgnoreChain {
let mut chain = if is_repo(dir) {
let mut chain = IgnoreChain::default();
for &id in &parent_chain.file_ids {
if !self.files[id].local_git_ignore {
chain.file_ids.push(id);
}
}
chain.in_repo = true;
chain
} else {
parent_chain.clone()
};
for (filename, local_git_ignore) in [(".gitignore", true), (".ignore", false)] {
if local_git_ignore && !chain.in_repo {
// we don't add outside .gitignore files when we're in a repo
continue;
}
let ignore_file = dir.join(filename);
if let Ok(gif) = IgnoreFile::new(&ignore_file, dir, local_git_ignore) {
chain.push(self.files.alloc(gif));
}
}
chain
}
/// return true if the given path should not be ignored
pub fn accepts(
&self,
chain: &IgnoreChain,
path: &Path,
filename: &str,
directory: bool,
) -> bool {
// we start with deeper files: deeper rules have a bigger priority
for id in chain.file_ids.iter().rev() {
let file = &self.files[*id];
if file.git && !chain.in_repo {
// git rules are irrelevant outside a git repository
continue;
}
for rule in &file.rules {
if rule.directory && !directory {
continue;
}
let ok = if rule.filename {
rule.pattern.matches_with(filename, rule.pattern_options)
} else {
rule.pattern.matches_path_with(path, rule.pattern_options)
};
if ok {
// as we read the rules in reverse, the first applying is OK
return rule.ok;
}
}
}
true
}
}
pub fn is_repo(root: &Path) -> bool {
root.join(".git").exists()
}