nolo 0.1.1

A CLI tool for discovering and analyzing `TODO` comments across codebases.
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

mod common;

use insta::assert_debug_snapshot;
use nolo::comment::extract_todo_comments_with_language_detection;

#[test]
fn extract_rust_todo_comments() {
    let fixture = common::fixture_path("rust_basic.rs");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    assert_debug_snapshot!(todos);
}

#[test]
fn extract_python_todo_comments() {
    let fixture = common::fixture_path("python_basic.py");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    assert_debug_snapshot!(todos);
}

#[test]
fn ignore_unknown_keywords() {
    let fixture = common::fixture_path("custom_keywords.js");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    assert_debug_snapshot!(todos);
}

#[test]
fn handle_files_with_no_todos() {
    let fixture = common::fixture_path("no_todos.rs");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    assert_debug_snapshot!(todos);
}

#[test]
fn handle_empty_files() {
    let fixture = common::fixture_path("empty_file.rs");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    assert_debug_snapshot!(todos);
}

#[test]
fn prevent_false_positives() {
    let fixture = common::fixture_path("false_positives.rs");
    let keywords = vec![
        "TODO".to_string(),
        "FIXME".to_string(),
        "NOTE".to_string(),
        "HACK".to_string(),
        "BUG".to_string(),
    ];
    let todos = extract_todo_comments_with_language_detection(fixture, &keywords);
    // Should be empty - no false positives from "debugger", "buggy", "notebook", etc.
    assert_debug_snapshot!(todos);
}