fix(require-jsdoc): allow TSTypeLiteral and `TSTypeAliasDeclarati…

…on` to have `TSPropertySignature` checks pass through them toward public export for `publicOnly` checks; fixes #852
gajus · Mar 14, 2022 · 19e4f6f · 19e4f6f
1 parent 5e8e0c7
commit 19e4f6f
Show file tree

Hide file tree

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

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -3726,6 +3726,96 @@ function quux (foo) {
       `,
       parser: require.resolve('@typescript-eslint/parser'),
     },
+    {
+      code: `
+        /** Alpha of all types */
+        export type Alpha = {
+          one: string;
+          two: number;
+        };
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Missing JSDoc comment.',
+        },
+        {
+          line: 5,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      ignoreReadme: true,
+      options: [
+        {
+          contexts: [
+            'TSPropertySignature',
+          ],
+          publicOnly: true,
+        },
+      ],
+      output: `
+        /** Alpha of all types */
+        export type Alpha = {
+          /**
+           *
+           */
+          one: string;
+          /**
+           *
+           */
+          two: number;
+        };
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
+    {
+      code: `
+        export type Alpha = {
+          one: string;
+          two: number;
+        };
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc comment.',
+        },
+        {
+          line: 3,
+          message: 'Missing JSDoc comment.',
+        },
+        {
+          line: 4,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      ignoreReadme: true,
+      options: [
+        {
+          contexts: [
+            'TSTypeAliasDeclaration',
+            'TSPropertySignature',
+          ],
+          publicOnly: true,
+        },
+      ],
+      output: `
+        /**
+         *
+         */
+        export type Alpha = {
+          /**
+           *
+           */
+          one: string;
+          /**
+           *
+           */
+          two: number;
+        };
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [
     {