Merge branch 'master' into ds/destructuring

* master:
  fix: in conjunction with `comment-parser` update, remove last line break in last tag description for proper stringification (and fix old tests)
  test(no-types): check the fix for no-types preserves asterisks
  fix(require-jsdoc): check above export for named exports; fixes gajus#526

# Conflicts:
#	test/rules/assertions/requireParam.js

Author: brettz9

README.md

@@ -5426,6 +5426,17 @@ function quux (foo) {
  */
 function quux () {
 
+}
+// Message: Types are not permitted on @returns.
+
+/**
+ * Beep
+ * Boop
+ *
+ * @returns {number}
+ */
+function quux () {
+
 }
 // Message: Types are not permitted on @returns.
 ````
@@ -8186,6 +8197,10 @@ const hello = name => {
 };
 // Options: [{"require":{"ArrowFunctionExpression":true,"FunctionDeclaration":false}}]
 // Message: Missing JSDoc comment.
+
+export const loginSuccessAction = (): BaseActionPayload => ({ type: LOGIN_SUCCESSFUL });
+// Options: [{"require":{"ArrowFunctionExpression":true,"FunctionDeclaration":false}}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:

package.json

@@ -5,7 +5,7 @@
     "url": "http://gajus.com"
   },
   "dependencies": {
-    "comment-parser": "^0.7.2",
+    "comment-parser": "^0.7.4",
     "debug": "^4.1.1",
     "jsdoctypeparser": "^6.1.0",
     "lodash": "^4.17.15",
@@ -16,12 +16,12 @@
   "description": "JSDoc linting rules for ESLint.",
   "devDependencies": {
     "@babel/cli": "^7.8.4",
-    "@babel/core": "^7.9.0",
+    "@babel/core": "^7.9.6",
     "@babel/node": "^7.8.7",
     "@babel/plugin-transform-flow-strip-types": "^7.9.0",
-    "@babel/preset-env": "^7.9.5",
+    "@babel/preset-env": "^7.9.6",
     "@babel/register": "^7.9.0",
-    "@typescript-eslint/parser": "^2.28.0",
+    "@typescript-eslint/parser": "^2.31.0",
     "babel-eslint": "^10.1.0",
     "babel-plugin-add-module-exports": "^1.0.2",
     "babel-plugin-istanbul": "^6.0.0",
@@ -32,10 +32,10 @@
     "gitdown": "^3.1.3",
     "glob": "^7.1.6",
     "husky": "^4.2.5",
-    "mocha": "^7.1.1",
+    "mocha": "^7.1.2",
     "nyc": "^15.0.1",
     "rimraf": "^3.0.2",
-    "semantic-release": "^17.0.6",
+    "semantic-release": "^17.0.7",
     "typescript": "^3.8.3"
   },
   "engines": {

src/bin/generateReadme.js

@@ -8,7 +8,9 @@ import glob from 'glob';
 import Gitdown from 'gitdown';
 
 const trimCode = (code) => {
-  let lines = code.replace(/^\n/u, '').trimEnd().split('\n');
+  // todo[engine:node@>10]: Change to `trimEnd`
+  // eslint-disable-next-line unicorn/prefer-trim-start-end
+  let lines = code.replace(/^\n/u, '').trimRight().split('\n');
 
   const firsLineIndentation = lines[0].match(/^\s+/u);
   const lastLineIndentation = lines[lines.length - 1].match(/^\s+/u);

src/eslint/getJSDocComment.js

@@ -154,7 +154,11 @@ const getReducedASTNode = function (node, sourceCode) {
         }
       }
 
-      if (parent && parent.type !== 'FunctionDeclaration' && parent.type !== 'Program') {
+      if (parent) {
+        if (parent.parent.type === 'ExportNamedDeclaration') {
+          return parent.parent;
+        }
+
         return parent;
       }
     }

src/iterateJsdoc.js

@@ -154,6 +154,10 @@ const getUtils = (
 
   utils.stringify = (tagBlock) => {
     const indent = jsdocUtils.getIndent(sourceCode);
+    if (ruleConfig.noTrim) {
+      const lastTag = tagBlock.tags[tagBlock.tags.length - 1];
+      lastTag.description = lastTag.description.replace(/\n$/, '');
+    }
 
     return commentStringify([tagBlock], {indent}).slice(indent.length - 1);
   };

src/rules/noTypes.js

@@ -36,4 +36,5 @@ export default iterateJsdoc(({
     ],
     type: 'suggestion',
   },
+  noTrim: true,
 });

test/rules/assertions/noTypes.js

@@ -124,6 +124,35 @@ export default {
            */
           function quux () {
 
+          }
+      `,
+    },
+    {
+      code: `
+          /**
+           * Beep
+           * Boop
+           *
+           * @returns {number}
+           */
+          function quux () {
+
+          }
+      `,
+      errors: [
+        {
+          message: 'Types are not permitted on @returns.',
+        },
+      ],
+      output: `
+          /**
+           * Beep
+           * Boop
+           *
+           * @returns
+           */
+          function quux () {
+
           }
       `,
     },

test/rules/assertions/requireJsdoc.js

@@ -1384,6 +1384,34 @@ export default {
       };
       `,
     },
+    {
+      code: `
+      export const loginSuccessAction = (): BaseActionPayload => ({ type: LOGIN_SUCCESSFUL });
+      `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          require: {
+            ArrowFunctionExpression: true,
+            FunctionDeclaration: false,
+          },
+        },
+      ],
+      output: `
+      /**
+       *
+       */
+      export const loginSuccessAction = (): BaseActionPayload => ({ type: LOGIN_SUCCESSFUL });
+      `,
+      parser: require.resolve('@typescript-eslint/parser'),
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
   ],
   valid: [{
     code: `

test/rules/assertions/requireParam.js

@@ -733,7 +733,6 @@ export default {
       interface ITest {
       /**
        * Test description.
-       *
        * @param id
        */
       TestMethod(id: number): void;
@@ -773,7 +772,6 @@ export default {
       {
       /**
        * A test method.
-       *
        * @param id
        */
       abstract TestFunction(id);
@@ -840,7 +838,6 @@ export default {
       output: `
       /**
        * A test function.
-       *
        * @param id
        */
       declare let TestFunction: (id) => void;
@@ -868,7 +865,6 @@ export default {
       output: `
         /**
          * A test function.
-         *
          * @param id
          */
         let TestFunction: (id) => void;
@@ -900,7 +896,6 @@ export default {
       output: `
         /**
          * A test function.
-         *
          * @param id
          */
         function test(
@@ -935,7 +930,6 @@ export default {
       output: `
         /**
          * A test function.
-         *
          * @param id
          */
         let test = (processor: (id: number) => string) =>
@@ -969,7 +963,6 @@ export default {
         class TestClass {
         /**
          * A class property.
-         *
          * @param id
          */
         public Test: (id: number) => string;
@@ -1003,7 +996,6 @@ export default {
         class TestClass {
         /**
          * A class method.
-         *
          * @param id
          */
         public TestMethod(): (id: number) => string
@@ -1037,7 +1029,6 @@ export default {
         interface TestInterface {
         /**
          * An interface property.
-         *
          * @param id
          */
         public Test: (id: number) => string;
@@ -1069,7 +1060,6 @@ export default {
         interface TestInterface {
         /**
          * An interface method.
-         *
          * @param id
          */
         public TestMethod(): (id: number) => string;
@@ -1098,7 +1088,6 @@ export default {
       output: `
         /**
          * A function with return type
-         *
          * @param id
          */
         function test(): (id: number) => string;
@@ -1129,7 +1118,6 @@ export default {
       output: `
         /**
          * A function with return type
-         *
          * @param id
          */
         let test = (): (id: number) => string =>
@@ -1192,7 +1180,6 @@ export default {
       class Client {
         /**
        * Set collection data.
-       *
        * @param {Object} data                    The collection data object.
        * @param {number} data.last_modified
        * @param {Object} options            The options object.