sqruff-lib 0.39.0

A high-speed SQL linter.
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

use ignore::gitignore::Gitignore;
use std::path::Path;

/// The name of the ignore file that sqruff will look for in the root of the project and use to
/// determine which files to ignore.
const IGNORE_FILE_NAME: &str = ".sqruffignore";

pub struct IgnoreFile {
    ignore: Gitignore,
}

impl IgnoreFile {
    /// Create a new instance of `IgnoreFile` from the root of the project.
    pub fn new_from_root(root: &Path) -> Result<Self, String> {
        let ignore_file = root.join(IGNORE_FILE_NAME);
        if ignore_file.exists() {
            let ignore = Gitignore::new(ignore_file);
            match ignore {
                (ignore, None) => Ok(IgnoreFile { ignore }),
                (_, Some(err)) => Err(err.to_string()),
            }
        } else {
            Ok(Self::empty())
        }
    }

    pub fn empty() -> Self {
        Self {
            ignore: Gitignore::empty(),
        }
    }

    /// Check if the given path should be ignored.
    pub fn is_ignored(&self, path: &Path) -> bool {
        let is_dir = path.is_dir();
        let match_result = self.ignore.matched(path, is_dir);
        let is_ignored = match_result.is_ignore();

        if is_ignored {
            let path_type = if is_dir { "directory" } else { "file" };
            log::debug!(
                "Ignoring {} '{}' due to ignore pattern",
                path_type,
                path.display()
            );

            if let Some(pattern) = match_result.inner() {
                log::debug!("Matched ignore pattern: '{}'", pattern.original());
            }
        }

        is_ignored
    }
}