Merge branch 'master' of github.com:AndrewLeedham/eslint-plugin-jsdoc

# Conflicts:
#	.README/README.md
#	README.md
#	test/rules/assertions/requireReturns.js

Author: AndrewLeedham

.README/README.md

@@ -298,7 +298,7 @@ only (e.g., to match `Array` if the type is `Array` vs. `Array.<string>`).
   `undefined`/`void` return.
 * `settings.jsdoc.forceReturnsWithAsync` - Set to `true` to always insist on
   `@returns` documentation regardless of implicit or explicit `return`'s
-  in an async function. May be desired to flag that a project is aware of an
+  in an async function. May be desired to flag that a project is aware of a
   `Promise<void>` return.
 
 ### Settings to Configure `require-example`

README.md

@@ -353,7 +353,7 @@ only (e.g., to match `Array` if the type is `Array` vs. `Array.<string>`).
   `undefined`/`void` return.
 * `settings.jsdoc.forceReturnsWithAsync` - Set to `true` to always insist on
   `@returns` documentation regardless of implicit or explicit `return`'s
-  in an async function. May be desired to flag that a project is aware of an
+  in an async function. May be desired to flag that a project is aware of a
   `Promise<void>` return.
 
 <a name="eslint-plugin-jsdoc-settings-settings-to-configure-require-example"></a>
@@ -1227,7 +1227,7 @@ function quux (foo) {
 }
 // Settings: {"jsdoc":{"additionalTagNames":{"customTags":["baz","bar"]}}}
 
-/** 
+/**
  * @abstract
  * @access
  * @alias
@@ -4620,11 +4620,25 @@ function quux (foo) {
 /**
  *
  */
-function quux () {
+async function quux() {
 }
 // Settings: {"jsdoc":{"forceRequireReturn":true}}
 // Message: Missing JSDoc @returns declaration.
 
+/**
+ *
+ */
+const quux = async function () {}
+// Settings: {"jsdoc":{"forceRequireReturn":true}}
+// Message: Missing JSDoc @returns declaration.
+
+/**
+ *
+ */
+const quux = async () => {}
+// Settings: {"jsdoc":{"forceRequireReturn":true}}
+// Message: Missing JSDoc @returns declaration.
+
 /**
  *
  */
@@ -4642,6 +4656,14 @@ const language = {
   }
 }
 // Message: Missing JSDoc @returns declaration.
+
+/**
+ *
+ */
+async function quux () {
+}
+// Settings: {"jsdoc":{"forceReturnsWithAsync":true}}
+// Message: Missing JSDoc @returns declaration.
 ````
 
 The following patterns are not considered problems:
@@ -5002,7 +5024,7 @@ function quux() {
 
 }
 // Settings: {"jsdoc":{"allowEmptyNamepaths":false}}
-// Message: Syntax error in type: 
+// Message: Syntax error in type:
 ````
 
 The following patterns are not considered problems:

package.json

@@ -26,12 +26,12 @@
     "gitdown": "^2.5.8",
     "glob": "^7.1.4",
     "globby": "^9.2.0",
-    "husky": "^2.4.0",
+    "husky": "^2.4.1",
     "marked": "^0.6.2",
     "mocha": "^6.1.4",
     "nyc": "^14.1.1",
     "semantic-release": "^15.13.16",
-    "typescript": "^3.5.1"
+    "typescript": "^3.5.2"
   },
   "engines": {
     "node": ">=6"

test/rules/assertions/requireReturns.js

@@ -90,7 +90,7 @@ export default {
           /**
            *
            */
-          function quux () {
+          async function quux() {
           }
       `,
       errors: [
@@ -99,6 +99,31 @@ export default {
           message: 'Missing JSDoc @returns declaration.'
         }
       ],
+      parserOptions: {
+        ecmaVersion: 8
+      },
+      settings: {
+        jsdoc: {
+          forceRequireReturn: true
+        }
+      }
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          const quux = async function () {}
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.'
+        }
+      ],
+      parserOptions: {
+        ecmaVersion: 8
+      },
       settings: {
         jsdoc: {
           forceRequireReturn: true
@@ -122,6 +147,26 @@ export default {
       parserOptions: {
         ecmaVersion: 8
       },
+      settings: {
+        jsdoc: {
+          forceRequireReturn: true
+        }
+      }
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          function quux () {
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.'
+        }
+      ],
       settings: {
         jsdoc: {
           forceReturnsWithAsync: true
@@ -145,6 +190,29 @@ export default {
           message: 'Missing JSDoc @returns declaration.'
         }
       ]
+    },
+    {
+      code: `
+          /**
+           *
+           */
+          async function quux () {
+          }
+      `,
+      errors: [
+        {
+          line: 2,
+          message: 'Missing JSDoc @returns declaration.'
+        }
+      ],
+      parserOptions: {
+        ecmaVersion: 8
+      },
+      settings: {
+        jsdoc: {
+          forceReturnsWithAsync: true
+        }
+      }
     }
   ],
   valid: [