Fix: Emit correct endLine numbers (#88)

* Fix: Emit correct endLine numbers

* fix: subtract one when calculating endLine

* Fix: subtract comment blocks, update tests

* Fix: add leadingComment lines to endLine (correctly)

* Fix: add processor test for endLines, skip plugin tests

* Fix: revert eslint version back to 2.2.0

* Fix: Re-enable endLine tests

Author: Paul Murray

lib/processor.js

@@ -119,21 +119,28 @@ function adjustBlock(block) {
         return count + comment.split("\n").length;
     }, 0);
 
+    var blockStart = block.position.start.line;
+
     /**
      * Adjusts ESLint messages to point to the correct location in the Markdown.
      * @param {Message} message A message from ESLint.
      * @returns {Message} The same message, but adjusted ot the correct location.
      */
     return function adjustMessage(message) {
+
         var lineInCode = message.line - leadingCommentLines;
+        var endLine = message.endLine - leadingCommentLines;
         if (lineInCode < 1) {
             return null;
         }
 
-        return assign({}, message, {
-            line: lineInCode + block.position.start.line,
+        var out = {
+            line: lineInCode + blockStart,
+            endLine: endLine ? endLine + blockStart : endLine,
             column: message.column + block.position.indent[lineInCode - 1] - 1
-        });
+        };
+
+        return assign({}, message, out);
     };
 }
 

tests/lib/plugin.js

@@ -45,6 +45,51 @@ describe("plugin", function() {
         assert.equal(report.results[0].messages[0].line, 2);
     });
 
+    it("should emit correct line numbers", function() {
+        var code = [
+            "# Hello, world!",
+            "",
+            "",
+            "```js",
+            "var bar = baz",
+            "",
+            "",
+            "var foo = blah",
+            "```"
+        ].join("\n");
+        var report = cli.executeOnText(code, "test.md");
+        assert.equal(report.results[0].messages[0].message, "'baz' is not defined.");
+        assert.equal(report.results[0].messages[0].line, 5);
+        assert.equal(report.results[0].messages[0].endLine, 5);
+        assert.equal(report.results[0].messages[1].message, "'blah' is not defined.");
+        assert.equal(report.results[0].messages[1].line, 8);
+        assert.equal(report.results[0].messages[1].endLine, 8);
+    });
+
+    it("should emit correct line numbers with leading comments", function() {
+        var code = [
+            "# Hello, world!",
+            "",
+            "<!-- eslint-disable quotes -->",
+            "<!-- eslint-disable semi -->",
+            "",
+            "```js",
+            "var bar = baz",
+            "",
+            "var str = 'single quotes'",
+            "",
+            "var foo = blah",
+            "```"
+        ].join("\n");
+        var report = cli.executeOnText(code, "test.md");
+        assert.equal(report.results[0].messages[0].message, "'baz' is not defined.");
+        assert.equal(report.results[0].messages[0].line, 7);
+        assert.equal(report.results[0].messages[0].endLine, 7);
+        assert.equal(report.results[0].messages[1].message, "'blah' is not defined.");
+        assert.equal(report.results[0].messages[1].line, 11);
+        assert.equal(report.results[0].messages[1].endLine, 11);
+    });
+
     it("should run on .mkdn files", function() {
         var report = cli.executeOnText(shortText, "test.mkdn");
 

tests/lib/processor.js

@@ -514,13 +514,13 @@ describe("processor", function() {
         ].join("\n");
         var messages = [
             [
-                { line: 1, column: 1, message: "Use the global form of \"use strict\".", ruleId: "strict" },
-                { line: 3, column: 5, message: "Unexpected console statement.", ruleId: "no-console" }
+                { line: 1, endLine: 1, column: 1, message: "Use the global form of \"use strict\".", ruleId: "strict" },
+                { line: 3, endLine: 3, column: 5, message: "Unexpected console statement.", ruleId: "no-console" }
             ], [
-                { line: 3, column: 6, message: "Missing trailing comma.", ruleId: "comma-dangle" }
+                { line: 3, endLine: 3, column: 6, message: "Missing trailing comma.", ruleId: "comma-dangle" }
             ], [
-                { line: 3, column: 2, message: "Unreachable code after return.", ruleId: "no-unreachable" },
-                { line: 4, column: 2, message: "Unnecessary semicolon.", ruleId: "no-extra-semi" }
+                { line: 3, endLine: 6, column: 2, message: "Unreachable code after return.", ruleId: "no-unreachable" },
+                { line: 4, endLine: 4, column: 2, message: "Unnecessary semicolon.", ruleId: "no-extra-semi" }
             ]
         ];
 
@@ -555,6 +555,16 @@ describe("processor", function() {
             assert.equal(result[4].line, 27);
         });
 
+        it("should translate endLine numbers", function() {
+            var result = processor.postprocess(messages);
+
+            assert.equal(result[0].endLine, 4);
+            assert.equal(result[1].endLine, 6);
+            assert.equal(result[2].endLine, 17);
+            assert.equal(result[3].endLine, 29);
+            assert.equal(result[4].endLine, 27);
+        });
+
         it("should translate column numbers", function() {
             var result = processor.postprocess(messages);