towl 0.3.7

A fast CLI tool to scan codebases for TODO comments and output them in multiple formats
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

use std::path::Path;

use ignore::{overrides::OverrideBuilder, WalkBuilder};

use super::error::TowlScannerError;
use super::types::Scanner;

impl Scanner {
    /// See: <https://github.com/glottologist/towl/issues/7>
    ///
    /// # Errors
    /// Returns `TowlScannerError::UnableToWalkFile` if exclude patterns are invalid.
    pub(super) fn build_walker(&self, path: &Path) -> Result<ignore::Walk, TowlScannerError> {
        let mut builder = WalkBuilder::new(path);
        builder.hidden(false).git_ignore(false).follow_links(false);

        if !self.config.exclude_patterns.is_empty() {
            let mut overrides = OverrideBuilder::new(path);
            overrides.add("**")?;
            for pattern in &self.config.exclude_patterns {
                overrides.add(&format!("!{pattern}"))?;
            }
            builder.overrides(overrides.build()?);
        }

        Ok(builder.build())
    }
}