Add full file support for ignoring rules by comment

Author: emilgoldsmith

src/parsers/index.js

@@ -9,13 +9,15 @@ const isStyledImport = require('../utils/styled').isStyledImport
 const wrapSelector = require('../utils/general').wrapSelector
 const wrapKeyframes = require('../utils/general').wrapKeyframes
 const fixIndentation = require('../utils/general').fixIndentation
+const isStylelintComment = require('../utils/general').isStylelintComment
 
 const getTTLContent = require('../utils/tagged-template-literal.js').getTaggedTemplateLiteralContent
 const parseImports = require('../utils/parse').parseImports
 const getSourceMap = require('../utils/parse').getSourceMap
 
 const processStyledComponentsFile = ast => {
   const extractedCSS = []
+  let ignoreRuleComments = []
   let importedNames = {
     default: 'styled',
     css: 'css',
@@ -26,6 +28,13 @@ const processStyledComponentsFile = ast => {
   traverse(ast, {
     noScope: true,
     enter({ node }) {
+      if (node.type !== 'Program' && node.leadingComments) {
+        node.leadingComments.forEach(comment => {
+          if (isStylelintComment(comment.value)) {
+            ignoreRuleComments.push(`/*${comment.value}*/`)
+          }
+        })
+      }
       if (isStyledImport(node)) {
         importedNames = parseImports(node)
         return
@@ -36,11 +45,20 @@ const processStyledComponentsFile = ast => {
       const fixedContent = fixIndentation(content).text
       const wrapperFn = helper === 'keyframes' ? wrapKeyframes : wrapSelector
       const wrappedContent = wrapperFn(fixedContent)
-      extractedCSS.push(wrappedContent)
+      const stylelintCommentsAdded =
+        ignoreRuleComments.length > 0
+          ? `${ignoreRuleComments.join('\n')}\n${wrappedContent}`
+          : wrappedContent
+      extractedCSS.push(stylelintCommentsAdded)
       sourceMap = Object.assign(
         sourceMap,
         getSourceMap(extractedCSS.join('\n'), wrappedContent, node.loc.start.line)
       )
+      /**
+       * All queued comments have been added to the file so we don't need to, and actually shouldn't
+       * add them to the file more than once
+       */
+      ignoreRuleComments = []
     }
   })
 

src/utils/general.js

@@ -68,8 +68,11 @@ const isEmptyOrSpaceOnly = text => {
 const wrapSelector = content => `.selector${(count += 1)} {${content}}\n`
 const wrapKeyframes = content => `@keyframes {${content}}\n`
 
+const isStylelintComment = comment => /^\s*stylelint-(?:enable|disable)(?:\s.*)?$/.test(comment)
+
 exports.wrapKeyframes = wrapKeyframes
 exports.wrapSelector = wrapSelector
 exports.fixIndentation = fixIndentation
 exports.isLastLineWhitespaceOnly = isLastLineWhitespaceOnly
 exports.isEmptyOrSpaceOnly = isEmptyOrSpaceOnly
+exports.isStylelintComment = isStylelintComment