[jest-docblock] remove leading newlines from parswWithComments().comm…

…ents (#4610)
jestjs · Oct 6, 2017 · c44d2c6 · c44d2c6
1 parent 087281a
commit c44d2c6
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/packages/jest-docblock/src/__tests__/index.test.js b/packages/jest-docblock/src/__tests__/index.test.js
@@ -254,6 +254,21 @@ describe('docblock', () => {
     );
   });
 
+  it('removes leading newlines in multiline comments from docblock', () => {
+    const code =
+      '/**' +
+      os.EOL +
+      ' * @snailcode' +
+      os.EOL +
+      ' *' +
+      os.EOL +
+      ' *  hello world' +
+      os.EOL +
+      ' */';
+
+    expect(docblock.parseWithComments(code).comments).toEqual(' hello world');
+  });
+
   it('extracts comments from beginning and end of docblock', () => {
     const code =
       '/**' +

diff --git a/packages/jest-docblock/src/index.js b/packages/jest-docblock/src/index.js
@@ -55,7 +55,10 @@ export function parseWithComments(
   docblock = docblock.replace(ltrimNewlineRe, '').replace(rtrimRe, '');
 
   const result = Object.create(null);
-  const comments = docblock.replace(propertyRe, '');
+  const comments = docblock
+    .replace(propertyRe, '')
+    .replace(ltrimNewlineRe, '')
+    .replace(rtrimRe, '');
 
   let match;
   while ((match = propertyRe.exec(docblock))) {