fix: avoid highlighting whole function block upon missing jsdoc block…

… in favor of highlighting first line only; fixes #386
gajus · Sep 27, 2019 · f77144d · f77144d
1 parent c523384
commit f77144d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 10 deletions.
diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -172,6 +172,19 @@ export default {
         return fixer.insertTextBefore(baseNode, insertion);
       };
 
+      const report = () => {
+        const loc = {
+          end: node.loc.start,
+          start: node.loc.start,
+        };
+        context.report({
+          fix,
+          messageId: 'missingJsDoc',
+          node,
+          loc,
+        });
+      };
+
       if (publicOnly) {
         const opt = {
           ancestorsOnly: Boolean(_.get(publicOnly, 'ancestorsOnly', false)),
@@ -183,18 +196,10 @@ export default {
         const exported = exportParser.isExported(node, parseResult, opt);
 
         if (exported) {
-          context.report({
-            fix,
-            messageId: 'missingJsDoc',
-            node,
-          });
+          report();
         }
       } else {
-        context.report({
-          fix,
-          messageId: 'missingJsDoc',
-          node,
-        });
+        report();
       }
     };
 

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -263,6 +263,7 @@ export default {
           }`,
       errors: [
         {
+          endLine: 2,
           line: 2,
           message: 'Missing JSDoc comment.',
         },