feat(require-jsdoc): allow require to posses ClassExpression boolean property

Author: brettz9

.README/rules/require-jsdoc.md

@@ -29,13 +29,14 @@ be checked by the rule.
 
   - `ArrowFunctionExpression`
   - `ClassDeclaration`
+  - `ClassExpression`
   - `FunctionDeclaration` (defaults to `true`)
   - `FunctionExpression`
   - `MethodDefinition`
 
 |||
 |---|---|
-|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
+|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|N/A|
 |Options|`publicOnly`|
 |Settings|`exemptEmptyFunctions`|

README.md

@@ -3659,13 +3659,14 @@ be checked by the rule.
 
   - `ArrowFunctionExpression`
   - `ClassDeclaration`
+  - `ClassExpression`
   - `FunctionDeclaration` (defaults to `true`)
   - `FunctionExpression`
   - `MethodDefinition`
 
 |||
 |---|---|
-|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `FunctionDeclaration`, `FunctionExpression`|
+|Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|
 |Tags|N/A|
 |Options|`publicOnly`|
 |Settings|`exemptEmptyFunctions`|
@@ -3692,6 +3693,12 @@ export const test = () => {
 // Options: [{"publicOnly":true,"require":{"ArrowFunctionExpression":true}}]
 // Message: Missing JSDoc comment.
 
+export let test = class {
+
+};
+// Options: [{"publicOnly":true,"require":{"ClassExpression":true}}]
+// Message: Missing JSDoc comment.
+
 export default function () {}
 // Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
 // Message: Missing JSDoc comment.
@@ -4430,6 +4437,19 @@ let test = function () {
 }
 // Options: [{"publicOnly":{"window":true},"require":{"FunctionExpression":true}}]
 
+let test = class {
+
+}
+// Options: [{"publicOnly":true,"require":{"ClassExpression":false}}]
+
+/**
+ *
+ */
+let test = class {
+
+}
+// Options: [{"publicOnly":true,"require":{"ClassExpression":true}}]
+
 export function someMethod() {
 
 }

src/exportParser.js

@@ -81,7 +81,7 @@ const getSymbol = function (node, globals, scope, opt) {
 
     /* istanbul ignore next */
     return null;
-  } case 'ClassDeclaration': case 'FunctionExpression': case 'FunctionDeclaration': case 'ArrowFunctionExpression': {
+  } case 'ClassDeclaration': case 'ClassExpression': case 'FunctionExpression': case 'FunctionDeclaration': case 'ArrowFunctionExpression': {
     const val = createNode();
     val.props.prototype = createNode();
     val.props.prototype.type = 'object';

src/rules/requireJsdoc.js

@@ -46,6 +46,10 @@ const OPTIONS_SCHEMA = {
           default: false,
           type: 'boolean'
         },
+        ClassExpression: {
+          default: false,
+          type: 'boolean'
+        },
         FunctionDeclaration: {
           default: true,
           type: 'boolean'
@@ -181,6 +185,14 @@ export default iterateJsdoc(null, {
         checkJsDoc(node);
       },
 
+      ClassExpression (node) {
+        if (!requireOption.ClassExpression) {
+          return;
+        }
+
+        checkJsDoc(node);
+      },
+
       FunctionDeclaration (node) {
         if (!requireOption.FunctionDeclaration) {
           return;

test/rules/assertions/requireJsdoc.js

@@ -71,6 +71,28 @@ export default {
         sourceType: 'module'
       }
     },
+    {
+      code: `
+          export let test = class {
+
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+          type: 'ClassExpression'
+        }
+      ],
+      options: [{
+        publicOnly: true,
+        require: {
+          ClassExpression: true
+        }
+      }],
+      parserOptions: {
+        sourceType: 'module'
+      }
+    },
     {
       code: `
         export default function () {}
@@ -1847,6 +1869,35 @@ export default {
       sourceType: 'module'
     }
   },
+  {
+    code: `
+      let test = class {
+
+      }
+    `,
+    options: [{
+      publicOnly: true,
+      require: {
+        ClassExpression: false
+      }
+    }]
+  },
+  {
+    code: `
+      /**
+       *
+       */
+      let test = class {
+
+      }
+    `,
+    options: [{
+      publicOnly: true,
+      require: {
+        ClassExpression: true
+      }
+    }]
+  },
   {
     code: `
       export function someMethod() {