ignored 0.0.4

A Rust implementation of the .gitignore file format for quickly checking whether a path is ignored by git - without invoking the git cli.
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

use std::{
    io::{BufRead, BufReader},
    path::{Path, PathBuf},
};

use crate::{
    evaluator::{self, File, Glob, Result},
    utils,
};

/// Read a `.gitignore` file at the given path and parse it into a [`crate::evaluator::File`] struct.
///
/// A file contains a checksum (a unique value which can be used to safely identify if the file has changed
/// since last being read) which is useful for caching. It contains a base path, which is the path to which
/// all glob patterns defined inside are relative to (when matching arbitrary paths at runtime).
///
/// When no base path is provided during the reading process (like in the case of all `.gitignore` files), the
/// base path is assumed to be relative to the `.gitignore`. However, when dealing with both global exclude
/// files, and git root exclude files, the base path provided will be the closest git root, not the file itself.
pub fn read_gitignore(
    base_path: Option<impl AsRef<Path>>,
    gitignore_path: impl AsRef<Path>,
) -> Result<File> {
    let base_path = base_path.map_or_else(
        || {
            gitignore_path
                .as_ref()
                .parent()
                .map_or_else(PathBuf::new, Path::to_path_buf)
        },
        |base_path| base_path.as_ref().to_path_buf(),
    );

    let (checksum, file) = utils::compute_checksum(gitignore_path.as_ref()).map_err(|e| {
        evaluator::Error::FileError {
            file: gitignore_path.as_ref().to_path_buf(),
            source: e,
        }
    })?;

    let reader = BufReader::new(file);
    let mut content = Vec::<Glob>::new();

    for line in reader.lines() {
        let line = line.unwrap_or_default();

        let glob = Glob::try_from(line.as_str())?;

        if glob.is_empty() {
            continue;
        }

        content.push(glob);
    }

    Ok(File::new(base_path, content, checksum))
}