3 const _ = require("lodash");
4 const containsString = require("../../utils/containsString");
5 const matchesStringOrRegExp = require("../../utils/matchesStringOrRegExp");
6 const report = require("../../utils/report");
7 const ruleMessages = require("../../utils/ruleMessages");
8 const validateOptions = require("../../utils/validateOptions");
10 const ruleName = "comment-word-blacklist";
12 const messages = ruleMessages(ruleName, {
13 rejected: pattern => `Unexpected word matching pattern "${pattern}"`
16 const rule = function(blacklist) {
17 return (root, result) => {
18 const validOptions = validateOptions(result, ruleName, {
20 possible: [_.isString]
26 root.walkComments(comment => {
27 const text = comment.text;
28 const rawComment = comment.toString();
29 const firstFourChars = rawComment.substr(0, 4);
31 // Return early if sourcemap
32 if (firstFourChars === "/*# ") {
37 matchesStringOrRegExp(text, blacklist) ||
38 containsString(text, blacklist);
45 message: messages.rejected(matchesWord.pattern),
54 rule.primaryOptionArray = true;
56 rule.ruleName = ruleName;
57 rule.messages = messages;
58 module.exports = rule;