Initial commit

This commit is contained in:
Patrick Marsceill
2017-03-09 13:16:08 -05:00
commit b7b0d0d7bf
4147 changed files with 401224 additions and 0 deletions

View File

@@ -0,0 +1,43 @@
# comment-word-blacklist
Specify a blacklist of disallowed words within comments.
```css
/* words within comments */
/** ↑ ↑ ↑
* These three words */
```
**Caveat:** Comments within *selector and value lists* are currently ignored.
## Options
`array|string`: `["array", "of", "words", "or", "/regex/"]|"word"|"/regex/"`
If a string is surrounded with `"/"` (e.g. `"/^TODO:/"`), it is interpreted as a regular expression.
Given:
```js
["/^TODO:/", "badword"]
```
The following patterns are considered warnings:
```css
/* TODO: */
```
```css
/* TODO: add fallback */
```
```css
/* some badword */
```
The following patterns are *not* considered warnings:
```css
/* comment */
```

View File

@@ -0,0 +1,56 @@
"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],
})
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