fix: remove marks from breaks that are the last node inside that mark (#101)

Author: d3m1d0v

src/core/markdown/Markdown.test.ts

@@ -11,6 +11,7 @@ import {MarkdownParser} from './MarkdownParser';
 import {MarkdownSerializer} from './MarkdownSerializer';
 
 const {schema} = builder;
+schema.nodes['hard_break'].spec.isBreak = true;
 const parser: Parser = new MarkdownParser(schema, new MarkdownIt('commonmark'), {
     paragraph: {type: 'block', name: 'paragraph'},
     heading: {
@@ -160,6 +161,9 @@ describe('markdown', () => {
 
     it('drops trailing hard breaks', () => serialize(doc(p('a', br(), br())), 'a'));
 
+    it('should remove marks from edge break', () =>
+        serialize(doc(p(strong('text', br()), 'text2')), '**text**\\\ntext2'));
+
     it('expels enclosing whitespace from inside emphasis', () =>
         serialize(
             doc(

src/core/markdown/MarkdownSerializer.js

@@ -189,12 +189,10 @@ export class MarkdownSerializerState {
         const progress = (node, _, index) => {
             let marks = node ? node.marks : [];
 
-            // Remove marks from `hard_break` that are the last node inside
+            // Remove marks from breaks (hard_break or soft_break) that are the last node inside
             // that mark to prevent parser edge cases with new lines just
             // before closing marks.
-            // (FIXME it'd be nice if we had a schema-agnostic way to
-            // identify nodes that serialize as hard breaks)
-            if (node && node.type.name === 'hard_break') {
+            if (node && node.type.spec.isBreak) {
                 marks = marks.filter(m => {
                     if (index + 1 == parent.childCount) return false;
                     const next = parent.child(index + 1);

src/core/types/serializer.ts

@@ -30,3 +30,10 @@ export interface SerializerMarkToken {
     escape?: boolean;
     expelEnclosingWhitespace?: boolean;
 }
+
+declare module 'prosemirror-model' {
+    interface NodeSpec {
+        /** Default false */
+        isBreak?: boolean;
+    }
+}

src/extensions/markdown/Breaks/Breaks.test.ts

@@ -1,20 +1,38 @@
 import {builders} from 'prosemirror-test-builder';
 import {parseDOM} from '../../../../tests/parse-dom';
+import {createMarkupChecker} from '../../../../tests/sameMarkup';
 import {ExtensionsManager} from '../../../core';
 import {BaseNode, BaseSpecsPreset} from '../../base/specs';
+import {BoldSpecs, boldMarkName} from '../../markdown/Bold/BoldSpecs';
 import {BreakNodeName, BreaksSpecs} from './BreaksSpecs';
 
-const {schema} = new ExtensionsManager({
-    extensions: (builder) => builder.use(BaseSpecsPreset, {}).use(BreaksSpecs, {}),
+const {schema, parser, serializer} = new ExtensionsManager({
+    extensions: (builder) => builder.use(BaseSpecsPreset, {}).use(BreaksSpecs, {}).use(BoldSpecs),
 }).buildDeps();
 
-const {doc, p, hb} = builders(schema, {
+const {doc, p, hb, sb, bold} = builders(schema, {
     doc: {nodeType: BaseNode.Doc},
     p: {nodeType: BaseNode.Paragraph},
     hb: {nodeType: BreakNodeName.HardBreak},
-}) as PMTestBuilderResult<'doc' | 'p' | 'hb'>;
+    sb: {nodeType: BreakNodeName.SoftBreak},
+    bold: {markType: boldMarkName},
+}) as PMTestBuilderResult<'doc' | 'p' | 'hb' | 'sb', 'bold'>;
+
+const {serialize} = createMarkupChecker({parser, serializer});
 
 describe('Breaks extension', () => {
+    it('should serialize hard break', () =>
+        serialize(
+            doc(p('Lorem ', bold('ipsum', hb()), 'dolor sit amet')),
+            'Lorem **ipsum**\\\ndolor sit amet',
+        ));
+
+    it('should serialize soft break', () =>
+        serialize(
+            doc(p('Lorem ', bold('ipsum', sb()), 'dolor sit amet')),
+            'Lorem **ipsum**\ndolor sit amet',
+        ));
+
     it('should parse html - br tag', () => {
         parseDOM(schema, '<div>hello<br>world!</div>', doc(p('hello', hb(), 'world!')));
     });

src/extensions/markdown/Breaks/BreaksSpecs/index.ts

@@ -13,7 +13,9 @@ export const BreaksSpecs: ExtensionAuto = (builder) => {
     builder.addNode(BreakNodeName.HardBreak, () => ({
         spec: {
             inline: true,
-            group: 'inline',
+            group: 'inline break',
+            marks: '',
+            isBreak: true,
             selectable: false,
             parseDOM: [{tag: 'br'}],
             toDOM() {
@@ -38,7 +40,9 @@ export const BreaksSpecs: ExtensionAuto = (builder) => {
     builder.addNode(BreakNodeName.SoftBreak, () => ({
         spec: {
             inline: true,
-            group: 'inline',
+            group: 'inline break',
+            marks: '',
+            isBreak: true,
             selectable: false,
             toDOM() {
                 return ['br'];