fix(require-description, require-example): for missing descriptio…

…n, use tag line number Also adding tests with line numbers for most files and adding warnings during testing for missing `line` on errors.
gajus · May 14, 2021 · 310ea75 · 310ea75
1 parent a70eda7
commit 310ea75
Show file tree

Hide file tree

Showing 22 changed files with 93 additions and 4 deletions.
diff --git a/src/rules/requireDescription.js b/src/rules/requireDescription.js
@@ -71,7 +71,7 @@ export default iterateJsdoc(({
 
   functionExamples.forEach((example) => {
     if (!checkDescription(`${example.name} ${utils.getTagDescription(example)}`)) {
-      report(`Missing JSDoc @${targetTagName} description.`);
+      report(`Missing JSDoc @${targetTagName} description.`, null, example);
     }
   });
 }, {

diff --git a/src/rules/requireExample.js b/src/rules/requireExample.js
@@ -39,7 +39,7 @@ export default iterateJsdoc(({
     const exampleContent = _.compact(`${example.name} ${utils.getTagDescription(example)}`.trim().split('\n'));
 
     if (!exampleContent.length) {
-      report(`Missing JSDoc @${targetTagName} description.`);
+      report(`Missing JSDoc @${targetTagName} description.`, null, example);
     }
   });
 }, {

diff --git a/test/rules/assertions/checkAccess.js b/test/rules/assertions/checkAccess.js
@@ -71,6 +71,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Unexpected tag `@access`',
         },
       ],
@@ -111,6 +112,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'The @access tag may not be used with specific access-control tags (@package, @private, @protected, or @public).',
         },
       ],
@@ -127,6 +129,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'At most one access-control tag may be present on a jsdoc block.',
         },
       ],
@@ -143,6 +146,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'At most one access-control tag may be present on a jsdoc block.',
         },
       ],
@@ -164,6 +168,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'At most one access-control tag may be present on a jsdoc block.',
         },
       ],
@@ -180,6 +185,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'At most one access-control tag may be present on a jsdoc block.',
         },
       ],
@@ -201,6 +207,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'At most one access-control tag may be present on a jsdoc block.',
         },
       ],

diff --git a/test/rules/assertions/checkValues.js b/test/rules/assertions/checkValues.js
@@ -129,6 +129,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @license: "MIT-7"; expected SPDX expression: https://spdx.org/licenses/.',
         },
       ],
@@ -144,6 +145,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @license: "(MIT OR GPL-2.5)"; expected SPDX expression: https://spdx.org/licenses/.',
         },
       ],
@@ -160,6 +162,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Invalid JSDoc @license: "MIT\nSome extra text"; expected SPDX expression: https://spdx.org/licenses/.',
         },
       ],

diff --git a/test/rules/assertions/newlineAfterDescription.js b/test/rules/assertions/newlineAfterDescription.js
@@ -212,6 +212,7 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'There must be no newline after the description of the JSDoc block.',
         },
       ],
@@ -236,6 +237,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'There must be a newline after the description of the JSDoc block.',
         },
       ],
@@ -263,6 +265,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'There must be a newline after the description of the JSDoc block.',
         },
       ],

diff --git a/test/rules/assertions/noRestrictedSyntax.js b/test/rules/assertions/noRestrictedSyntax.js
@@ -11,6 +11,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Syntax is restricted: FunctionDeclaration.',
         },
       ],
@@ -31,6 +32,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Oops: `FunctionDeclaration`.',
         },
       ],
@@ -54,6 +56,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Syntax is restricted: FunctionDeclaration.',
         },
       ],
@@ -77,6 +80,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'The bar one: FunctionDeclaration.',
         },
       ],
@@ -106,6 +110,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Rule `no-restricted-syntax` is missing a `context` option.',
         },
       ],

diff --git a/test/rules/assertions/noTypes.js b/test/rules/assertions/noTypes.js
@@ -202,6 +202,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Types are not permitted on @returns.',
         },
       ],

diff --git a/test/rules/assertions/noUndefinedTypes.js b/test/rules/assertions/noUndefinedTypes.js
@@ -15,6 +15,7 @@ export default {
           message: 'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',
         },
         {
+          line: 3,
           message: 'The type \'HerType\' is undefined.',
         },
       ],
@@ -37,6 +38,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'The type \'HerType\' is undefined.',
         },
       ],
@@ -254,9 +256,11 @@ export default {
       `,
       errors: [
         {
+          line: 7,
           message: 'The type \'TEMPLATE_TYPE_A\' is undefined.',
         },
         {
+          line: 8,
           message: 'The type \'TEMPLATE_TYPE_B\' is undefined.',
         },
       ],

diff --git a/test/rules/assertions/requireDescription.js b/test/rules/assertions/requireDescription.js
@@ -11,6 +11,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -31,6 +32,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc block description or @description declaration.',
         },
       ],
@@ -51,6 +53,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc block description.',
         },
       ],
@@ -71,6 +74,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Remove the @desc tag to leave a plain block description or add additional description text above the @desc line.',
         },
       ],
@@ -91,6 +95,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Remove the @description tag to leave a plain block description or add additional description text above the @description line.',
         },
       ],
@@ -111,6 +116,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -129,6 +135,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -150,6 +157,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -171,6 +179,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -192,6 +201,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @description description.',
         },
       ],
@@ -212,6 +222,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -236,6 +247,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -259,6 +271,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -282,6 +295,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Missing JSDoc @someDesc description.',
         },
       ],
@@ -312,6 +326,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Unexpected tag `@description`',
         },
       ],
@@ -339,6 +354,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc block description or @description declaration.',
         },
       ],
@@ -527,6 +543,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -560,6 +577,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],
@@ -592,6 +610,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Missing JSDoc @description declaration.',
         },
       ],

diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -35,6 +35,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Sentence should start with an uppercase character.',
         },
       ],
@@ -106,6 +107,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Sentence must end with a period.',
         },
       ],