Add wrap helper on state

Author: wooorm

lib/footer.js

@@ -6,7 +6,6 @@
  */
 
 import {normalizeUri} from 'micromark-util-sanitize-uri'
-import {wrap} from './wrap.js'
 
 /**
  * Generate a hast footer for called footnote definitions.
@@ -89,7 +88,7 @@ export function footer(state) {
       type: 'element',
       tagName: 'li',
       properties: {id: state.clobberPrefix + 'fn-' + safeId},
-      children: wrap(content, true)
+      children: state.wrap(content, true)
     }
 
     state.patch(def, listItem)
@@ -121,7 +120,7 @@ export function footer(state) {
         type: 'element',
         tagName: 'ol',
         properties: {},
-        children: wrap(listItems, true)
+        children: state.wrap(listItems, true)
       },
       {type: 'text', value: '\n'}
     ]

lib/handlers/blockquote.js

@@ -4,8 +4,6 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {wrap} from '../wrap.js'
-
 /**
  * Turn an mdast `blockquote` node into hast.
  *
@@ -22,7 +20,7 @@ export function blockquote(state, node) {
     type: 'element',
     tagName: 'blockquote',
     properties: {},
-    children: wrap(state.all(node), true)
+    children: state.wrap(state.all(node), true)
   }
   state.patch(node, result)
   return state.applyData(node, result)

lib/handlers/list.js

@@ -5,8 +5,6 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {wrap} from '../wrap.js'
-
 /**
  * Turn an mdast `list` node into hast.
  *
@@ -48,7 +46,7 @@ export function list(state, node) {
     type: 'element',
     tagName: node.ordered ? 'ol' : 'ul',
     properties,
-    children: wrap(results, true)
+    children: state.wrap(results, true)
   }
   state.patch(node, result)
   return state.applyData(node, result)

lib/handlers/root.js

@@ -5,8 +5,6 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {wrap} from '../wrap.js'
-
 /**
  * Turn an mdast `root` node into hast.
  *
@@ -19,7 +17,7 @@ import {wrap} from '../wrap.js'
  */
 export function root(state, node) {
   /** @type {HastRoot} */
-  const result = {type: 'root', children: wrap(state.all(node))}
+  const result = {type: 'root', children: state.wrap(state.all(node))}
   state.patch(node, result)
   return state.applyData(node, result)
 }

lib/handlers/table-row.js

@@ -14,8 +14,6 @@
  * @typedef {Extract<Nodes, Parent>} Parents
  */
 
-import {wrap} from '../wrap.js'
-
 /**
  * Turn an mdast `tableRow` node into hast.
  *
@@ -67,7 +65,7 @@ export function tableRow(state, node, parent) {
     type: 'element',
     tagName: 'tr',
     properties: {},
-    children: wrap(cells, true)
+    children: state.wrap(cells, true)
   }
   state.patch(node, result)
   return state.applyData(node, result)

lib/handlers/table.js

@@ -5,7 +5,6 @@
  */
 
 import {pointStart, pointEnd} from 'unist-util-position'
-import {wrap} from '../wrap.js'
 
 /**
  * Turn an mdast `table` node into hast.
@@ -29,7 +28,7 @@ export function table(state, node) {
       type: 'element',
       tagName: 'thead',
       properties: {},
-      children: wrap([firstRow], true)
+      children: state.wrap([firstRow], true)
     }
     state.patch(node.children[0], head)
     tableContent.push(head)
@@ -41,7 +40,7 @@ export function table(state, node) {
       type: 'element',
       tagName: 'tbody',
       properties: {},
-      children: wrap(rows, true)
+      children: state.wrap(rows, true)
     }
 
     const start = pointStart(node.children[1])
@@ -55,7 +54,7 @@ export function table(state, node) {
     type: 'element',
     tagName: 'table',
     properties: {},
-    children: wrap(tableContent, true)
+    children: state.wrap(tableContent, true)
   }
   state.patch(node, result)
   return state.applyData(node, result)

lib/state.js

@@ -118,6 +118,8 @@
  *   Transform an mdast node to hast.
  * @property {(node: MdastNodes) => Array<HastElementContent>} all
  *   Transform the children of an mdast parent to hast.
+ * @property {<Type extends HastContent>(nodes: Array<Type>, loose?: boolean | null | undefined) => Array<Type | HastText>} wrap
+ *   Wrap `nodes` with line endings between each node, adds initial/final line endings when `loose`.
  * @property {(left: MdastNodeWithData | PositionLike | null | undefined, right: HastElementContent) => HastElementContent} augment
  *   Like `state` but lower-level and usable on non-elements.
  *   Deprecated: use `patch` and `applyData`.
@@ -223,6 +225,7 @@ export function createState(tree, options) {
   state.applyData = applyData
   state.one = oneBound
   state.all = allBound
+  state.wrap = wrap
   // To do: next major: remove `augment`.
   state.augment = augment
 
@@ -539,3 +542,36 @@ function defaultUnknownHandler(state, node) {
   state.patch(node, result)
   return state.applyData(node, result)
 }
+
+/**
+ * Wrap `nodes` with line endings between each node.
+ *
+ * @template {HastContent} Type
+ *   Node type.
+ * @param {Array<Type>} nodes
+ *   List of nodes to wrap.
+ * @param {boolean | null | undefined} [loose=false]
+ *   Whether to add line endings at start and end.
+ * @returns {Array<Type | HastText>}
+ *   Wrapped nodes.
+ */
+export function wrap(nodes, loose) {
+  /** @type {Array<Type | HastText>} */
+  const result = []
+  let index = -1
+
+  if (loose) {
+    result.push({type: 'text', value: '\n'})
+  }
+
+  while (++index < nodes.length) {
+    if (index) result.push({type: 'text', value: '\n'})
+    result.push(nodes[index])
+  }
+
+  if (loose && nodes.length > 0) {
+    result.push({type: 'text', value: '\n'})
+  }
+
+  return result
+}

lib/wrap.js

@@ -294,6 +294,9 @@ Info passed around about the current state (TypeScript type).
     — transform an mdast node to hast
 *   `all` (`(node: MdastNode) => Array<HastNode>`)
     — transform the children of an mdast parent to hast
+*   `wrap` (`<Type extends HastNode>(nodes: Array<Type>, loose?: boolean) => Array<Type | HastText>`)
+    — wrap `nodes` with line endings between each node, adds initial/final line
+    endings when `loose`
 *   `handlers` ([`Handlers`][api-handlers])
     — applied node handlers
 *   `footnoteById` (`Record<string, MdastFootnoteDefinition>`)