rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-08-04 21:52:54 +02:00
Code Issues Releases Activity

ignore/gitignore: skip BOM at start of ignore file

Browse Source 
This matches Git's behavior.

Fixes #2177, Closes #2782
This commit is contained in:
Stephen Albert-Moore
2024-04-17 16:58:23 -04:00
committed by Andrew Gallant
parent 57e90533a0
commit ca88b2fd95
4 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
crates/ignore/src/gitignore.rs
View File

@ -402,6 +402,12 @@ impl GitignoreBuilder {
break;
}
};
// Match Git's handling of .gitignore files that begin with the Unicode BOM
const UTF8_BOM: &str = "\u{feff}";
let line =
if i == 0 { line.trim_start_matches(UTF8_BOM) } else { &line };
if let Err(err) = self.add_line(Some(path.to_path_buf()), &line) {
errs.push(err.tagged(path, lineno));
}

2
crates/ignore/tests/gitignore_skip_bom.gitignore Normal file
View File

@ -0,0 +1,2 @@
ignore/this/path
# This file begins with a BOM (U+FEFF)

17
crates/ignore/tests/gitignore_skip_bom.rs Normal file
View File

@ -0,0 +1,17 @@
use ignore::gitignore::GitignoreBuilder;
const IGNORE_FILE: &'static str = "tests/gitignore_skip_bom.gitignore";
/// Skip a Byte-Order Mark (BOM) at the beginning of the file, matching Git's
/// behavior.
///
/// Ref: <https://github.com/BurntSushi/ripgrep/issues/2177>
#[test]
fn gitignore_skip_bom() {
let mut builder = GitignoreBuilder::new("ROOT");
let error = builder.add(IGNORE_FILE);
assert!(error.is_none(), "failed to open gitignore file");
let g = builder.build().unwrap();
assert!(g.matched("ignore/this/path", false).is_ignore());
}