fix(require-jsdoc): ignore nested arrow functions and function expr…

…essions; fixes #812
gajus · Dec 15, 2021 · c552b1c · c552b1c
1 parent d62a2a7
commit c552b1c
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -12996,6 +12996,16 @@ export function outer() {
 }
 // "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 const outer = () => {
+    const 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
@@ -411,12 +411,16 @@ const findNode = function (node, block, cache) {
 };
 
 const exportTypes = new Set(['ExportNamedDeclaration', 'ExportDefaultDeclaration']);
+const ignorableNestedTypes = new Set([
+  'FunctionDeclaration', 'ArrowFunctionExpression', 'FunctionExpression',
+]);
 const getExportAncestor = function (nde) {
   let node = nde;
   let idx = 0;
+  const ignorableIfDeep = ignorableNestedTypes.has(nde?.type);
   while (node) {
     // Ignore functions nested more deeply than say `export default function () {}`
-    if (idx >= 2 && nde.type === 'FunctionDeclaration') {
+    if (idx >= 2 && ignorableIfDeep) {
       break;
     }
 

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -3355,6 +3355,49 @@ function quux (foo) {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+      export const outer = () => {
+          const 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 const outer = () => {
+          const inner = () => {
+              console.log('foo');
+          };
+
+          inner();
+      };
+      `,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
   valid: [{
     code: `