@milkdown/preset-commonmark 7.6.3 → 7.7.0

package/lib/node/paragraph.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../src/node/paragraph.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,aAAa,qCAAyB,CAAA;AAQnD,eAAO,MAAM,eAAe,oDAuBzB,CAAA;AAYH,eAAO,MAAM,mBAAmB,6CAG/B,CAAA;AASD,eAAO,MAAM,eAAe,0EAQ1B,CAAA"}
+{"version":3,"file":"paragraph.d.ts","sourceRoot":"","sources":["../../src/node/paragraph.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,aAAa,qCAAyB,CAAA;AAQnD,eAAO,MAAM,eAAe,oDA8BzB,CAAA;AAuBH,eAAO,MAAM,mBAAmB,6CAG/B,CAAA;AASD,eAAO,MAAM,eAAe,0EAQ1B,CAAA"}

package/lib/plugin/index.d.ts

@@ -3,6 +3,7 @@ export * from './remark-line-break';
 export * from './remark-inline-link-plugin';
 export * from './remark-html-transformer';
 export * from './remark-marker-plugin';
+export * from './remark-preserve-empty-line';
 export * from './inline-nodes-cursor-plugin';
 export * from './hardbreak-clear-mark-plugin';
 export * from './hardbreak-filter-plugin';

package/lib/plugin/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AAEtC,cAAc,8BAA8B,CAAA;AAE5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,qBAAqB,CAAA;AACnC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,8BAA8B,CAAA;AAE5C,cAAc,8BAA8B,CAAA;AAE5C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,2BAA2B,CAAA;AAEzC,cAAc,0BAA0B,CAAA;AACxC,cAAc,0BAA0B,CAAA"}

package/lib/plugin/remark-preserve-empty-line.d.ts

@@ -0,0 +1,2 @@
+export declare const remarkPreserveEmptyLinePlugin: import("@milkdown/utils").$Remark<"remark-preserve-empty-line", unknown>;
+//# sourceMappingURL=remark-preserve-empty-line.d.ts.map

package/lib/plugin/remark-preserve-empty-line.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"remark-preserve-empty-line.d.ts","sourceRoot":"","sources":["../../src/plugin/remark-preserve-empty-line.ts"],"names":[],"mappings":"AA4BA,eAAO,MAAM,6BAA6B,0EAGzC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@milkdown/preset-commonmark",
   "type": "module",
-  "version": "7.6.3",
+  "version": "7.7.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -36,14 +36,14 @@
     "remark-inline-links": "^7.0.0",
     "tslib": "^2.8.1",
     "unist-util-visit": "^5.0.0",
-    "@milkdown/exception": "7.6.3",
-    "@milkdown/utils": "7.6.3"
+    "@milkdown/utils": "7.7.0",
+    "@milkdown/exception": "7.7.0"
   },
   "devDependencies": {
-    "@milkdown/core": "7.6.3",
-    "@milkdown/ctx": "7.6.3",
-    "@milkdown/transformer": "7.6.3",
-    "@milkdown/prose": "7.6.3"
+    "@milkdown/ctx": "7.7.0",
+    "@milkdown/core": "7.7.0",
+    "@milkdown/prose": "7.7.0",
+    "@milkdown/transformer": "7.7.0"
   },
   "nx": {
     "targets": {

package/src/composed/plugins.ts

@@ -9,6 +9,7 @@ import {
   remarkInlineLinkPlugin,
   remarkLineBreak,
   remarkMarker,
+  remarkPreserveEmptyLinePlugin,
   syncHeadingIdPlugin,
   syncListOrderPlugin,
 } from '../plugin'
@@ -26,6 +27,7 @@ export const plugins: MilkdownPlugin[] = [
   remarkLineBreak,
   remarkHtmlTransformer,
   remarkMarker,
+  remarkPreserveEmptyLinePlugin,
 
   syncHeadingIdPlugin,
   syncListOrderPlugin,

package/src/node/list-item.ts

@@ -21,7 +21,7 @@ withMeta(listItemAttr, {
 /// Schema for list item node.
 export const listItemSchema = $nodeSchema('list_item', (ctx) => ({
   group: 'listItem',
-  content: '(paragraph|blockquote) block*',
+  content: 'paragraph block*',
   attrs: {
     label: {
       default: '•',

package/src/node/paragraph.ts

@@ -2,6 +2,8 @@ import { commandsCtx } from '@milkdown/core'
 import { setBlockType } from '@milkdown/prose/commands'
 import { $command, $nodeAttr, $nodeSchema, $useKeymap } from '@milkdown/utils'
 import { serializeText, withMeta } from '../__internal__'
+import { remarkPreserveEmptyLinePlugin } from '../plugin/remark-preserve-empty-line'
+import type { Ctx } from '@milkdown/ctx'
 
 /// HTML attributes for paragraph node.
 export const paragraphAttr = $nodeAttr('paragraph')
@@ -31,12 +33,30 @@ export const paragraphSchema = $nodeSchema('paragraph', (ctx) => ({
     match: (node) => node.type.name === 'paragraph',
     runner: (state, node) => {
       state.openNode('paragraph')
-      serializeText(state, node)
+      if (
+        (!node.content || node.content.size === 0) &&
+        shouldPreserveEmptyLine(ctx)
+      ) {
+        state.addNode('html', undefined, '<br />')
+      } else {
+        serializeText(state, node)
+      }
       state.closeNode()
     },
   },
 }))
 
+function shouldPreserveEmptyLine(ctx: Ctx) {
+  let shouldPreserveEmptyLine = false
+  try {
+    ctx.get(remarkPreserveEmptyLinePlugin.id)
+    shouldPreserveEmptyLine = true
+  } catch {
+    shouldPreserveEmptyLine = false
+  }
+  return shouldPreserveEmptyLine
+}
+
 withMeta(paragraphSchema.node, {
   displayName: 'NodeSchema<paragraph>',
   group: 'Paragraph',

package/src/plugin/index.ts

@@ -3,6 +3,7 @@ export * from './remark-line-break'
 export * from './remark-inline-link-plugin'
 export * from './remark-html-transformer'
 export * from './remark-marker-plugin'
+export * from './remark-preserve-empty-line'
 
 export * from './inline-nodes-cursor-plugin'
 

package/src/plugin/remark-preserve-empty-line.ts

@@ -0,0 +1,42 @@
+import type { Node } from '@milkdown/transformer'
+import { visit } from 'unist-util-visit'
+import { $remark } from '@milkdown/utils'
+import { withMeta } from '../__internal__'
+
+function visitImage(ast: Node) {
+  return visit(ast, 'paragraph', (node: Node & { children?: Node[] }) => {
+    if (node.children?.length !== 1) return
+    const firstChild = node.children?.[0]
+    if (!firstChild || firstChild.type !== 'html') return
+
+    const { value } = firstChild as Node & {
+      value: string
+    }
+
+    if (!['<br />', '<br>', '<br/>'].includes(value)) {
+      return
+    }
+
+    node.children.splice(0, 1)
+  })
+}
+
+/// @internal
+/// This plugin is used to preserve the empty line.
+/// Markdown will fold the empty line into the previous line by default.
+/// This plugin will preserve the empty line by converting `<br />` to `line-break`.
+/// This plugin should be used with `linebreakSchema` to work.
+export const remarkPreserveEmptyLinePlugin = $remark(
+  'remark-preserve-empty-line',
+  () => () => visitImage
+)
+
+withMeta(remarkPreserveEmptyLinePlugin.plugin, {
+  displayName: 'Remark<remarkPreserveEmptyLine>',
+  group: 'Remark',
+})
+
+withMeta(remarkPreserveEmptyLinePlugin.options, {
+  displayName: 'RemarkConfig<remarkPreserveEmptyLine>',
+  group: 'Remark',
+})