mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-09-13 21:33:32 -06:00
Initial commit
This commit is contained in:
43
node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
generated
vendored
Normal file
43
node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
generated
vendored
Normal 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 */
|
||||
```
|
56
node_modules/stylelint/lib/rules/comment-word-blacklist/index.js
generated
vendored
Normal file
56
node_modules/stylelint/lib/rules/comment-word-blacklist/index.js
generated
vendored
Normal 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
|
Reference in New Issue
Block a user