INCOMPLETE: Depends on comment-parser fix: #447

fix: remove last line break in last tag description for proper stringification (and fix old tests)

Impacts `check-param-names`, `check-property-names`, `empty-tags`, `no-defaults`, `no-types`, `require-example`, `require-param`, `require-property`

Author: brettz9

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/requireParam.js

@@ -605,7 +605,6 @@ export default {
       interface ITest {
       /**
        * Test description.
-       *
        * @param id
        */
       TestMethod(id: number): void;
@@ -645,7 +644,6 @@ export default {
       {
       /**
        * A test method.
-       *
        * @param id
        */
       abstract TestFunction(id);
@@ -712,7 +710,6 @@ export default {
       output: `
       /**
        * A test function.
-       *
        * @param id
        */
       declare let TestFunction: (id) => void;
@@ -740,7 +737,6 @@ export default {
       output: `
       /**
        * A test function.
-       *
        * @param id
        */
       let TestFunction: (id) => void;
@@ -772,7 +768,6 @@ export default {
       output: `
       /**
        * A test function.
-       *
        * @param id
        */
        function test(
@@ -807,7 +802,6 @@ export default {
       output: `
       /**
        * A test function.
-       *
        * @param id
        */
        let test = (processor: (id: number) => string) =>
@@ -841,7 +835,6 @@ export default {
       class TestClass {
       /**
        * A class property.
-       *
        * @param id
        */
         public Test: (id: number) => string;
@@ -875,7 +868,6 @@ export default {
       class TestClass {
       /**
        * A class method.
-       *
        * @param id
        */
        public TestMethod(): (id: number) => string
@@ -909,7 +901,6 @@ export default {
       interface TestInterface {
       /**
        * An interface property.
-       *
        * @param id
        */
         public Test: (id: number) => string;
@@ -941,7 +932,6 @@ export default {
       interface TestInterface {
       /**
        * An interface method.
-       *
        * @param id
        */
        public TestMethod(): (id: number) => string;
@@ -970,7 +960,6 @@ export default {
       output: `
       /**
        * A function with return type
-       *
        * @param id
        */
        function test(): (id: number) => string;
@@ -1001,7 +990,6 @@ export default {
       output: `
       /**
        * A function with return type
-       *
        * @param id
        */
        let test = (): (id: number) => string =>