fix: crash with template expression in no-trailing-spaces (#337)

* fix: crash with template expression in no-trailing-spaces

* Update no-trailing-spaces.test.js

Author: yeonjuan

packages/eslint-plugin/lib/rules/no-trailing-spaces.js

@@ -44,29 +44,32 @@ module.exports = {
     /**
      * @param {string} source
      * @param {string[]} lines
-     * @param {number} rangeOffset
+     * @param {Object} offset
+     * @param {number} offset.range
+     * @param {number} offset.line
+     * @param {number} offset.column
      * @param {((CommentContent | Text)['parts'][number])[]} tokens
      */
-    function check(source, lines, rangeOffset, tokens) {
-      let rangeIndex = rangeOffset;
+    function check(source, lines, offset, tokens) {
       const lineBreaks = source.match(/\r\n|[\r\n\u2028\u2029]/gu);
+
       lines.forEach((line, index) => {
-        const lineNumber = index + 1;
+        const lineNumber = index + offset.line;
         const match = line.match(/[ \t\u00a0\u2000-\u200b\u3000]+$/);
         const lineBreakLength =
           lineBreaks && lineBreaks[index] ? lineBreaks[index].length : 1;
         const lineLength = line.length + lineBreakLength;
-
+        const columnOffset = index === 0 ? offset.column : 0;
         if (match) {
           if (typeof match.index === "number" && match.index > 0) {
             const loc = {
               start: {
                 line: lineNumber,
-                column: match.index,
+                column: match.index + columnOffset,
               },
               end: {
                 line: lineNumber,
-                column: lineLength - lineBreakLength,
+                column: lineLength - lineBreakLength + columnOffset,
               },
             };
             const start = sourceCode.getIndexFromLoc(loc.start);
@@ -80,21 +83,26 @@ module.exports = {
               messageId: MESSAGE_IDS.TRAILING_SPACE,
               loc,
               fix(fixer) {
-                return fixer.removeRange([
-                  rangeIndex + loc.start.column,
-                  rangeIndex + loc.end.column,
-                ]);
+                return fixer.removeRange([start, end]);
               },
             });
           }
         }
-        rangeIndex += lineLength;
       });
     }
 
     return {
       Document() {
-        check(sourceCode.getText(), sourceCode.getLines(), 0, []);
+        check(
+          sourceCode.getText(),
+          sourceCode.getLines(),
+          {
+            range: 0,
+            line: 1,
+            column: 0,
+          },
+          []
+        );
       },
       TaggedTemplateExpression(node) {
         if (shouldCheckTaggedTemplateExpression(node, context)) {
@@ -107,8 +115,11 @@ module.exports = {
           check(
             html,
             lines,
-            // @ts-ignore
-            node.quasi.range[0] + 1,
+            {
+              range: node.quasi.range[0] + 1,
+              line: node.quasi.loc.start.line,
+              column: node.quasi.loc.start.column + 1,
+            },
             getTemplateTokens(tokens)
           );
         }
@@ -120,8 +131,11 @@ module.exports = {
           check(
             html,
             lines,
-            // @ts-ignore
-            node.range[0] + 1,
+            {
+              range: node.range[0] + 1,
+              line: node.loc.start.line,
+              column: node.loc.start.column + 1,
+            },
             getTemplateTokens(tokens)
           );
         }

packages/eslint-plugin/tests/rules/no-trailing-spaces.test.js

@@ -26,6 +26,9 @@ ruleTester.run("no-tailing-spaces", rule, {
       errors: [
         {
           messageId: "trailingSpace",
+          column: 12,
+          endColumn: 14,
+          line: 1,
         },
       ],
     },
@@ -35,6 +38,9 @@ ruleTester.run("no-tailing-spaces", rule, {
       errors: [
         {
           messageId: "trailingSpace",
+          column: 12,
+          endColumn: 14,
+          line: 1,
         },
       ],
     },
@@ -44,6 +50,9 @@ ruleTester.run("no-tailing-spaces", rule, {
       errors: [
         {
           messageId: "trailingSpace",
+          column: 6,
+          endColumn: 8,
+          line: 1,
         },
       ],
     },
@@ -77,6 +86,94 @@ templateRuleTester.run("[template] no-tailing-spaces", rule, {
       })()}
 </div>\``,
     },
+    {
+      code: `html\`<div>
+      \${(() => {
+    
+      })()      }
+</div>\``,
+    },
+    {
+      code: `  
+html\`<div>
+</div>\``,
+    },
+  ],
+  invalid: [
+    {
+      code: `  
+html\`<div>  
+</div>\``,
+      output: `  
+html\`<div>
+</div>\``,
+      errors: [
+        {
+          messageId: "trailingSpace",
+        },
+      ],
+    },
+    {
+      code: "html`<div>  \n  text\n  </div>`",
+      output: "html`<div>\n  text\n  </div>`",
+      errors: [
+        {
+          messageId: "trailingSpace",
+          line: 1,
+          column: 11,
+          endColumn: 13,
+        },
+      ],
+    },
+    {
+      code: "html`<div>\n  text\n  </div>   `",
+      output: "html`<div>\n  text\n  </div>`",
+      errors: [
+        {
+          messageId: "trailingSpace",
+          line: 3,
+          column: 9,
+          endColumn: 12,
+        },
+      ],
+    },
+    {
+      code: `html\`<div id=\${foo}   
+>
+text
+</div>\``,
+      output: `html\`<div id=\${foo}
+>
+text
+</div>\``,
+      errors: [
+        {
+          messageId: "trailingSpace",
+          line: 1,
+          column: 20,
+          endColumn: 23,
+        },
+      ],
+    },
+    {
+      code: `
+html\`<div id=\${foo}   
+>
+text
+</div>\``,
+      output: `
+html\`<div id=\${foo}
+>
+text
+</div>\``,
+      errors: [
+        {
+          messageId: "trailingSpace",
+          line: 2,
+          column: 20,
+          endColumn: 23,
+        },
+      ],
+    },
   ],
-  invalid: [],
 });