forked from eslint/eslint
/
no-warning-comments.js
249 lines (243 loc) · 10.6 KB
/
no-warning-comments.js
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
/**
* @fileoverview Tests for no-warning-comments rule.
* @author Alexander Schmidt <https://github.com/lxanders>
*/
"use strict";
//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------
const rule = require("../../../lib/rules/no-warning-comments"),
{ RuleTester } = require("../../../lib/rule-tester");
//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------
const ruleTester = new RuleTester();
ruleTester.run("no-warning-comments", rule, {
valid: [
{ code: "// any comment", options: [{ terms: ["fixme"] }] },
{ code: "// any comment", options: [{ terms: ["fixme", "todo"] }] },
"// any comment",
{ code: "// any comment", options: [{ location: "anywhere" }] },
{ code: "// any comment with TODO, FIXME or XXX", options: [{ location: "start" }] },
"// any comment with TODO, FIXME or XXX",
{ code: "/* any block comment */", options: [{ terms: ["fixme"] }] },
{ code: "/* any block comment */", options: [{ terms: ["fixme", "todo"] }] },
"/* any block comment */",
{ code: "/* any block comment */", options: [{ location: "anywhere" }] },
{ code: "/* any block comment with TODO, FIXME or XXX */", options: [{ location: "start" }] },
"/* any block comment with TODO, FIXME or XXX */",
"/* any block comment with (TODO, FIXME's or XXX!) */",
{ code: "// comments containing terms as substrings like TodoMVC", options: [{ terms: ["todo"], location: "anywhere" }] },
{ code: "// special regex characters don't cause problems", options: [{ terms: ["[aeiou]"], location: "anywhere" }] },
"/*eslint no-warning-comments: [2, { \"terms\": [\"todo\", \"fixme\", \"any other term\"], \"location\": \"anywhere\" }]*/\n\nvar x = 10;\n",
{ code: "/*eslint no-warning-comments: [2, { \"terms\": [\"todo\", \"fixme\", \"any other term\"], \"location\": \"anywhere\" }]*/\n\nvar x = 10;\n", options: [{ location: "anywhere" }] },
{ code: "foo", options: [{ terms: ["foo-bar"] }] }
],
invalid: [
{
code: "// fixme",
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "fixme" } }
]
},
{
code: "// any fixme",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme" } }
]
},
{
code: "// any fixme",
options: [{ terms: ["fixme"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme" } }
]
},
{
code: "// any FIXME",
options: [{ terms: ["fixme"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any FIXME" } }
]
},
{
code: "// any fIxMe",
options: [{ terms: ["fixme"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fIxMe" } }
]
},
{
code: "/* any fixme */",
options: [{ terms: ["FIXME"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "FIXME", comment: "any fixme" } }
]
},
{
code: "/* any FIXME */",
options: [{ terms: ["FIXME"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "FIXME", comment: "any FIXME" } }
]
},
{
code: "/* any fIxMe */",
options: [{ terms: ["FIXME"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "FIXME", comment: "any fIxMe" } }
]
},
{
code: "// any fixme or todo",
options: [{ terms: ["fixme", "todo"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme or todo" } },
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any fixme or todo" } }
]
},
{
code: "/* any fixme or todo */",
options: [{ terms: ["fixme", "todo"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme or todo" } },
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any fixme or todo" } }
]
},
{
code: "/* any fixme or todo */",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any fixme or todo" } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme or todo" } }
]
},
{
code: "/* fixme and todo */",
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "fixme and todo" } }
]
},
{
code: "/* fixme and todo */",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "fixme and todo" } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "fixme and todo" } }
]
},
{
code: "/* any fixme */",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any fixme" } }
]
},
{
code: "/* fixme! */",
options: [{ terms: ["fixme"] }],
errors: [
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "fixme!" } }
]
},
{
code: "// regex [litera|$]",
options: [{ terms: ["[litera|$]"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "[litera|$]", comment: "regex [litera|$]" } }
]
},
{
code: "/* eslint one-var: 2 */",
options: [{ terms: ["eslint"] }],
errors: [
{ messageId: "unexpectedComment", data: { type: "eslint", comment: "eslint one-var: 2" } }
]
},
{
code: "/* eslint one-var: 2 */",
options: [{ terms: ["one"], location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "one", comment: "eslint one-var: 2" } }
]
},
{
code: "/* any block comment with TODO, FIXME or XXX */",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any block comment with TODO, FIXME or..." } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any block comment with TODO, FIXME or..." } },
{ messageId: "unexpectedComment", data: { type: "xxx", comment: "any block comment with TODO, FIXME or..." } }
]
},
{
code: "/* any block comment with (TODO, FIXME's or XXX!) */",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any block comment with (TODO, FIXME's or..." } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any block comment with (TODO, FIXME's or..." } },
{ messageId: "unexpectedComment", data: { type: "xxx", comment: "any block comment with (TODO, FIXME's or..." } }
]
},
{
code: "/** \n *any block comment \n*with (TODO, FIXME's or XXX!) **/",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "* *any block comment *with (TODO,..." } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "* *any block comment *with (TODO,..." } },
{ messageId: "unexpectedComment", data: { type: "xxx", comment: "* *any block comment *with (TODO,..." } }
]
},
{
code: "// any comment with TODO, FIXME or XXX",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "any comment with TODO, FIXME or XXX" } },
{ messageId: "unexpectedComment", data: { type: "fixme", comment: "any comment with TODO, FIXME or XXX" } },
{ messageId: "unexpectedComment", data: { type: "xxx", comment: "any comment with TODO, FIXME or XXX" } }
]
},
{
code: "// TODO: something small",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "TODO: something small" } }
]
},
{
code: "// TODO: something really longer than 40 characters",
options: [{ location: "anywhere" }],
errors: [
{ messageId: "unexpectedComment", data: { type: "todo", comment: "TODO: something really longer than 40..." } }
]
},
{
code:
"/* TODO: something \n really longer than 40 characters \n and also a new line */",
options: [{ location: "anywhere" }],
errors: [
{
messageId: "unexpectedComment",
data: {
type: "todo",
comment: "TODO: something really longer than 40..."
}
}
]
},
{
code: "// TODO: small",
options: [{ location: "anywhere" }],
errors: [
{
messageId: "unexpectedComment",
data: {
type: "todo",
comment: "TODO: small"
}
}
]
}
]
});