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
29
30
31
32
33

use crate::comment::todo::TodoComment;

/// Maximum file size to scan (10 MB). Larger files are skipped.
pub const MAX_FILE_SIZE: u64 = 10 * 1024 * 1024;
/// Maximum TODOs per file. Files exceeding this are rejected.
pub const MAX_TODO_COUNT: usize = 10_000;
/// Maximum aggregate TODOs across all files. Scanning stops after this limit.
pub const MAX_TOTAL_TODO_COUNT: usize = 100_000;
/// Maximum number of files to discover during directory traversal.
pub const MAX_FILES_SCANNED: usize = 100_000;

/// Structured result from a scan operation, distinguishing "no TODOs found"
/// from "all files failed to scan".
#[derive(Debug)]
pub struct ScanResult {
    pub todos: Vec<TodoComment>,
    pub files_scanned: usize,
    pub files_skipped: usize,
    pub files_errored: usize,
    pub duration: std::time::Duration,
}

impl ScanResult {
    #[must_use]
    pub const fn all_files_failed(&self) -> bool {
        self.files_scanned == 0 && self.files_errored > 0
    }

    #[must_use]
    pub const fn is_clean(&self) -> bool {
        self.todos.is_empty() && self.files_errored == 0
    }
}