fix(require-jsdoc): allow contexts to be usable in place of `requ…

…ire` items
gajus · Sep 25, 2020 · a1d95e6 · a1d95e6
1 parent 6d0f351
commit a1d95e6
Show file tree

Hide file tree

Showing 3 changed files with 82 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -9422,6 +9422,18 @@ export const test = () => {
 // Options: [{"publicOnly":true,"require":{"ArrowFunctionExpression":true}}]
 // Message: Missing JSDoc comment.
 
+export const test = () => {
+
+};
+// Options: [{"contexts":["ArrowFunctionExpression"],"publicOnly":true}]
+// Message: Missing JSDoc comment.
+
+export const test = () => {
+
+};
+// Options: [{"contexts":[{"context":"ArrowFunctionExpression"}],"publicOnly":true}]
+// Message: Missing JSDoc comment.
+
 export let test = class {
 
 };

diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -269,10 +269,16 @@ export default {
       }
     };
 
+    const hasOption = (prop) => {
+      return requireOption[prop] || contexts.some((ctxt) => {
+        return typeof ctxt === 'object' ? ctxt.context === prop : ctxt === prop;
+      });
+    };
+
     return {
       ...jsdocUtils.getContextObject(jsdocUtils.enforcedContexts(context, []), checkJsDoc),
       ArrowFunctionExpression (node) {
-        if (!requireOption.ArrowFunctionExpression) {
+        if (!hasOption('ArrowFunctionExpression')) {
           return;
         }
 
@@ -285,37 +291,37 @@ export default {
       },
 
       ClassDeclaration (node) {
-        if (!requireOption.ClassDeclaration) {
+        if (!hasOption('ClassDeclaration')) {
           return;
         }
 
         checkJsDoc(node);
       },
 
       ClassExpression (node) {
-        if (!requireOption.ClassExpression) {
+        if (!hasOption('ClassExpression')) {
           return;
         }
 
         checkJsDoc(node);
       },
 
       FunctionDeclaration (node) {
-        if (!requireOption.FunctionDeclaration) {
+        if (!hasOption('FunctionDeclaration')) {
           return;
         }
 
         checkJsDoc(node, true);
       },
 
       FunctionExpression (node) {
-        if (requireOption.MethodDefinition && node.parent.type === 'MethodDefinition') {
+        if (hasOption('MethodDefinition') && node.parent.type === 'MethodDefinition') {
           checkJsDoc(node, true);
 
           return;
         }
 
-        if (!requireOption.FunctionExpression) {
+        if (!hasOption('FunctionExpression')) {
           return;
         }
 

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -211,6 +211,64 @@ export default {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+          export const test = () => {
+
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+          type: 'ArrowFunctionExpression',
+        },
+      ],
+      options: [{
+        contexts: ['ArrowFunctionExpression'],
+        publicOnly: true,
+      }],
+      output: `
+          /**
+           *
+           */
+          export const test = () => {
+
+          };
+      `,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+    {
+      code: `
+          export const test = () => {
+
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+          type: 'ArrowFunctionExpression',
+        },
+      ],
+      options: [{
+        contexts: [{
+          context: 'ArrowFunctionExpression',
+        }],
+        publicOnly: true,
+      }],
+      output: `
+          /**
+           *
+           */
+          export const test = () => {
+
+          };
+      `,
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
     {
       code: `
           export let test = class {