feat(require-returns-check): Allow @return to be omitted with @record tag in Closure mode

Author: l1bbcsg

README.md

@@ -9853,6 +9853,18 @@ class Foo {
   }
 }
 
+/**
+ * @record
+ */
+class Foo {
+  /**
+   * @returns {string}
+   */
+  bar () {
+  }
+}
+// Settings: {"jsdoc":{"mode":"closure"}}
+
 /**
  * @returns {undefined} Foo.
  */

src/rules/requireReturnsCheck.js

@@ -1,7 +1,7 @@
 import iterateJsdoc from '../iterateJsdoc';
 
-const canSkip = (utils) => {
-  return utils.hasATag([
+const canSkip = (utils, settings) => {
+  const voidingTags = [
     // An abstract function is by definition incomplete
     // so it is perfectly fine if a return is documented but
     // not present within the function.
@@ -15,14 +15,25 @@ const canSkip = (utils) => {
     'class',
     'constructor',
     'interface',
-  ]) || utils.isConstructor() || utils.classHasTag('interface');
+  ];
+
+  if (settings.mode === 'closure') {
+    // Structural Interface in GCC terms, equivalent to @interface tag as far as this rule is concerned
+    voidingTags.push('record');
+  }
+
+  return utils.hasATag(voidingTags) ||
+    utils.isConstructor() ||
+    utils.classHasTag('interface') ||
+    settings.mode === 'closure' && utils.classHasTag('record');
 };
 
 export default iterateJsdoc(({
   report,
+  settings,
   utils,
 }) => {
-  if (canSkip(utils)) {
+  if (canSkip(utils, settings)) {
     return;
   }
 

test/rules/assertions/requireReturnsCheck.js

@@ -298,6 +298,25 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @record
+           */
+          class Foo {
+            /**
+             * @returns {string}
+             */
+            bar () {
+            }
+          }
+      `,
+      settings: {
+        jsdoc: {
+          mode: 'closure',
+        },
+      },
+    },
     {
       code: `
           /**