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
use super::Context;
use super::LintRule;
use crate::swc_common::comments::Comment;
use crate::swc_common::comments::CommentKind;
use crate::swc_ecma_ast;
use regex::Regex;
pub struct BanUntaggedTodo;
impl BanUntaggedTodo {
fn lint_comment(&self, context: &Context, comment: &Comment) {
if comment.kind != CommentKind::Line {
return;
}
let comment_text = comment.text.to_lowercase().trim_start().to_string();
if !comment_text.starts_with("todo") {
return;
}
let re = Regex::new(r#"todo\((#|@)\S+\)"#).unwrap();
if re.is_match(&comment_text) {
return;
}
context.add_diagnostic(
comment.span,
"ban-untagged-todo",
"TODO should be tagged with (@username) or (#issue)",
);
}
}
impl LintRule for BanUntaggedTodo {
fn new() -> Box<Self> {
Box::new(BanUntaggedTodo)
}
fn code(&self) -> &'static str {
"ban-untagged-todo"
}
fn lint_module(&self, context: Context, _module: swc_ecma_ast::Module) {
context.leading_comments.iter().for_each(|ref_multi| {
for comment in ref_multi.value() {
self.lint_comment(&context, comment);
}
});
context.trailing_comments.iter().for_each(|ref_multi| {
for comment in ref_multi.value() {
self.lint_comment(&context, comment);
}
});
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::test_util::*;
#[test]
fn ban_ts_ignore() {
assert_lint_ok_n::<BanUntaggedTodo>(vec![
r#"
// TODO(#1234)
const b = "b";
"#,
r#"
// TODO(@someusername)
const c = "c";
"#,
]);
assert_lint_err_on_line::<BanUntaggedTodo>(
r#"
// TODO
function foo() {
// pass
}
"#,
2,
0,
);
assert_lint_err_on_line::<BanUntaggedTodo>(
r#"
// TODO(username)
const a = "a";
"#,
2,
0,
);
}
}