fix(require-jsdoc): avoid class jsdoc blocks suppressing errors for…

… `PropertyDefinition`; fixes #841
gajus · Feb 18, 2022 · ef68427 · ef68427
1 parent 06c3163
commit ef68427
Show file tree

Hide file tree

Showing 3 changed files with 99 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -13322,6 +13322,24 @@ export const outer = () => {
 };
 // "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":true,"require":{"ArrowFunctionExpression":true,"ClassDeclaration":true,"ClassExpression":true,"FunctionDeclaration":true,"FunctionExpression":true,"MethodDefinition":true}}]
 // Message: Missing JSDoc comment.
+
+/**
+ *
+ */
+export class InovaAutoCompleteComponent {
+  public disabled = false;
+}
+// "jsdoc/require-jsdoc": ["error"|"warn", {"contexts":["PropertyDefinition"],"publicOnly":true}]
+// Message: Missing JSDoc comment.
+
+/**
+* Some comment.
+*/
+export class Component {
+    public foo?: number;
+}
+// "jsdoc/require-jsdoc": ["error"|"warn", {"checkConstructors":false,"contexts":["PropertyDefinition"],"publicOnly":true}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

diff --git a/src/exportParser.js b/src/exportParser.js
@@ -445,23 +445,26 @@ const getExportAncestor = function (nde) {
   return false;
 };
 
-const canExportedByAncestorType = new Set([
+const canBeExportedByAncestorType = new Set([
   'TSPropertySignature',
   'TSMethodSignature',
   'ClassProperty',
+  'PropertyDefinition',
   'Method',
 ]);
 
 const canExportChildrenType = new Set([
   'TSInterfaceBody',
   'TSInterfaceDeclaration',
+  'ClassDeclaration',
+  'ClassBody',
   'ClassDefinition',
   'ClassExpression',
   'Program',
 ]);
 
 const isExportByAncestor = function (nde) {
-  if (!canExportedByAncestorType.has(nde.type)) {
+  if (!canBeExportedByAncestorType.has(nde.type)) {
     return false;
   }
 

diff --git a/test/rules/assertions/requireJsdoc.js b/test/rules/assertions/requireJsdoc.js
@@ -3650,6 +3650,82 @@ function quux (foo) {
         sourceType: 'module',
       },
     },
+    {
+      code: `
+      /**
+       *
+       */
+      export class InovaAutoCompleteComponent {
+        public disabled = false;
+      }
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          contexts: [
+            'PropertyDefinition',
+          ],
+          publicOnly: true,
+        },
+      ],
+      output: `
+      /**
+       *
+       */
+      export class InovaAutoCompleteComponent {
+        /**
+         *
+         */
+        public disabled = false;
+      }
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+    {
+      code: `
+          /**
+          * Some comment.
+          */
+          export class Component {
+              public foo?: number;
+          }
+      `,
+      errors: [
+        {
+          line: 6,
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          checkConstructors: false,
+          contexts: [
+            'PropertyDefinition',
+          ],
+          publicOnly: true,
+        },
+      ],
+      output: `
+          /**
+          * Some comment.
+          */
+          export class Component {
+              /**
+               *
+               */
+              public foo?: number;
+          }
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+    },
   ],
   valid: [
     {