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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

use std::fmt;

use secrecy::ExposeSecret;

use super::types::TowlConfig;

fn fmt_list_section(
    f: &mut fmt::Formatter<'_>,
    label: &str,
    items: &[String],
    is_last: bool,
) -> fmt::Result {
    let branch = if is_last {
        "│  └─"
    } else {
        "│  ├─"
    };
    writeln!(f, "{branch} {label}:")?;
    let (mid, end) = if is_last {
        ("│     ├─", "│     └─")
    } else {
        ("│  │  ├─", "│  │  └─")
    };
    for (i, item) in items.iter().enumerate() {
        let prefix = if i == items.len() - 1 { end } else { mid };
        writeln!(f, "{prefix} {item}")?;
    }
    Ok(())
}

impl fmt::Display for TowlConfig {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        writeln!(f, "Towl Configuration")?;
        writeln!(f, "┌─ Parsing")?;
        let mut sorted_extensions: Vec<_> = self.parsing.file_extensions.iter().collect();
        sorted_extensions.sort();
        writeln!(
            f,
            "│  ├─ File Extensions: {}",
            sorted_extensions
                .iter()
                .map(|s| s.as_str())
                .collect::<Vec<_>>()
                .join(", ")
        )?;
        writeln!(
            f,
            "│  ├─ Exclude Patterns: {}",
            self.parsing.exclude_patterns.join(", ")
        )?;
        writeln!(
            f,
            "│  ├─ Context Lines: {}",
            self.parsing.include_context_lines
        )?;
        fmt_list_section(f, "Comment Prefixes", &self.parsing.comment_prefixes, false)?;
        fmt_list_section(f, "TODO Patterns", &self.parsing.todo_patterns, false)?;
        fmt_list_section(
            f,
            "Function Patterns",
            &self.parsing.function_patterns,
            true,
        )?;
        writeln!(f, "└─ GitHub")?;
        writeln!(f, "   ├─ Owner: {}", self.github.owner)?;
        writeln!(f, "   ├─ Repo: {}", self.github.repo)?;
        writeln!(
            f,
            "   ├─ Token: {}",
            if self.github.token.expose_secret().is_empty() {
                "not set"
            } else {
                "configured"
            }
        )?;
        write!(
            f,
            "   └─ Rate Limit Delay: {}ms",
            self.github.rate_limit_delay_ms
        )
    }
}