fix(require-jsdoc): avoid reporting inner functions missing jsdoc w…

…hen pubilc-only jsdoc is being checked and missing; fixes #812
gajus · Dec 15, 2021 · d62a2a7 · d62a2a7
1 parent f04a444
commit d62a2a7
Show file tree

Hide file tree

Showing 3 changed files with 60 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12986,6 +12986,16 @@ export class InovaAutoCompleteComponent {
 export default (arg) => arg;
 // "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":true,"require":{"ArrowFunctionExpression":true,"ClassDeclaration":true,"ClassExpression":true,"FunctionDeclaration":true,"FunctionExpression":true,"MethodDefinition":true}}]
 // Message: Missing JSDoc comment.
+
+export function outer() {
+    function inner() {
+        console.log('foo');
+    }
+
+    inner();
+}
+// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":true,"require":{"ArrowFunctionExpression":true,"ClassDeclaration":true,"ClassExpression":true,"FunctionDeclaration":true,"FunctionExpression":true,"MethodDefinition":true}}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

diff --git a/src/exportParser.js b/src/exportParser.js
@@ -413,12 +413,19 @@ const findNode = function (node, block, cache) {
 const exportTypes = new Set(['ExportNamedDeclaration', 'ExportDefaultDeclaration']);
 const getExportAncestor = function (nde) {
   let node = nde;
+  let idx = 0;
   while (node) {
+    // Ignore functions nested more deeply than say `export default function () {}`
+    if (idx >= 2 && nde.type === 'FunctionDeclaration') {
+      break;
+    }
+
     if (exportTypes.has(node.type)) {
       return node;
     }
 
     node = node.parent;
+    idx++;
   }
 
   return false;

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -3312,6 +3312,49 @@ function quux (foo) {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+      export function outer() {
+          function inner() {
+              console.log('foo');
+          }
+
+          inner();
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [{
+        publicOnly: true,
+        require: {
+          ArrowFunctionExpression: true,
+          ClassDeclaration: true,
+          ClassExpression: true,
+          FunctionDeclaration: true,
+          FunctionExpression: true,
+          MethodDefinition: true,
+        },
+      }],
+      output: `
+      /**
+       *
+       */
+      export function outer() {
+          function inner() {
+              console.log('foo');
+          }
+
+          inner();
+      }
+      `,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
   valid: [{
     code: `