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

pub(crate) mod csv;
pub(crate) mod json;
pub(crate) mod markdown;
pub(crate) mod table;
pub(crate) mod toml;

#[must_use]
pub(crate) const fn pluralize(count: usize) -> &'static str {
    if count == 1 {
        ""
    } else {
        "s"
    }
}

#[cfg(test)]
pub mod test_helpers {
    use crate::comment::todo::test_support::TestTodoBuilder;
    use crate::comment::todo::{TodoComment, TodoType};

    #[must_use]
    pub fn create_test_todo(
        desc: &str,
        todo_type: TodoType,
        function: Option<&str>,
        with_context: bool,
    ) -> TodoComment {
        let mut builder = TestTodoBuilder::new()
            .description(desc)
            .todo_type(todo_type)
            .line_number(42)
            .column_start(1)
            .column_end(20);

        if with_context {
            builder = builder.context_lines(vec![
                "context line 1".to_string(),
                "context line 2".to_string(),
            ]);
        }

        if let Some(f) = function {
            builder = builder.function_context(f);
        }

        builder.build()
    }
}