fix(require-jsdoc): allow TSInterfaceDeclaration to find jsdoc bl…

…ock preceding export; fixes #385
gajus · Sep 26, 2019 · c523384 · c523384
1 parent b7e93f0
commit c523384
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -5647,6 +5647,28 @@ function quux () {
 }
 export default quux;
 // Options: [{"publicOnly":true,"require":{"FunctionExpression":true}}]
+
+/**
+ * This example interface is great!
+ */
+export interface Example {
+  /**
+   * My super test string!
+   */
+  test: string
+}
+// Options: [{"contexts":["TSInterfaceDeclaration"]}]
+
+/**
+ * This example interface is great!
+ */
+interface Example {
+  /**
+   * My super test string!
+   */
+  test: string
+}
+// Options: [{"contexts":["TSInterfaceDeclaration"]}]
 ````
 
 

diff --git a/src/eslint/getJSDocComment.js b/src/eslint/getJSDocComment.js
@@ -62,9 +62,10 @@ const getJSDocComment = function (sourceCode, node, settings) {
 
     return null;
   };
-  let parent = node.parent;
+  let {parent} = node;
 
   switch (node.type) {
+  case 'TSInterfaceDeclaration':
   case 'ClassDeclaration':
   case 'FunctionDeclaration':
     return findJSDocComment(looksLikeExport(parent) ? parent : node);
@@ -74,9 +75,7 @@ const getJSDocComment = function (sourceCode, node, settings) {
   case 'ArrowFunctionExpression':
   case 'FunctionExpression':
     if (
-      parent.type !== 'CallExpression' &&
-      parent.type !== 'OptionalCallExpression' &&
-      parent.type !== 'NewExpression'
+      !['CallExpression', 'OptionalCallExpression', 'NewExpression'].includes(parent.type)
     ) {
       while (
         !sourceCode.getCommentsBefore(parent).length &&

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -2182,5 +2182,53 @@ export default {
     parserOptions: {
       sourceType: 'module',
     },
-  }],
+  }, {
+    code: `
+    /**
+     * This example interface is great!
+     */
+    export interface Example {
+      /**
+       * My super test string!
+       */
+      test: string
+    }
+    `,
+    options: [
+      {
+        contexts: [
+          'TSInterfaceDeclaration',
+        ],
+      },
+    ],
+    parser: require.resolve('@typescript-eslint/parser'),
+    parserOptions: {
+      sourceType: 'module',
+    },
+  },
+  {
+    code: `
+    /**
+     * This example interface is great!
+     */
+    interface Example {
+      /**
+       * My super test string!
+       */
+      test: string
+    }
+    `,
+    options: [
+      {
+        contexts: [
+          'TSInterfaceDeclaration',
+        ],
+      },
+    ],
+    parser: require.resolve('@typescript-eslint/parser'),
+    parserOptions: {
+      sourceType: 'module',
+    },
+  },
+  ],
 };