fix(require-jsdoc): exemptEmptyFunctions option could trigger pro…

…blematic return value checking behavior with no-argument functions
gajus · Jun 6, 2021 · 3089a92 · 3089a92
1 parent 318e104
commit 3089a92
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 1 deletion.
diff --git a/src/jsdocUtils.js b/src/jsdocUtils.js
@@ -507,10 +507,17 @@ const isNewPromiseExpression = (node) => {
     node.callee.name === 'Promise';
 };
 
+/**
+ * @callback PromiseFilter
+ * @param {object} node
+ * @returns {boolean}
+ */
+
 /**
  * Checks if a node has a return statement. Void return does not count.
  *
  * @param {object} node
+ * @param {PromiseFilter} promFilter
  * @returns {boolean|Node}
  */
 // eslint-disable-next-line complexity

diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -221,7 +221,7 @@ export default {
         exemptEmptyConstructors && jsdocUtils.isConstructor(node)
       ) {
         const functionParameterNames = jsdocUtils.getFunctionParameterNames(node);
-        if (!functionParameterNames.length && !jsdocUtils.hasReturnValue(node, context)) {
+        if (!functionParameterNames.length && !jsdocUtils.hasReturnValue(node)) {
           return;
         }
       }

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -3144,6 +3144,42 @@ function quux (foo) {
         }
       `,
     },
+    {
+      code: `
+      function commandFinished () {
+        return new Promise((resolve) => {
+          client.on('ev', () => {
+            resolve();
+          });
+        });
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      ignoreReadme: true,
+      options: [{
+        exemptEmptyFunctions: true,
+        require: {
+          FunctionDeclaration: true,
+        },
+      }],
+      output: `
+      /**
+       *
+       */
+      function commandFinished () {
+        return new Promise((resolve) => {
+          client.on('ev', () => {
+            resolve();
+          });
+        });
+      }
+      `,
+    },
   ],
   valid: [{
     code: `