ignored 0.0.2

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

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

use thiserror::Error;

use crate::lexer;

/// Errors that can occur during evaluation of `.gitignore` files
/// and patterns.
#[derive(Debug, Error)]
pub enum Error {
    /// A pattern contained inside a `.gitignore` file was not valid syntactically.
    #[error("Invalid pattern: {pattern}")]
    InvalidPattern {
        /// The pattern that was invalid.
        pattern: String,

        /// The underlying error from the lexer (if available).
        source: Option<lexer::Error>,
    },
    /// A pattern contained inside a `.gitignore` file did not compile to a valid
    /// regular expression, and therefore could not be evaluated.
    #[error("Pattern ({pattern}) did not compile to a valid regular expression: {source}")]
    InvalidRegex {
        /// The pattern used to create the regular expression.
        pattern: String,

        /// The regex expression that was invalid.
        regex: String,

        /// The underlying error from the regex compiler.
        source: regex::Error,
    },
    /// An error occurred while trying to read a `.gitignore` file because the file cache which
    /// stores the contents of previously read files is poisoned.
    #[error("Unable to read gitignore file, as the underlying file cache is poisoned: {0}")]
    CachePoisoned(PathBuf),

    /// An error occurred while trying to read a `.gitignore` file.
    #[error("Unable to read {file}: {source}")]
    FileError {
        /// The path to the `.gitignore` file that could not be read.
        file: PathBuf,

        /// The underlying error from the filesystem.
        source: io::Error,
    },
}