Merge pull request #240 from brettz9/check-examples

Change behavior of check-examples to also check classes

Author: brettz9

src/iterateJsdoc.js

@@ -371,10 +371,18 @@ export default (iterator, opts = {}) => {
         });
       };
 
-      if (opts.returns) {
+      if (typeof opts.returns === 'function') {
         return opts.returns(context, sourceCode, checkJsdoc);
       }
 
+      if (Array.isArray(opts.returns)) {
+        return opts.returns.reduce((obj, prop) => {
+          obj[prop] = checkJsdoc;
+
+          return obj;
+        }, {});
+      }
+
       return {
         ArrowFunctionExpression: checkJsdoc,
         FunctionDeclaration: checkJsdoc,

src/rules/checkExamples.js

@@ -188,4 +188,9 @@ export default iterateJsdoc(({
       );
     });
   });
-});
+}, {returns: [
+  'ArrowFunctionExpression',
+  'ClassDeclaration',
+  'FunctionDeclaration',
+  'FunctionExpression'
+]});

test/rules/assertions/checkExamples.js

@@ -31,6 +31,35 @@ export default {
         }
       }
     },
+    {
+      code: `
+          /**
+           * @example alert('hello')
+           */
+          class quux {
+
+          }
+      `,
+      errors: [
+        {
+          message: '@example error (no-alert): Unexpected alert.'
+        },
+        {
+          message: '@example error (semi): Missing semicolon.'
+        }
+      ],
+      settings: {
+        jsdoc: {
+          baseConfig: {
+            rules: {
+              'no-alert': 2,
+              semi: ['error', 'always']
+            }
+          },
+          eslintrcForExamples: false
+        }
+      }
+    },
     {
       code: `
           /**