Initial commit

node_modules/stylelint/lib/rules/stylelint-disable-reason/index.js

@@ -0,0 +1,93 @@
+"use strict"
+
+const report = require("../../utils/report")
+const ruleMessages = require("../../utils/ruleMessages")
+const validateOptions = require("../../utils/validateOptions")
+
+const ruleName = "stylelint-disable-reason"
+
+const messages = ruleMessages(ruleName, {
+  expectedBefore: "Expected comment reason before `stylelint-disable` comment",
+  expectedAfter: "Expected comment reason after `stylelint-disable` comment",
+})
+
+const stylelintDisableCommand = "stylelint-disable"
+const stylelintDisableLineCommand = "stylelint-disable-line"
+
+const rule = function (expectation) {
+  return function (root, result) {
+    const validOptions = validateOptions(result, ruleName, {
+      actual: expectation,
+      possible: [
+        "always-before",
+        "always-after",
+      ],
+    })
+    if (!validOptions) {
+      return
+    }
+
+    result.warn((
+      `'${ruleName}' has been deprecated and in 8.0 will be removed.`
+    ), {
+      stylelintType: "deprecation",
+      stylelintReference: `https://stylelint.io/user-guide/rules/${ruleName}/`,
+    })
+
+    root.walkComments(function (comment) {
+      if (comment.text.indexOf(stylelintDisableCommand) !== 0) {
+        return
+      }
+
+      if (expectation === "always-before") {
+        const prev = comment.prev()
+        const prevIsCommentAndValid = prev && prev.type === "comment" && !isDisableCommand(prev.text)
+
+        let prevDisableLineIsCommentAndValid = false
+
+        if (comment.text.indexOf(stylelintDisableLineCommand) === 0 && !prevIsCommentAndValid && prev) {
+          const friendlyPrev = prev.prev()
+
+          prevDisableLineIsCommentAndValid = friendlyPrev && friendlyPrev.type === "comment" && !isDisableCommand(friendlyPrev.text)
+        }
+
+        if (!prevIsCommentAndValid && !prevDisableLineIsCommentAndValid) {
+          const disabledRanges = result.stylelint.disabledRanges
+          result.stylelint.disabledRanges = false
+
+          report({
+            message: messages.expectedBefore,
+            node: comment,
+            result,
+            ruleName,
+          })
+          result.stylelint.disabledRanges = disabledRanges
+        }
+      } else if (expectation === "always-after") {
+        const next = comment.next()
+        const nextIsCommentAndValid = next && next.type === "comment" && !isDisableCommand(next.text)
+
+        if (!nextIsCommentAndValid) {
+          const disabledRanges = result.stylelint.disabledRanges
+          result.stylelint.disabledRanges = false
+
+          report({
+            message: messages.expectedAfter,
+            node: comment,
+            result,
+            ruleName,
+          })
+          result.stylelint.disabledRanges = disabledRanges
+        }
+      }
+    })
+
+    function isDisableCommand(text) {
+      return text.indexOf(stylelintDisableCommand) === 0
+    }
+  }
+}
+
+rule.ruleName = ruleName
+rule.messages = messages
+module.exports = rule