rusty-todo-md 1.9.1

A multi-language TODO comment extractor for source code files.
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

// =======================
// 🦀 Rust Comment Parser
// =======================

// The entire Rust file consists of sequences of comments, code, and string literals.
rust_file = { SOI ~ (comment | str_literal | any_non_comment)* ~ EOI }

// =======================
// 📌 Regular Comments
// =======================

// Single-line comments: matches lines starting with "//" and continuing until a newline.
line_comment = @{
    "//" ~ (!NEWLINE ~ ANY)*
}

// Block comments: matches C-style block comments "/* ... */".
block_comment = @{
    "/*" ~ (!"*/" ~ ANY)* ~ "*/"
}

// Doc comments: matches both "///" (line doc) and "//!" (inner doc) comments.
doc_comment = @{
    "///" ~ (!NEWLINE ~ ANY)* |
    "//!" ~ (!NEWLINE ~ ANY)*
}

// =======================
// General Comments
// =======================

// Collect all kinds of comments (regular line, block, and doc comments).
comment = { line_comment | block_comment | doc_comment }

// =======================
// 🚫 Ignoring String Literals
// =======================

// Matches string literals to avoid extracting comments inside strings.
str_literal = _{
    "\"" ~ (!"\"" ~ ANY)* ~ "\"" |
    "'" ~ (!"'" ~ ANY)* ~ "'"
}

// =======================
// ❌ Any Other Non-Comment Code
// =======================

// Matches anything that is NOT a comment or a string literal.
any_non_comment = { !(comment | str_literal) ~ ANY }