Add option to treat comments as empty space when enforcing rules

Author: David Lomas

lib/rules/multiline-html-element-content-newline.js

@@ -23,7 +23,8 @@ function parseOptions(options) {
     {
       ignores: ['pre', 'textarea', ...INLINE_ELEMENTS],
       ignoreWhenEmpty: true,
-      allowEmptyLines: false
+      allowEmptyLines: false,
+      ignoreComments: false
     },
     options
   )
@@ -80,7 +81,10 @@ module.exports = {
           },
           allowEmptyLines: {
             type: 'boolean'
-          }
+          },
+          ignoreComments: {
+            type: 'boolean'
+          },
         },
         additionalProperties: false
       }
@@ -98,6 +102,7 @@ module.exports = {
     const ignores = options.ignores
     const ignoreWhenEmpty = options.ignoreWhenEmpty
     const allowEmptyLines = options.allowEmptyLines
+    const ignoreComments = options.ignoreComments
     const sourceCode = context.getSourceCode()
     const template =
       sourceCode.parserServices.getTemplateBodyTokenStore &&
@@ -149,7 +154,7 @@ module.exports = {
          * @type {SourceCode.CursorWithCountOptions}
          */
         const getTokenOption = {
-          includeComments: true,
+          includeComments: !ignoreComments,
           filter: (token) => token.type !== 'HTMLWhitespace'
         }
         if (

tests/lib/rules/multiline-html-element-content-newline.js

@@ -170,6 +170,16 @@ tester.run('multiline-html-element-content-newline', rule, {
       options: [{ allowEmptyLines: true }]
     },
 
+    {
+      code: `
+        <template>
+          <div>  <!-- comment -->
+            contents
+          </div>
+        </template>`,
+      options: [{ allowEmptyLines: true, ignoreComments: true }]
+    },
+
     // self closing
     `
       <template>
@@ -611,6 +621,25 @@ content
         'Expected 1 line break before closing tag (`</div>`), but no line breaks found.'
       ]
     },
+    {
+      code: `
+        <template>
+          <div>  <!-- comment -->
+            contents
+          </div>
+        </template>`,
+      output: `
+        <template>
+          <div>
+<!-- comment -->
+            contents
+          </div>
+        </template>`,
+      options: [{ allowEmptyLines: true, ignoreComments: false }],
+      errors: [
+        'Expected 1 line break after opening tag (`<div>`), but no line breaks found.'
+      ]
+    },
     // mustache
     {
       code: `