feat(require-jsdoc): allow simple decorators to intervene between c…

…omment block and context object; fixes part of #455

This does not yet support intervening parenthesized decorators

README.md

@@ -7233,6 +7233,15 @@ enum Example {
 const foo = {...{}};
 function bar() {}
 // Options: [{"exemptEmptyFunctions":false,"publicOnly":true,"require":{"ArrowFunctionExpression":true,"ClassDeclaration":true,"ClassExpression":true,"FunctionDeclaration":true,"FunctionExpression":false,"MethodDefinition":true}}]
+
+/**
+ * Class documentation
+ */
+ @logged
+export default class Foo {
+ // ....
+}
+// Options: [{"exemptEmptyFunctions":false,"require":{"ClassDeclaration":true}}]
 ````
 
 

src/eslint/getJSDocComment.js

@@ -14,6 +14,17 @@ const isCommentToken = (token) => {
   return token.type === 'Line' || token.type === 'Block' || token.type === 'Shebang';
 };
 
+const getDecorator = (token, sourceCode) => {
+  if (token && token.type === 'Identifier') {
+    const tokenBefore = sourceCode.getTokenBefore(token, {includeComments: true});
+    if (tokenBefore && tokenBefore.type === 'Punctuator' && tokenBefore.value === '@') {
+      return tokenBefore;
+    }
+  }
+
+  return false;
+};
+
 /**
  * Check to see if its a ES6 export declaration.
  *
@@ -104,6 +115,11 @@ const getJSDocComment = function (sourceCode, node, settings) {
 
     while (currentNode) {
       tokenBefore = sourceCode.getTokenBefore(currentNode, {includeComments: true});
+      const decorator = getDecorator(tokenBefore, sourceCode);
+      if (decorator) {
+        currentNode = decorator;
+        continue;
+      }
       if (!tokenBefore || !isCommentToken(tokenBefore)) {
         return null;
       }

test/rules/assertions/requireJsdoc.js

@@ -2354,5 +2354,28 @@ export default {
       sourceType: 'module',
     },
   },
+  {
+    code: `
+    /**
+     * Class documentation
+     */
+     @logged
+    export default class Foo {
+     // ....
+    }
+    `,
+    options: [
+      {
+        exemptEmptyFunctions: false,
+        require: {
+          ClassDeclaration: true,
+        },
+      },
+    ],
+    parser: require.resolve('@typescript-eslint/parser'),
+    parserOptions: {
+      sourceType: 'module',
+    },
+  },
   ],
 };