fix(require-jsdoc): ensure children of TS type reference and parame…

…ter instantiation can be exports; fixes #1186
gajus · Jan 13, 2024 · 55d9f25 · 55d9f25
1 parent b9939fc
commit 55d9f25
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 0 deletions.
diff --git a/src/exportParser.js b/src/exportParser.js
@@ -741,6 +741,8 @@ const canExportChildrenType = new Set([
   'TSInterfaceDeclaration',
   'TSTypeLiteral',
   'TSTypeAliasDeclaration',
+  'TSTypeParameterInstantiation',
+  'TSTypeReference',
   'ClassDeclaration',
   'ClassBody',
   'ClassDefinition',

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -4191,6 +4191,58 @@ function quux (foo) {
         }
       },
     },
+    {
+      code: `
+        /**
+         * Command options for the login command
+         */
+        export type LoginOptions = CmdOptions<{
+          username?: string;
+          password?: string;
+        }>;
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'Missing JSDoc comment.',
+        },
+        {
+          line: 7,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          publicOnly: {
+            ancestorsOnly: true,
+          },
+          contexts: [
+            'TSTypeAliasDeclaration',
+            'TSInterfaceDeclaration',
+            'TSMethodSignature',
+            'TSPropertySignature',
+          ],
+        },
+      ],
+      output: `
+        /**
+         * Command options for the login command
+         */
+        export type LoginOptions = CmdOptions<{
+          /**
+           *
+           */
+          username?: string;
+          /**
+           *
+           */
+          password?: string;
+        }>;
+      `,
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+    },
   ],
   valid: [
     {