| "use strict"; |
| |
| const _ = require("lodash"); |
| const containsString = require("../../utils/containsString"); |
| const matchesStringOrRegExp = require("../../utils/matchesStringOrRegExp"); |
| const report = require("../../utils/report"); |
| const ruleMessages = require("../../utils/ruleMessages"); |
| const validateOptions = require("../../utils/validateOptions"); |
| |
| const ruleName = "comment-word-blacklist"; |
| |
| const messages = ruleMessages(ruleName, { |
| rejected: pattern => `Unexpected word matching pattern "${pattern}"` |
| }); |
| |
| const rule = function(blacklist) { |
| return (root, result) => { |
| const validOptions = validateOptions(result, ruleName, { |
| actual: blacklist, |
| possible: [_.isString, _.isRegExp] |
| }); |
| |
| if (!validOptions) { |
| return; |
| } |
| |
| root.walkComments(comment => { |
| const text = comment.text; |
| const rawComment = comment.toString(); |
| const firstFourChars = rawComment.substr(0, 4); |
| |
| // Return early if sourcemap |
| if (firstFourChars === "/*# ") { |
| return; |
| } |
| |
| const matchesWord = |
| matchesStringOrRegExp(text, blacklist) || |
| containsString(text, blacklist); |
| |
| if (!matchesWord) { |
| return; |
| } |
| |
| report({ |
| message: messages.rejected(matchesWord.pattern), |
| node: comment, |
| result, |
| ruleName |
| }); |
| }); |
| }; |
| }; |
| |
| rule.primaryOptionArray = true; |
| |
| rule.ruleName = ruleName; |
| rule.messages = messages; |
| module.exports = rule; |