Handle blank lines in starred-block comments correctly

eslint · Oct 25, 2019 · 71d6c76 · 71d6c76
1 parent a77a6d4
commit 71d6c76
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 4 deletions.
diff --git a/lib/rules/multiline-comment-style.js b/lib/rules/multiline-comment-style.js
@@ -95,13 +95,15 @@ module.exports = {
          * @returns {string[]} An array of the processed lines.
          */
         function processStarredBlockComment(comment) {
-            const lines = comment.value.split(astUtils.LINEBREAK_MATCHER).map(line => line.replace(/^\s*$/u, ""));
+            const lines = comment.value.split(astUtils.LINEBREAK_MATCHER)
+                .filter((line, i, linesArr) => !(i === 0 || i === linesArr.length - 1))
+                .map(line => line.replace(/^\s*$/u, ""));
             const allLinesHaveLeadingSpace = lines
                 .map(line => line.replace(/\s*\*/u, ""))
                 .filter(line => line.trim().length)
                 .every(line => line.startsWith(" "));
 
-            return lines.map(line => line.replace(allLinesHaveLeadingSpace ? /\s*\* /u : /\s*\*/u, ""));
+            return lines.map(line => line.replace(allLinesHaveLeadingSpace ? /\s*\* ?/u : /\s*\*/u, ""));
         }
 
         /**
@@ -322,7 +324,7 @@ module.exports = {
                     },
                     messageId: "expectedLines",
                     fix(fixer) {
-                        return fixer.replaceText(firstComment, convertToSeparateLines(firstComment, commentLines.filter(line => line.length)));
+                        return fixer.replaceText(firstComment, convertToSeparateLines(firstComment, commentLines));
                     }
                 });
             },
@@ -361,7 +363,7 @@ module.exports = {
                         },
                         messageId: "expectedBareBlock",
                         fix(fixer) {
-                            return fixer.replaceText(firstComment, convertToBlock(firstComment, commentLines.filter(line => line.length)));
+                            return fixer.replaceText(firstComment, convertToBlock(firstComment, commentLines));
                         }
                     });
                 }

diff --git a/tests/lib/rules/multiline-comment-style.js b/tests/lib/rules/multiline-comment-style.js
@@ -937,6 +937,78 @@ ruleTester.run("multiline-comment-style", rule, {
                 { messageId: "expectedLines", line: 2 }
             ]
         },
+        {
+            code: `
+                /*
+                 *
+                 * {
+                 *     "foo": 1,
+                 *     "bar": 2
+                 * }
+                 *
+                 */
+            `,
+            output: `
+                //${" "}
+                // {
+                //     "foo": 1,
+                //     "bar": 2
+                // }
+                //${" "}
+            `,
+            options: ["separate-lines"],
+            errors: [
+                { messageId: "expectedLines", line: 2 }
+            ]
+        },
+        {
+            code: `
+                /*
+                 *
+                 * {
+                 *     "foo": 1,
+                 *     "bar": 2
+                 * }
+                 *
+                 */
+            `,
+            output: `
+                /*${" "}
+                   {
+                       "foo": 1,
+                       "bar": 2
+                   }
+                    */
+            `,
+            options: ["bare-block"],
+            errors: [
+                { messageId: "expectedBareBlock", line: 2 }
+            ]
+        },
+        {
+            code: `
+                /*
+                 *
+                 *{
+                 *    "foo": 1,
+                 *    "bar": 2
+                 *}
+                 *
+                 */
+            `,
+            output: `
+                /*${" "}
+                   {
+                       "foo": 1,
+                       "bar": 2
+                   }
+                    */
+            `,
+            options: ["bare-block"],
+            errors: [
+                { messageId: "expectedBareBlock", line: 2 }
+            ]
+        },
         {
             code: `
                 /*
@@ -1027,10 +1099,12 @@ ruleTester.run("multiline-comment-style", rule, {
                 */
             `,
             output: `
+                //${" "}
                 // {
                 //     "foo": 1,
                 //     "bar": 2
                 // }
+                //${" "}
             `,
             options: ["separate-lines"],
             errors: [