fix(check-alignment, check-indentation, newline-after-description): report error line numbers

Author: brettz9

src/rules/checkAlignment.js

@@ -31,12 +31,17 @@ export default iterateJsdoc(({
     return fixer.replaceText(jsdocNode, replacement);
   };
 
-  for (const line of sourceLines) {
+  sourceLines.some((line, lineNum) => {
     if (line.length !== indentLevel) {
-      report('Expected JSDoc block to be aligned.', fix);
-      break;
+      report('Expected JSDoc block to be aligned.', fix, {
+        line: lineNum + 1
+      });
+
+      return true;
     }
-  }
+
+    return false;
+  });
 }, {
   iterateAllJsdocs: true,
   meta: {

src/rules/checkIndentation.js

@@ -5,11 +5,14 @@ export default iterateJsdoc(({
   jsdocNode,
   report
 }) => {
-  const reg = new RegExp(/^[ \t]+\*[ \t]{2}/m);
+  const reg = new RegExp(/^[ \t]+\*[ \t]{2}/gm);
   const text = sourceCode.getText(jsdocNode);
 
   if (reg.test(text)) {
-    report('There must be no indentation.');
+    const lineBreaks = text.slice(0, reg.lastIndex).match(/\n/g) || [];
+    report('There must be no indentation.', null, {
+      line: lineBreaks.length
+    });
   }
 }, {
   iterateAllJsdocs: true,

src/rules/newlineAfterDescription.js

@@ -28,29 +28,31 @@ export default iterateJsdoc(({
 
   if (always) {
     if (!descriptionEndsWithANewline) {
+      const sourceLines = sourceCode.getText(jsdocNode).split('\n');
+      const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
+        return line.includes(_.last(jsdoc.description.split('\n')));
+      });
       report('There must be a newline after the description of the JSDoc block.', (fixer) => {
-        const sourceLines = sourceCode.getText(jsdocNode).split('\n');
-        const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
-          return line.includes(_.last(jsdoc.description.split('\n')));
-        });
-
         // Add the new line
         sourceLines.splice(lastDescriptionLine + 1, 0, `${indent} *`);
 
         return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
+      }, {
+        line: lastDescriptionLine
       });
     }
   } else if (descriptionEndsWithANewline) {
+    const sourceLines = sourceCode.getText(jsdocNode).split('\n');
+    const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
+      return line.includes(_.last(jsdoc.description.split('\n')));
+    });
     report('There must be no newline after the description of the JSDoc block.', (fixer) => {
-      const sourceLines = sourceCode.getText(jsdocNode).split('\n');
-      const lastDescriptionLine = _.findLastIndex(sourceLines, (line) => {
-        return line.includes(_.last(jsdoc.description.split('\n')));
-      });
-
       // Remove the extra line
       sourceLines.splice(lastDescriptionLine + 1, 1);
 
       return fixer.replaceText(jsdocNode, sourceLines.join('\n'));
+    }, {
+      line: lastDescriptionLine + 1
     });
   }
 }, {

test/rules/assertions/checkAlignment.js

@@ -11,6 +11,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected JSDoc block to be aligned.'
         }
       ],
@@ -34,6 +35,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Expected JSDoc block to be aligned.'
         }
       ],
@@ -57,6 +59,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected JSDoc block to be aligned.'
         }
       ],
@@ -80,6 +83,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Expected JSDoc block to be aligned.'
         }
       ],
@@ -103,6 +107,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected JSDoc block to be aligned.'
         }
       ],
@@ -122,7 +127,10 @@ export default {
          */
       `,
       errors: [
-        {message: 'Expected JSDoc block to be aligned.'}
+        {
+          line: 3,
+          message: 'Expected JSDoc block to be aligned.'
+        }
       ]
     },
     {
@@ -136,7 +144,10 @@ export default {
         }
       `,
       errors: [
-        {message: 'Expected JSDoc block to be aligned.'}
+        {
+          line: 5,
+          message: 'Expected JSDoc block to be aligned.'
+        }
       ]
     }
   ],

test/rules/assertions/checkIndentation.js

@@ -14,6 +14,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'There must be no indentation.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'There must be no indentation.'
         }
       ]

test/rules/assertions/newlineAfterDescription.js

@@ -14,6 +14,7 @@ export default {
       `,
       errors: [
         {
+          line: 5,
           message: 'There must be a newline after the description of the JSDoc block.'
         }
       ],
@@ -47,6 +48,7 @@ export default {
       `,
       errors: [
         {
+          line: 5,
           message: 'There must be a newline after the description of the JSDoc block.'
         }
       ],
@@ -78,6 +80,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'There must be no newline after the description of the JSDoc block.'
         }
       ],