Store commentLineNumber on errors. Fixes #159

cc @jfirebaugh for the review

Author: tmcw

bin/documentation.js

@@ -6,7 +6,7 @@ var documentation = require('../'),
   streamArray = require('stream-array'),
   fs = require('fs'),
   vfs = require('vinyl-fs'),
-  formatError = require('../lib/error'),
+  formatError = require('../lib/format_error'),
   args = require('../lib/args.js');
 
 var parsedArgs = args(process.argv.slice(2)),

lib/error.js renamed to lib/format_error.js

@@ -13,8 +13,8 @@ var path = require('path');
  */
 module.exports = function (comment, error) {
   var relativePath = path.relative(process.cwd(), comment.context.file),
-    lineNumber = comment.loc.start.line;
+    lineNumber = comment.loc.start.line + (error.commentLineNumber || 0);
 
-  return format.apply(format, ['%s:%d: ' + error, relativePath, lineNumber]
+  return format.apply(format, ['%s:%d: ' + error.message, relativePath, lineNumber]
     .concat(Array.prototype.slice.call(arguments, 3)));
 };

lib/hierarchy.js

@@ -55,10 +55,18 @@ function inferHierarchy(comments) {
       continue;
     }
 
+    var memberOfTag = comment.tags.filter(function (tag) {
+      return tag.title === 'memberof'
+    })[0];
+    var memberOfTagLineNumber = (memberOfTag && memberOfTag.lineNumber) || 0;
+
     var parent = nameIndex[comment.memberof];
 
     if (!parent) {
-      comment.errors.push('memberof reference to ' + comment.memberof + ' not found');
+      comment.errors.push({
+        message: 'memberof reference to ' + comment.memberof + ' not found',
+        commentLineNumber: memberOfTagLineNumber
+      });
       continue;
     }
 
@@ -70,7 +78,10 @@ function inferHierarchy(comments) {
 
     default:
       if (!comment.scope) {
-        parent.errors.push('found memberof but no @scope, @static, or @instance tag');
+        parent.errors.push({
+          message: 'found memberof but no @scope, @static, or @instance tag',
+          commentLineNumber: memberOfTagLineNumber
+        });
         continue;
       }
       parent.members[comment.scope].push(comment);

lib/lint.js

@@ -21,8 +21,10 @@ module.exports = function (comment) {
   comment.tags.forEach(function (tag) {
     function nameInvariant(name) {
       if (CANONICAL[name]) {
-        comment.errors.push(
-          'type ' + name + ' found, ' + CANONICAL[name] + ' is standard');
+        comment.errors.push({
+          message: 'type ' + name + ' found, ' + CANONICAL[name] + ' is standard',
+          commentLineNumber: tag.lineNumber
+        });
       }
     }
 

lib/nest_params.js

@@ -30,8 +30,10 @@ module.exports = function (comment) {
     if (parts.length > 1) {
       var parent = index[parts[0]];
       if (parent === undefined) {
-        result.errors.push(
-          '@param ' + param.name + '\'s parent ' + parts[0] + ' not found');
+        result.errors.push({
+          message: '@param ' + param.name + '\'s parent ' + parts[0] + ' not found',
+          commentLineNumber: param.lineNumber
+        });
         result.params.push(param);
         return;
       }

test/fixture/_external-deps-included.json

@@ -36,7 +36,10 @@
       "code": "/**\n * This function returns the number one.\n * @return {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [
-      "memberof reference to module not found"
+      {
+        "message": "memberof reference to module not found",
+        "commentLineNumber": 0
+      }
     ],
     "returns": [
       {
@@ -99,7 +102,10 @@
       "code": "'use strict';\n\nvar otherDep = require('external2');\n\n/**\n * This function returns the number one.\n * @return {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return otherDep() - 1;\n};\n"
     },
     "errors": [
-      "memberof reference to module not found"
+      {
+        "message": "memberof reference to module not found",
+        "commentLineNumber": 0
+      }
     ],
     "returns": [
       {

test/fixture/_multi-file-input.json

@@ -36,7 +36,10 @@
       "code": "/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = function () {\n  // this returns 1\n  return 1;\n};\n"
     },
     "errors": [
-      "memberof reference to module not found"
+      {
+        "message": "memberof reference to module not found",
+        "commentLineNumber": 0
+      }
     ],
     "returns": [
       {
@@ -114,7 +117,10 @@
       "code": "/**\n * This function returns the number plus two.\n *\n * @param {Number} a the number\n * @returns {Number} numbertwo\n * @example\n * var result = returnTwo(4);\n * // result is 6\n */\nfunction returnTwo(a) {\n  // this returns a + 2\n  return a + 2;\n}\n"
     },
     "errors": [
-      "type Number found, number is standard"
+      {
+        "message": "type Number found, number is standard",
+        "commentLineNumber": 3
+      }
     ],
     "params": [
       {

test/fixture/factory.output.json

@@ -148,7 +148,10 @@
       "code": "/**\n * an area chart generator\n * @returns {area} chart\n */\nvar area = function() {\n\n  /**\n   * @class area\n   */\n  var chart = function(selection) {\n  };\n\n  /**\n   * Sets the chart data.\n   * @method\n   */\n  chart.data = function(_) {\n  };\n\n  return chart;\n};\n"
     },
     "errors": [
-      "memberof reference to chart not found"
+      {
+        "message": "memberof reference to chart not found",
+        "commentLineNumber": 0
+      }
     ],
     "function": null,
     "name": "data",

test/fixture/inline-link.output.json

@@ -127,7 +127,10 @@
       "code": "/**\n * Adds one to a number\n * @param {number} a the input\n * @returns {number} the output\n */\nfunction addOne(a) {\n  return a + 1;\n}\n\n/**\n * This function returns the number one. Internally, this uses\n * {@link addOne} to do the math.\n * @param {number} a the input\n * @returns {number} numberone\n */\nmodule.exports = function (a) {\n  return addOne(a);\n};\n"
     },
     "errors": [
-      "memberof reference to module not found"
+      {
+        "message": "memberof reference to module not found",
+        "commentLineNumber": 0
+      }
     ],
     "params": [
       {

test/fixture/jsx.output.json

@@ -36,7 +36,10 @@
       "code": "var util = require('util');\n\n/**\n * This function returns the number one.\n * @returns {Number} numberone\n */\nmodule.exports = (<p>hello</p>);\n"
     },
     "errors": [
-      "memberof reference to module not found"
+      {
+        "message": "memberof reference to module not found",
+        "commentLineNumber": 0
+      }
     ],
     "returns": [
       {