1 |
|
2 |
|
3 | 'use strict';
|
4 |
|
5 | const _ = require('lodash');
|
6 | const containsString = require('../../utils/containsString');
|
7 | const matchesStringOrRegExp = require('../../utils/matchesStringOrRegExp');
|
8 | const report = require('../../utils/report');
|
9 | const ruleMessages = require('../../utils/ruleMessages');
|
10 | const validateOptions = require('../../utils/validateOptions');
|
11 |
|
12 | const ruleName = 'comment-word-blacklist';
|
13 |
|
14 | const messages = ruleMessages(ruleName, {
|
15 | rejected: (pattern) => `Unexpected word matching pattern "${pattern}"`,
|
16 | });
|
17 |
|
18 | function rule(blacklist) {
|
19 | return (root, result) => {
|
20 | const validOptions = validateOptions(result, ruleName, {
|
21 | actual: blacklist,
|
22 | possible: [_.isString, _.isRegExp],
|
23 | });
|
24 |
|
25 | if (!validOptions) {
|
26 | return;
|
27 | }
|
28 |
|
29 | root.walkComments((comment) => {
|
30 | const text = comment.text;
|
31 | const rawComment = comment.toString();
|
32 | const firstFourChars = rawComment.substr(0, 4);
|
33 |
|
34 |
|
35 | if (firstFourChars === '/*# ') {
|
36 | return;
|
37 | }
|
38 |
|
39 | const matchesWord = matchesStringOrRegExp(text, blacklist) || containsString(text, blacklist);
|
40 |
|
41 | if (!matchesWord) {
|
42 | return;
|
43 | }
|
44 |
|
45 | report({
|
46 | message: messages.rejected(matchesWord.pattern),
|
47 | node: comment,
|
48 | result,
|
49 | ruleName,
|
50 | });
|
51 | });
|
52 | };
|
53 | }
|
54 |
|
55 | rule.primaryOptionArray = true;
|
56 |
|
57 | rule.ruleName = ruleName;
|
58 | rule.messages = messages;
|
59 | module.exports = rule;
|