Merge pull request Rosey#112 from danielsnider/perserve-newline-off-by-one-fix

Off by one fix for preserveNewlines

Author: Rose

src/draft-to-markdown.js

@@ -462,13 +462,11 @@ function renderBlock(block, index, rawDraftObject, options) {
     markdownString += '\n';
   } else if (rawDraftObject.blocks[index + 1]) {
     if (rawDraftObject.blocks[index].text) {
-      if ((type === 'unstyled' || type === 'blockquote') && options.preserveNewlines
-        || SingleNewlineAfterBlock.indexOf(type) !== -1
+      if (SingleNewlineAfterBlock.indexOf(type) !== -1
           && SingleNewlineAfterBlock.indexOf(rawDraftObject.blocks[index + 1].type) === -1) {
         markdownString += '\n\n';
-      } else if (!options.preserveNewlines
-        || (rawDraftObject.blocks[index + 1] && !rawDraftObject.blocks[index + 1].text && rawDraftObject.blocks[index + 1].type === 'unstyled' && options.preserveNewlines)) {
-        // 2 newlines if not preserving OR if this block is styled but the next block is a blank newline
+      } else if (!options.preserveNewlines) {
+        // 2 newlines if not preserving
         markdownString += '\n\n';
       } else {
         markdownString += '\n';

src/markdown-to-draft.js

@@ -223,7 +223,7 @@ function markdownToDraft(string, options = {}) {
   var entityMap = {}; // entitymap will be returned as part of the final draftjs raw object
   var parsedData = md.parse(string, {}); // remarkable js takes markdown and makes it an array of style objects for us to easily parse
   var currentListType = null; // Because of how remarkable's data is formatted, we need to cache what kind of list we're currently dealing with
-  var previousBlockEndingLine = 1;
+  var previousBlockEndingLine = 0;
 
   // Allow user to define custom BlockTypes and Entities if they so wish
   const BlockTypes = Object.assign({}, DefaultBlockTypes, options.blockTypes || {});
@@ -277,20 +277,18 @@ function markdownToDraft(string, options = {}) {
       if (block && options.preserveNewlines) {
         // Re: previousBlockEndingLine.... omg.
         // So remarkable strips out empty newlines and doesn't make any entities to parse to restore them
-        // the only solution I could find is that there's a 2-value array on each block item called "lines" which is the start end line of the block element.
+        // the only solution I could find is that there's a 2-value array on each block item called "lines" which is the start and end line of the block element.
         // by keeping track of the PREVIOUS block element ending line and the NEXT block element starting line, we can find the difference between the new lines and insert
         // an appropriate number of extra paragraphs to re-create those newlines in draftjs.
         // This is probably my least favourite thing in this file, but not sure what could be better.
-        if (previousBlockEndingLine) {
-          var totalEmptyParagraphsToCreate = item.lines[0] - previousBlockEndingLine;
-          for (var i = 0; i < totalEmptyParagraphsToCreate; i++) {
-            blocks.push(DefaultBlockTypes.paragraph_open());
-          }
+        var totalEmptyParagraphsToCreate = item.lines[0] - previousBlockEndingLine;
+        for (var i = 0; i < totalEmptyParagraphsToCreate; i++) {
+          blocks.push(DefaultBlockTypes.paragraph_open());
         }
       }
 
       if (block) {
-        previousBlockEndingLine = item.lines[1] + 1;
+        previousBlockEndingLine = item.lines[1];
         blocks.push(block);
       }
     }

test/draft-to-markdown.spec.js

@@ -52,6 +52,21 @@ describe('draftToMarkdown', function () {
       expect(markdown).toEqual('**_bold/italic_** plain');
     });
 
+    it('handles unstyled blank lines', function () {
+      // draft-js can have blank lines that have block styles.
+      // This would result in double-application of markdown line prefixes.
+
+      /* eslint-disable */
+      const rawObject = {"blocks":[{"key":"8i76c","text":"a","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"3htgs","text":"b","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"c46o4","text":"","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"l5v1","text":"c","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"cbsdo","text":"","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"9i2da","text":"","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}},{"key":"9mr0v","text":"d","type":"unstyled","depth":0,"inlineStyleRanges":[],"entityRanges":[],"data":{}}],"entityMap":{}}
+      /* eslint-enable */
+
+      var markdown = draftToMarkdown(rawObject);
+      expect(markdown).toEqual('a\n\nb\n\nc\n\nd');
+
+      markdown = draftToMarkdown(rawObject, {preserveNewlines: true});
+      expect(markdown).toEqual('a\nb\n\nc\n\n\nd');
+    });
+
     it('handles blank lines with styled block types', function () {
       // draft-js can have blank lines that have block styles.
       // This would result in double-application of markdown line prefixes.
@@ -79,7 +94,7 @@ describe('draftToMarkdown', function () {
       expect(markdown).toEqual('> one\n> \n> blockquote\n\nHello :)');
 
       markdown = draftToMarkdown(rawObject, {preserveNewlines: true});
-      expect(markdown).toEqual('> one\n> \n> blockquote\n\nHello :)');
+      expect(markdown).toEqual('> one\n> \n> blockquote\nHello :)');
     });
   });
 

test/idempotency.spec.js

@@ -21,6 +21,18 @@ describe('idempotency', function () {
     var markdownFromDraft = draftToMarkdown(draftJSObject, {preserveNewlines: true});
 
     expect(markdownFromDraft).toEqual(markdownString);
+
+    markdownString = 'a\nb\n\nc\n\n\nd';
+    draftJSObject = markdownToDraft(markdownString, {preserveNewlines: true});
+    markdownFromDraft = draftToMarkdown(draftJSObject, {preserveNewlines: true});
+
+    expect(markdownFromDraft).toEqual(markdownString);
+
+    markdownString = '\n\na';
+    draftJSObject = markdownToDraft(markdownString, {preserveNewlines: true});
+    markdownFromDraft = draftToMarkdown(draftJSObject, {preserveNewlines: true});
+    expect(markdownFromDraft).toEqual(markdownString);
+
   });
 
   it('renders new lines text correctly with styled blocks', function () {
@@ -31,6 +43,13 @@ describe('idempotency', function () {
     expect(markdownFromDraft).toEqual(markdownString);
   });
 
+  it('renders blockquotes correctly', function () {
+    var markdownString = '> Hello I am Blockquote\n\nI am not\n\n> I am';
+    var draftJSObject = markdownToDraft(markdownString, {preserveNewlines: true});
+    var markdownFromDraft = draftToMarkdown(draftJSObject, {preserveNewlines: true});
+    expect(markdownFromDraft).toEqual(markdownString);
+  });
+
   it('renders italic text correctly', function () {
     var markdownString = '_I am italic_ …I am not italic.';
     var draftJSObject = markdownToDraft(markdownString);

test/markdown-to-draft.spec.js

@@ -23,6 +23,31 @@ describe('markdownToDraft', function () {
     expect(conversionResult.blocks[0].type).toEqual('unstyled');
   });
 
+  it('renders unstyled blank lines correctly', function () {
+    var markdown = 'a\nb\n\nc\n\n\nd';
+    var conversionResult = markdownToDraft(markdown);
+    expect(conversionResult.blocks[0].text).toEqual('a\nb');
+    expect(conversionResult.blocks[0].type).toEqual('unstyled');
+    expect(conversionResult.blocks[1].text).toEqual('c');
+    expect(conversionResult.blocks[1].type).toEqual('unstyled');
+    expect(conversionResult.blocks[2].text).toEqual('d');
+    expect(conversionResult.blocks[2].type).toEqual('unstyled');
+
+    conversionResult = markdownToDraft(markdown, {preserveNewlines: true});
+    expect(conversionResult.blocks[0].text).toEqual('a\nb');
+    expect(conversionResult.blocks[0].type).toEqual('unstyled');
+    expect(conversionResult.blocks[1].text).toEqual('');
+    expect(conversionResult.blocks[1].type).toEqual('unstyled');
+    expect(conversionResult.blocks[2].text).toEqual('c');
+    expect(conversionResult.blocks[2].type).toEqual('unstyled');
+    expect(conversionResult.blocks[3].text).toEqual('');
+    expect(conversionResult.blocks[3].type).toEqual('unstyled');
+    expect(conversionResult.blocks[4].text).toEqual('');
+    expect(conversionResult.blocks[4].type).toEqual('unstyled');
+    expect(conversionResult.blocks[5].text).toEqual('d');
+    expect(conversionResult.blocks[5].type).toEqual('unstyled');
+  });
+
   it('renders hardbreaks correctly', function () {
     var markdown = 'First line  \nSecond line';
     var conversionResult = markdownToDraft(markdown);