fix(require-jsdoc): place comment block above any decorators; fixes #…

…571
gajus · Jun 18, 2020 · d5f8159 · d5f8159
1 parent 75fd013
commit d5f8159
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -8767,6 +8767,11 @@ class Animal {
 }
 // Options: [{"contexts":["ClassProperty"]}]
 // Message: Missing JSDoc comment.
+
+@Entity('users')
+export class User {}
+// Options: [{"require":{"ClassDeclaration":true}}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

diff --git a/src/eslint/getJSDocComment.js b/src/eslint/getJSDocComment.js
@@ -253,5 +253,5 @@ const getJSDocComment = function (sourceCode, node, settings) {
   return findJSDocComment(reducedNode);
 };
 
-export {getReducedASTNode, getJSDocComment};
+export {getReducedASTNode, getJSDocComment, getDecorator};
 export default getJSDocComment;
diff --git a/src/rules/requireJsdoc.js b/src/rules/requireJsdoc.js
@@ -1,7 +1,7 @@
 import _ from 'lodash';
 import jsdocUtils from '../jsdocUtils';
 import exportParser from '../exportParser';
-import {getJSDocComment, getReducedASTNode} from '../eslint/getJSDocComment';
+import {getJSDocComment, getReducedASTNode, getDecorator} from '../eslint/getJSDocComment';
 import {getSettings} from '../iterateJsdoc';
 
 const OPTIONS_SCHEMA = {
@@ -166,7 +166,16 @@ export default {
       const fix = (fixer) => {
         // Default to one line break if the `minLines`/`maxLines` settings allow
         const lines = settings.minLines === 0 && settings.maxLines >= 1 ? 1 : settings.minLines;
-        const baseNode = getReducedASTNode(node, sourceCode);
+        let baseNode = getReducedASTNode(node, sourceCode);
+
+        let decorator;
+        do {
+          const tokenBefore = sourceCode.getTokenBefore(baseNode, {includeComments: true});
+          decorator = getDecorator(tokenBefore, sourceCode);
+          if (decorator) {
+            baseNode = decorator;
+          }
+        } while (decorator);
 
         const indent = jsdocUtils.getIndent({
           text: sourceCode.getText(

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -2241,6 +2241,36 @@ export default {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+      @Entity('users')
+      export class User {}
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          require: {
+            ClassDeclaration: true,
+          },
+        },
+      ],
+      output: `
+      /**
+       *
+       */
+      @Entity('users')
+      export class User {}
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
   valid: [{
     code: `