feat(require-jsdoc): add contexts option to allow working with any node type

Author: brettz9

.README/rules/require-jsdoc.md

@@ -34,6 +34,11 @@ be checked by the rule.
   - `FunctionExpression`
   - `MethodDefinition`
 
+- `contexts` - Set this to a string or array of strings representing the additional
+  AST context where you wish the rule to be applied (e.g., `Property` for properties).
+  Note that unlike `require-description` and `match-description`, this rule has no
+  `noDefaults` option because its defaults are instead set up by `require`.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|

src/iterateJsdoc.js

@@ -464,11 +464,7 @@ export default function iterateJsdoc (iterator, ruleConfig) {
         };
       }
 
-      return contexts.reduce((obj, prop) => {
-        obj[prop] = checkJsdoc;
-
-        return obj;
-      }, {});
+      return jsdocUtils.getContextObject(contexts, checkJsdoc);
     },
     meta: ruleConfig.meta
   };

src/jsdocUtils.js

@@ -511,8 +511,17 @@ const enforcedContexts = (context, defaultContexts) => {
     [...new Set([...defltContexts, ...contexts])];
 };
 
+const getContextObject = (contexts, checkJsdoc) => {
+  return contexts.reduce((obj, prop) => {
+    obj[prop] = checkJsdoc;
+
+    return obj;
+  }, {});
+};
+
 export default {
   enforcedContexts,
+  getContextObject,
   getFunctionParameterNames,
   getJsdocParameterNames,
   getJsdocParameterNamesDeep,

src/rules/requireJsdoc.js

@@ -7,6 +7,19 @@ import getJSDocComment from '../eslint/getJSDocComment';
 const OPTIONS_SCHEMA = {
   additionalProperties: false,
   properties: {
+    contexts: {
+      oneOf: [
+        {
+          items: {
+            type: 'string'
+          },
+          type: 'array'
+        },
+        {
+          type: 'string'
+        }
+      ]
+    },
     publicOnly: {
       oneOf: [
         {
@@ -164,60 +177,64 @@ export default iterateJsdoc(null, {
       }
     };
 
-    return {
-      ArrowFunctionExpression (node) {
-        if (!requireOption.ArrowFunctionExpression) {
-          return;
-        }
+    // eslint-disable-next-line fp/no-mutating-assign
+    return Object.assign(
+      jsdocUtils.getContextObject(jsdocUtils.enforcedContexts(context, []), checkJsDoc),
+      {
+        ArrowFunctionExpression (node) {
+          if (!requireOption.ArrowFunctionExpression) {
+            return;
+          }
 
-        if (!['VariableDeclarator', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
-          return;
-        }
+          if (!['VariableDeclarator', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
+            return;
+          }
 
-        checkJsDoc(node);
-      },
-
-      ClassDeclaration (node) {
-        if (!requireOption.ClassDeclaration) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        ClassDeclaration (node) {
+          if (!requireOption.ClassDeclaration) {
+            return;
+          }
 
-      ClassExpression (node) {
-        if (!requireOption.ClassExpression) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        ClassExpression (node) {
+          if (!requireOption.ClassExpression) {
+            return;
+          }
 
-      FunctionDeclaration (node) {
-        if (!requireOption.FunctionDeclaration) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        FunctionDeclaration (node) {
+          if (!requireOption.FunctionDeclaration) {
+            return;
+          }
 
-      FunctionExpression (node) {
-        if (requireOption.MethodDefinition && node.parent.type === 'MethodDefinition') {
           checkJsDoc(node);
+        },
 
-          return;
-        }
+        FunctionExpression (node) {
+          if (requireOption.MethodDefinition && node.parent.type === 'MethodDefinition') {
+            checkJsDoc(node);
 
-        if (!requireOption.FunctionExpression) {
-          return;
-        }
+            return;
+          }
 
-        if (['VariableDeclarator', 'AssignmentExpression', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
-          checkJsDoc(node);
-        } else if (node.parent.type === 'Property' && node === node.parent.value) {
-          checkJsDoc(node);
+          if (!requireOption.FunctionExpression) {
+            return;
+          }
+
+          if (['VariableDeclarator', 'AssignmentExpression', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
+            checkJsDoc(node);
+          } else if (node.parent.type === 'Property' && node === node.parent.value) {
+            checkJsDoc(node);
+          }
         }
       }
-    };
+    );
   }
 });

test/rules/assertions/requireJsdoc.js

@@ -1010,6 +1010,26 @@ export default {
         ecmaVersion: 6,
         sourceType: 'module'
       }
+    },
+    {
+      code: `
+          const myObject = {
+            myProp: true
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+          type: 'Property'
+        }
+      ],
+      options: [
+        {
+          contexts: [
+            'Property'
+          ]
+        }
+      ]
     }
   ],
   valid: [{
@@ -1963,5 +1983,16 @@ export default {
         FunctionExpression: true
       }
     }]
+  }, {
+    code: `
+        const myObject = {
+          myProp: true
+        };
+    `,
+    options: [
+      {
+        contexts: []
+      }
+    ]
   }]
 };