fix(require-jsdoc): ensure ArrowFunctionExpression potentially repo…

…rted when part of `AssignmentExpression`; fixes #551
gajus · May 26, 2020 · d8c4e87 · d8c4e87
1 parent 7cb179e
commit d8c4e87
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8589,6 +8589,12 @@ export function bar(arg: boolean): boolean {
 }
 // Options: [{"contexts":["ExportNamedDeclaration[declaration.type=\"TSDeclareFunction\"]:not(ExportNamedDeclaration[declaration.type=\"TSDeclareFunction\"] + ExportNamedDeclaration[declaration.type=\"TSDeclareFunction\"])","ExportNamedDeclaration[declaration.type=\"FunctionDeclaration\"]:not(ExportNamedDeclaration[declaration.type=\"TSDeclareFunction\"] + ExportNamedDeclaration[declaration.type=\"FunctionDeclaration\"])"],"require":{"FunctionDeclaration":false}}]
 // Message: Missing JSDoc comment.
+
+module.exports.foo = (bar) => {
+  return bar + "biz"
+}
+// Options: [{"publicOnly":false,"require":{"ArrowFunctionExpression":true,"FunctionDeclaration":true,"FunctionExpression":true,"MethodDefinition":true}}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -229,7 +229,7 @@ export default {
             return;
           }
 
-          if (!['VariableDeclarator', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
+          if (!['VariableDeclarator', 'ExportDefaultDeclaration', 'AssignmentExpression'].includes(node.parent.type)) {
             return;
           }
 

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -2155,6 +2155,38 @@ export default {
       `,
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+      module.exports.foo = (bar) => {
+        return bar + "biz"
+      }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          publicOnly: false,
+          require: {
+            ArrowFunctionExpression: true,
+            FunctionDeclaration: true,
+            FunctionExpression: true,
+            MethodDefinition: true,
+          },
+        },
+      ],
+      output: `
+      /**
+       *
+       */
+      module.exports.foo = (bar) => {
+        return bar + "biz"
+      }
+      `,
+    },
   ],
   valid: [{
     code: `