feat: set line locations when reporting violations (#88)

brokentone · gajus · commit 95df73e25d37 · 2018-08-23T16:14:39.000+01:00
* Update and test checkTagNames rule error line locations

* Update and test checkTypes rule error line locations

* Update and test noUndefinedTypes rule error line locations

* Update and test requireHyphenBeforeParamDescription rule error line locations

* Update and test requireParamDescription rule error line locations

* Update and test requireParamName rule error line locations

* Update and test requireParamType rule error line locations

* Update and test requireReturnsDescription rule error line locations

* Update and test requireReturnsType

* Update and test validTypes
diff --git a/src/rules/checkTagNames.js b/src/rules/checkTagNames.js
@@ -11,10 +11,10 @@ export default iterateJsdoc(({
       const preferredTagName = utils.getPreferredTagName(jsdocTag.tag);
 
       if (preferredTagName !== jsdocTag.tag) {
-        report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".');
+        report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".', null, jsdocTag);
       }
     } else {
-      report('Invalid JSDoc tag name "' + jsdocTag.tag + '".');
+      report('Invalid JSDoc tag name "' + jsdocTag.tag + '".', null, jsdocTag);
     }
   });
 });
diff --git a/src/rules/checkTypes.js b/src/rules/checkTypes.js
@@ -80,7 +80,7 @@ export default iterateJsdoc(({
           return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace('{' + jsdocTag.type + '}', '{' + fixedType + '}'));
         };
 
-        report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + invalidType + '".', fix);
+        report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + invalidType + '".', fix, jsdocTag);
       });
     }
   });
diff --git a/src/rules/noUndefinedTypes.js b/src/rules/noUndefinedTypes.js
@@ -52,7 +52,7 @@ export default iterateJsdoc(({
     traverse(parsedType, (node) => {
       if (node.type === 'NAME') {
         if (!_.includes(definedTypes, node.name)) {
-          report('The type \'' + node.name + '\' is undefined.');
+          report('The type \'' + node.name + '\' is undefined.', null, tag);
         } else if (!_.includes(extraTypes, node.name)) {
           context.markVariableAsUsed(node.name);
         }
diff --git a/src/rules/requireHyphenBeforeParamDescription.js b/src/rules/requireHyphenBeforeParamDescription.js
@@ -17,7 +17,7 @@ export default iterateJsdoc(({
         const replacement = sourceCode.getText(jsdocNode).replace(jsdocTag.description, '- ' + jsdocTag.description);
 
         return fixer.replaceText(jsdocNode, replacement);
-      });
+      }, jsdocTag);
     }
   });
 });
diff --git a/src/rules/requireParamDescription.js b/src/rules/requireParamDescription.js
@@ -14,7 +14,7 @@ export default iterateJsdoc(({
 
   _.forEach(jsdocParameters, (jsdocParameter) => {
     if (!jsdocParameter.description) {
-      report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.');
+      report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.', null, jsdocParameter);
     }
   });
 });
diff --git a/src/rules/requireParamName.js b/src/rules/requireParamName.js
@@ -14,7 +14,7 @@ export default iterateJsdoc(({
 
   _.forEach(jsdocParameters, (jsdocParameter) => {
     if (jsdocParameter.tag && jsdocParameter.name === '') {
-      report('There must be an identifier after @param ' + (jsdocParameter.type === '' ? 'type' : 'tag') + '.');
+      report('There must be an identifier after @param ' + (jsdocParameter.type === '' ? 'type' : 'tag') + '.', null, jsdocParameter);
     }
   });
 });
diff --git a/src/rules/requireParamType.js b/src/rules/requireParamType.js
@@ -14,7 +14,7 @@ export default iterateJsdoc(({
 
   _.forEach(jsdocParameters, (jsdocParameter) => {
     if (!jsdocParameter.type) {
-      report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" type.');
+      report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" type.', null, jsdocParameter);
     }
   });
 });
diff --git a/src/rules/requireReturnsDescription.js b/src/rules/requireReturnsDescription.js
@@ -14,7 +14,7 @@ export default iterateJsdoc(({
 
   _.forEach(jsdocTags, (jsdocTag) => {
     if (!jsdocTag.description) {
-      report('Missing JSDoc @' + targetTagName + ' description.');
+      report('Missing JSDoc @' + targetTagName + ' description.', null, jsdocTag);
     }
   });
 });
diff --git a/src/rules/requireReturnsType.js b/src/rules/requireReturnsType.js
@@ -14,7 +14,7 @@ export default iterateJsdoc(({
 
   _.forEach(jsdocTags, (jsdocTag) => {
     if (!jsdocTag.type) {
-      report('Missing JSDoc @' + targetTagName + ' type.');
+      report('Missing JSDoc @' + targetTagName + ' type.', null, jsdocTag);
     }
   });
 });
diff --git a/src/rules/validTypes.js b/src/rules/validTypes.js
@@ -12,7 +12,7 @@ export default iterateJsdoc(({
         parse(tag.type);
       } catch (error) {
         if (error.name === 'SyntaxError') {
-          report('Syntax error in type: ' + tag.type);
+          report('Syntax error in type: ' + tag.type, null, tag);
         }
       }
     }
diff --git a/test/rules/assertions/checkTagNames.js b/test/rules/assertions/checkTagNames.js
@@ -18,6 +18,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag name "Param".'
         }
       ]
@@ -33,6 +34,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag name "foo".'
         }
       ]
@@ -48,6 +50,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag (preference). Replace "arg" JSDoc tag with "param".'
         }
       ]
@@ -63,6 +66,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag (preference). Replace "param" JSDoc tag with "arg".'
         }
       ],
@@ -85,6 +89,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag name "bar".'
         }
       ]
@@ -100,6 +105,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc tag name "baz".'
         }
       ],
@@ -123,6 +129,7 @@ export default {
         `,
       errors: [
         {
+          line: 4,
           message: 'Invalid JSDoc tag name "baz".'
         }
       ],
diff --git a/test/rules/assertions/checkTypes.js b/test/rules/assertions/checkTypes.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @param "foo" type "Number".'
         }
       ],
@@ -36,6 +37,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @arg "foo" type "Number".'
         }
       ],
@@ -59,9 +61,11 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @param "foo" type "Number".'
         },
         {
+          line: 3,
           message: 'Invalid JSDoc @param "foo" type "Boolean".'
         }
       ],
@@ -85,9 +89,11 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @param "foo" type "Number".'
         },
         {
+          line: 3,
           message: 'Invalid JSDoc @param "foo" type "String".'
         }
       ],
diff --git a/test/rules/assertions/noUndefinedTypes.js b/test/rules/assertions/noUndefinedTypes.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'The type \'strnig\' is undefined.'
         }
       ],
diff --git a/test/rules/assertions/requireHyphenBeforeParamDescription.js b/test/rules/assertions/requireHyphenBeforeParamDescription.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'There must be a hyphen before @param description.'
         }
       ],
diff --git a/test/rules/assertions/requireParamDescription.js b/test/rules/assertions/requireParamDescription.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @param "foo" description.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @arg "foo" description.'
         }
       ],
diff --git a/test/rules/assertions/requireParamName.js b/test/rules/assertions/requireParamName.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'There must be an identifier after @param type.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'There must be an identifier after @param tag.'
         }
       ]
diff --git a/test/rules/assertions/requireParamType.js b/test/rules/assertions/requireParamType.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @param "foo" type.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @arg "foo" type.'
         }
       ],
diff --git a/test/rules/assertions/requireReturnsDescription.js b/test/rules/assertions/requireReturnsDescription.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @returns description.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @return description.'
         }
       ],
diff --git a/test/rules/assertions/requireReturnsType.js b/test/rules/assertions/requireReturnsType.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @returns type.'
         }
       ]
@@ -28,6 +29,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @returns type.'
         }
       ]
@@ -43,6 +45,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @return type.'
         }
       ],
diff --git a/test/rules/assertions/validTypes.js b/test/rules/assertions/validTypes.js
@@ -13,6 +13,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Syntax error in type: Array<string'
         }
       ]

Original file line number	Diff line number	Diff line change
`@@ -11,10 +11,10 @@ export default iterateJsdoc(({`
`11`	`11`	`const preferredTagName = utils.getPreferredTagName(jsdocTag.tag);`
`12`	`12`
`13`	`13`	`if (preferredTagName !== jsdocTag.tag) {`
`14`		`- report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".');`
	`14`	`+ report('Invalid JSDoc tag (preference). Replace "' + jsdocTag.tag + '" JSDoc tag with "' + preferredTagName + '".', null, jsdocTag);`
`15`	`15`	`}`
`16`	`16`	`} else {`
`17`		`- report('Invalid JSDoc tag name "' + jsdocTag.tag + '".');`
	`17`	`+ report('Invalid JSDoc tag name "' + jsdocTag.tag + '".', null, jsdocTag);`
`18`	`18`	`}`
`19`	`19`	`});`
`20`	`20`	`});`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ export default iterateJsdoc(({`
`80`	`80`	`return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace('{' + jsdocTag.type + '}', '{' + fixedType + '}'));`
`81`	`81`	`};`
`82`	`82`
`83`		`- report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + invalidType + '".', fix);`
	`83`	`+ report('Invalid JSDoc @' + jsdocTag.tag + ' "' + jsdocTag.name + '" type "' + invalidType + '".', fix, jsdocTag);`
`84`	`84`	`});`
`85`	`85`	`}`
`86`	`86`	`});`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ export default iterateJsdoc(({`
`52`	`52`	`traverse(parsedType, (node) => {`
`53`	`53`	`if (node.type === 'NAME') {`
`54`	`54`	`if (!_.includes(definedTypes, node.name)) {`
`55`		`- report('The type \'' + node.name + '\' is undefined.');`
	`55`	`+ report('The type \'' + node.name + '\' is undefined.', null, tag);`
`56`	`56`	`} else if (!_.includes(extraTypes, node.name)) {`
`57`	`57`	`context.markVariableAsUsed(node.name);`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export default iterateJsdoc(({`
`17`	`17`	`const replacement = sourceCode.getText(jsdocNode).replace(jsdocTag.description, '- ' + jsdocTag.description);`
`18`	`18`
`19`	`19`	`return fixer.replaceText(jsdocNode, replacement);`
`20`		`- });`
	`20`	`+ }, jsdocTag);`
`21`	`21`	`}`
`22`	`22`	`});`
`23`	`23`	`});`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export default iterateJsdoc(({`
`14`	`14`
`15`	`15`	`_.forEach(jsdocParameters, (jsdocParameter) => {`
`16`	`16`	`if (!jsdocParameter.description) {`
`17`		`- report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.');`
	`17`	`+ report('Missing JSDoc @' + targetTagName + ' "' + jsdocParameter.name + '" description.', null, jsdocParameter);`
`18`	`18`	`}`
`19`	`19`	`});`
`20`	`20`	`});`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ export default iterateJsdoc(({`
`12`	`12`	`parse(tag.type);`
`13`	`13`	`} catch (error) {`
`14`	`14`	`if (error.name === 'SyntaxError') {`
`15`		`- report('Syntax error in type: ' + tag.type);`
	`15`	`+ report('Syntax error in type: ' + tag.type, null, tag);`
`16`	`16`	`}`
`17`	`17`	`}`
`18`	`18`	`}`