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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185

use assert_cmd::Command;
use predicates::prelude::*;
use rstest::*;
use std::fs;
use tempfile::TempDir;

#[fixture]
fn test_project() -> TempDir {
    let temp_dir = TempDir::new().expect("Failed to create temp directory");

    // Create test files with TODO comments
    let rust_file = temp_dir.path().join("test.rs");
    fs::write(
        &rust_file,
        r#"
// TODO: implement this function
fn example() {
    // FIXME: handle error case
    println!("test");
    // HACK: temporary workaround
}
"#,
    )
    .expect("Failed to write test file");

    let js_file = temp_dir.path().join("test.js");
    fs::write(
        &js_file,
        r#"
// TODO: add validation
function test() {
    // NOTE: this is important
    console.log("test");
}
"#,
    )
    .expect("Failed to write test file");

    temp_dir
}

#[rstest]
fn test_scan_command_basic(test_project: TempDir) {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--format")
        .arg("terminal");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains("implement this func"))
        .stdout(predicate::str::contains("handle error case"));
}

#[rstest]
fn test_scan_table_format(test_project: TempDir) {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--format")
        .arg("table");

    cmd.assert().success();
}

#[rstest]
#[case("json", "json")]
#[case("csv", "csv")]
#[case("markdown", "md")]
#[case("toml", "toml")]
fn test_scan_file_output_formats(
    test_project: TempDir,
    #[case] format: &str,
    #[case] extension: &str,
) {
    let output_file = test_project.path().join(format!("output.{extension}"));

    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.current_dir(test_project.path())
        .arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--format")
        .arg(format)
        .arg("--output")
        .arg(&output_file);

    cmd.assert().success();
    assert!(output_file.exists());
}

#[rstest]
#[case("todo", "implement this func", "handle error case")]
#[case("fixme", "handle error case", "implement this func")]
#[case("hack", "temporary workaround", "implement this func")]
fn test_todo_type_filtering(
    test_project: TempDir,
    #[case] todo_type: &str,
    #[case] should_contain: &str,
    #[case] should_not_contain: &str,
) {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--todo-type")
        .arg(todo_type)
        .arg("--format")
        .arg("terminal");

    cmd.assert()
        .success()
        .stdout(predicate::str::contains(should_contain))
        .stdout(predicate::str::contains(should_not_contain).not());
}

#[rstest]
fn test_verbose_flag(test_project: TempDir) {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--verbose")
        .arg("--format")
        .arg("terminal");

    cmd.assert()
        .success()
        .stderr(predicate::str::contains("Found"))
        .stderr(predicate::str::contains("TODO comments"));
}

#[rstest]
fn test_init_command() {
    let temp_dir = TempDir::new().expect("Failed to create temp directory");
    let config_path = temp_dir.path().join("towl.toml");

    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("init").arg("--path").arg(&config_path);

    cmd.assert()
        .success()
        .stderr(predicate::str::contains("Initialized config file"));

    assert!(config_path.exists());
}

#[rstest]
fn test_config_command() {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("config");

    cmd.assert()
        .success()
        .stderr(predicate::str::contains("Towl Configuration"));
}

#[rstest]
fn test_nonexistent_path() {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg("/nonexistent/path")
        .arg("--non-interactive")
        .arg("--format")
        .arg("terminal");

    cmd.assert().failure().code(1);
}

#[rstest]
fn test_invalid_todo_type(test_project: TempDir) {
    let mut cmd = Command::cargo_bin("towl").unwrap();
    cmd.arg("scan")
        .arg(test_project.path())
        .arg("--non-interactive")
        .arg("--todo-type")
        .arg("INVALID_TYPE")
        .arg("--format")
        .arg("terminal");

    cmd.assert().failure();
}