Merge pull request #295 from fa93hws/master

 fix: check for comments immediately above any node by default and for relevant parents of `ClassExpression` and `ObjectExpression`

This fix is so that for rules allowing contexts not yet covered by `getJSDocComment` can at least lint comments immediately above the block

Author: brettz9

README.md

@@ -3372,6 +3372,33 @@ function quux () {
 
 }
 // Message: Missing JSDoc @description description.
+
+/**
+ *
+ */
+interface quux {
+
+}
+// Options: [{"contexts":["TSInterfaceDeclaration"],"noDefaults":true}]
+// Message: Missing JSDoc @description declaration.
+
+/**
+ *
+ */
+var quux = class {
+
+};
+// Options: [{"contexts":["ClassExpression"]}]
+// Message: Missing JSDoc @description declaration.
+
+/**
+ *
+ */
+var quux = {
+
+};
+// Options: [{"contexts":["ObjectExpression"]}]
+// Message: Missing JSDoc @description declaration.
 ````
 
 The following patterns are not considered problems:
@@ -3426,6 +3453,27 @@ function quux () {
 
 }
 // Options: [{"exemptedBy":["type"]}]
+
+/**
+ *
+ */
+interface quux {
+
+}
+
+/**
+ *
+ */
+var quux = class {
+
+};
+
+/**
+ *
+ */
+var quux = {
+
+};
 ````
 
 

src/eslint/getJSDocComment.js

@@ -25,6 +25,7 @@ const looksLikeExport = function (astNode) {
     astNode.type === 'ExportAllDeclaration' || astNode.type === 'ExportSpecifier';
 };
 
+/* eslint-disable complexity */
 /**
  * Retrieves the JSDoc comment for a given node.
  *
@@ -67,8 +68,7 @@ const getJSDocComment = function (sourceCode, node) {
     return findJSDocComment(looksLikeExport(parent) ? parent : node);
 
   case 'ClassExpression':
-    return findJSDocComment(parent.parent);
-
+  case 'ObjectExpression':
   case 'ArrowFunctionExpression':
   case 'FunctionExpression':
     if (
@@ -96,10 +96,14 @@ const getJSDocComment = function (sourceCode, node) {
 
     return findJSDocComment(node);
 
-  // falls through
   default:
-    return null;
+    if (!node) {
+      return null;
+    }
+
+    return findJSDocComment(node);
   }
 };
+/* eslint-enable complexity */
 
 export default getJSDocComment;

test/eslint/getJSDocComment.js

@@ -0,0 +1,43 @@
+import {
+  RuleTester
+} from 'eslint';
+import iterateJsdoc from '../../src/iterateJsdoc';
+import getJSDocComment from '../../src/eslint/getJSDocComment';
+
+const rule = iterateJsdoc(null, {
+  meta: {
+    messages: {
+      missingJsDoc: 'Missing JSDoc comment.'
+    },
+    type: 'layout'
+  },
+  returns (context, sourceCode) {
+    return {
+      ObjectExpression: (node) => {
+        const comment = getJSDocComment(sourceCode, node);
+        if (comment !== null) {
+          return;
+        }
+        context.report({
+          messageId: 'missingJsDoc',
+          node
+        });
+      }
+    };
+  }
+});
+
+const ruleTester = new RuleTester();
+
+ruleTester.run('getJSDocComment', rule, {
+  invalid: [{
+    code: 'var a = {};',
+    errors: [{messageId: 'missingJsDoc'}]
+  }],
+  valid: [{
+    code: `
+    /** Doc */
+    var a = {};
+    `
+  }]
+});

test/rules/assertions/requireDescription.js

@@ -90,6 +90,74 @@ export default {
           message: 'Missing JSDoc @description description.'
         }
       ]
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          interface quux {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @description declaration.'
+        }
+      ],
+      options: [
+        {
+          contexts: [
+            'TSInterfaceDeclaration'
+          ],
+          noDefaults: true
+        }
+      ],
+      parser: require.resolve('@typescript-eslint/parser')
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          var quux = class {
+
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @description declaration.'
+        }
+      ],
+      options: [
+        {
+          contexts: [
+            'ClassExpression'
+          ]
+        }
+      ]
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          var quux = {
+
+          };
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc @description declaration.'
+        }
+      ],
+      options: [
+        {
+          contexts: [
+            'ObjectExpression'
+          ]
+        }
+      ]
     }
   ],
   valid: [
@@ -168,6 +236,37 @@ export default {
           exemptedBy: ['type']
         }
       ]
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          interface quux {
+
+          }
+      `,
+      parser: require.resolve('@typescript-eslint/parser')
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          var quux = class {
+
+          };
+      `
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          var quux = {
+
+          };
+      `
     }
   ]
 };

test/rules/index.js

@@ -49,6 +49,9 @@ const ruleTester = new RuleTester();
   });
 
   assertions.valid = assertions.valid.map((assertion) => {
+    if (assertion.errors) {
+      throw new Error(`Valid assertions for rule ${ruleName} should not have an \`errors\` array.`);
+    }
     assertion.parserOptions = _.defaultsDeep(assertion.parserOptions, parserOptions);
 
     return assertion;