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

use std::path::PathBuf;
use thiserror::Error;

use crate::parser::error::TowlParserError;

/// Errors from directory traversal and file scanning.
#[derive(Error, Debug)]
pub enum TowlScannerError {
    #[error("Unable to walk file {0}")]
    UnableToWalkFile(#[from] ignore::Error),
    #[error("Parsing error {0}")]
    ParsingError(#[from] TowlParserError),
    #[error("Unable to read file at path {0}: {1}")]
    UnableToReadFileAtPath(PathBuf, tokio::io::Error),
    #[error("Invalid Path. {path}")]
    InvalidPath { path: PathBuf },
    #[error("File too large: {path} ({size} bytes exceeds maximum of {max_allowed} bytes)")]
    FileTooLarge {
        path: PathBuf,
        size: u64,
        max_allowed: u64,
    },
    #[error("Too many TODOs in file: {path} (found {count}, truncated to {max_allowed})")]
    TooManyTodos {
        path: PathBuf,
        count: usize,
        max_allowed: usize,
    },
}