Add toFlow, toSpecificContent helpers on state

Author: wooorm

lib/handlers/a.js

@@ -20,7 +20,8 @@ export function a(state, node) {
     type: 'link',
     url: state.resolve(String(properties.href || '') || null),
     title: properties.title ? String(properties.title) : null,
-    // @ts-expect-error: assume valid children.
+    // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+    // We also support straddling later.
     children: state.all(node)
   }
   state.patch(node, result)

lib/handlers/blockquote.js

@@ -4,8 +4,6 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {wrapChildren} from '../util/wrap-children.js'
-
 /**
  * @param {State} state
  *   State.
@@ -16,7 +14,7 @@ import {wrapChildren} from '../util/wrap-children.js'
  */
 export function blockquote(state, node) {
   /** @type {Blockquote} */
-  const result = {type: 'blockquote', children: wrapChildren(state, node)}
+  const result = {type: 'blockquote', children: state.toFlow(state.all(node))}
   state.patch(node, result)
   return result
 }

lib/handlers/del.js

@@ -16,7 +16,8 @@ export function del(state, node) {
   /** @type {Delete} */
   const result = {
     type: 'delete',
-    // @ts-expect-error: assume valid children.
+    // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+    // We also support straddling later.
     children: state.all(node)
   }
   state.patch(node, result)

lib/handlers/dl.js

@@ -16,7 +16,6 @@
  */
 
 import {listItemsSpread} from '../util/list-items-spread.js'
-import {wrapListItems} from '../util/wrap-list-items.js'
 
 /**
  * @param {State} state
@@ -117,23 +116,31 @@ export function dl(state, node) {
  *   mdast nodes.
  */
 function handle(state, children) {
-  const nodes = wrapListItems(state, {type: 'element', tagName: 'x', children})
+  const nodes = state.all({type: 'element', tagName: 'x', children})
+  const listItems = state.toSpecificContent(nodes, create)
 
-  if (nodes.length === 0) {
+  if (listItems.length === 0) {
     return []
   }
 
-  if (nodes.length === 1) {
-    return nodes[0].children
+  if (listItems.length === 1) {
+    return listItems[0].children
   }
 
   return [
     {
       type: 'list',
       ordered: false,
       start: null,
-      spread: listItemsSpread(nodes),
-      children: nodes
+      spread: listItemsSpread(listItems),
+      children: listItems
     }
   ]
 }
+
+/**
+ * @returns {ListContent}
+ */
+function create() {
+  return {type: 'listItem', spread: false, checked: null, children: []}
+}

lib/handlers/em.js

@@ -14,11 +14,8 @@
  */
 export function em(state, node) {
   /** @type {Emphasis} */
-  const result = {
-    type: 'emphasis',
-    // @ts-expect-error: assume valid children.
-    children: state.all(node)
-  }
+  // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+  const result = {type: 'emphasis', children: state.all(node)}
   state.patch(node, result)
   return result
 }

lib/handlers/heading.js

@@ -21,7 +21,7 @@ export function heading(state, node) {
     type: 'heading',
     // @ts-expect-error: fine.
     depth,
-    // @ts-expect-error: assume valid children.
+    // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
     children: state.all(node)
   }
   state.patch(node, result)

lib/handlers/index.js

@@ -9,7 +9,6 @@
  * @typedef {Extract<Node, import('unist').Parent>} Parent
  */
 
-import {wrapChildren} from '../util/wrap-children.js'
 import {a} from './a.js'
 import {base} from './base.js'
 import {blockquote} from './blockquote.js'
@@ -124,26 +123,26 @@ export const handlers = {
   thead: all,
   time: all,
 
-  address: wrapChildren,
-  article: wrapChildren,
-  aside: wrapChildren,
-  body: wrapChildren,
-  center: wrapChildren,
-  div: wrapChildren,
-  fieldset: wrapChildren,
-  figcaption: wrapChildren,
-  figure: wrapChildren,
-  form: wrapChildren,
-  footer: wrapChildren,
-  header: wrapChildren,
-  hgroup: wrapChildren,
-  html: wrapChildren,
-  legend: wrapChildren,
-  main: wrapChildren,
-  multicol: wrapChildren,
-  nav: wrapChildren,
-  picture: wrapChildren,
-  section: wrapChildren,
+  address: flow,
+  article: flow,
+  aside: flow,
+  body: flow,
+  center: flow,
+  div: flow,
+  fieldset: flow,
+  figcaption: flow,
+  figure: flow,
+  form: flow,
+  footer: flow,
+  header: flow,
+  hgroup: flow,
+  html: flow,
+  legend: flow,
+  main: flow,
+  multicol: flow,
+  nav: flow,
+  picture: flow,
+  section: flow,
 
   a,
   audio: media,
@@ -201,6 +200,16 @@ export const handlers = {
 
 function ignore() {}
 
+/**
+ * @param {State} state
+ *   State.
+ * @param {Parent} node
+ *   Parent to transform.
+ */
+function flow(state, node) {
+  return state.toFlow(state.all(node))
+}
+
 /**
  * @param {State} state
  *   State.

lib/handlers/li.js

@@ -4,8 +4,6 @@
  * @typedef {import('../state.js').State} State
  */
 
-import {wrapChildren} from '../util/wrap-children.js'
-
 /**
  * @param {State} state
  *   State.
@@ -44,14 +42,14 @@ export function li(state, node) {
     }
   }
 
-  const content = wrapChildren(state, clone || node)
+  const children = state.toFlow(state.all(clone || node))
 
   /** @type {ListItem} */
   const result = {
     type: 'listItem',
-    spread: content.length > 1,
+    spread: children.length > 1,
     checked,
-    children: content
+    children
   }
   state.patch(node, result)
   return result

lib/handlers/list.js

@@ -1,11 +1,11 @@
 /**
  * @typedef {import('hast').Element} Element
  * @typedef {import('mdast').List} List
+ * @typedef {import('mdast').ListContent} ListContent
  * @typedef {import('../state.js').State} State
  */
 
 import {listItemsSpread} from '../util/list-items-spread.js'
-import {wrapListItems} from '../util/wrap-list-items.js'
 
 /**
  * @param {State} state
@@ -17,7 +17,7 @@ import {wrapListItems} from '../util/wrap-list-items.js'
  */
 export function list(state, node) {
   const ordered = node.tagName === 'ol'
-  const children = wrapListItems(state, node)
+  const children = state.toSpecificContent(state.all(node), create)
   /** @type {number | null} */
   let start = null
 
@@ -39,3 +39,10 @@ export function list(state, node) {
   state.patch(node, result)
   return result
 }
+
+/**
+ * @returns {ListContent}
+ */
+function create() {
+  return {type: 'listItem', spread: false, checked: null, children: []}
+}

lib/handlers/media.js

@@ -74,7 +74,8 @@ export function media(state, node) {
     type: 'link',
     title: properties.title ? String(properties.title) : null,
     url: state.resolve(src),
-    // @ts-expect-error Assume phrasing content.
+    // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+    // We also support straddling later.
     children: nodes
   }
   state.patch(node, result)

lib/handlers/p.js

@@ -13,15 +13,12 @@
  *   mdast node.
  */
 export function p(state, node) {
-  const nodes = state.all(node)
+  const children = state.all(node)
 
-  if (nodes.length > 0) {
+  if (children.length > 0) {
     /** @type {Paragraph} */
-    const result = {
-      type: 'paragraph',
-      // @ts-expect-error Assume phrasing content.
-      children: nodes
-    }
+    // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+    const result = {type: 'paragraph', children}
     state.patch(node, result)
     return result
   }

lib/handlers/root.js

@@ -18,7 +18,6 @@ export function root(state, node) {
   let children = state.all(node)
 
   if (state.options.document || wrapNeeded(children)) {
-    // @ts-expect-error: improve `all`?
     children = wrap(children)
   }
 

lib/handlers/strong.js

@@ -14,11 +14,8 @@
  */
 export function strong(state, node) {
   /** @type {Strong} */
-  const result = {
-    type: 'strong',
-    // @ts-expect-error: assume valid children.
-    children: state.all(node)
-  }
+  // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+  const result = {type: 'strong', children: state.all(node)}
   state.patch(node, result)
   return result
 }

lib/handlers/table-cell.js

@@ -13,14 +13,9 @@
  *   mdast node.
  */
 export function tableCell(state, node) {
-  const children = state.all(node)
-
   /** @type {TableCell} */
-  const result = {
-    type: 'tableCell',
-    // @ts-expect-error: assume valid children.
-    children
-  }
+  // @ts-expect-error: allow potentially “invalid” nodes, they might be unknown.
+  const result = {type: 'tableCell', children: state.all(node)}
   state.patch(node, result)
 
   if (node.properties) {

lib/handlers/table-row.js

@@ -1,6 +1,7 @@
 /**
  * @typedef {import('hast').Element} Element
  * @typedef {import('mdast').TableRow} TableRow
+ * @typedef {import('mdast').RowContent} RowContent
  * @typedef {import('../state.js').State} State
  */
 
@@ -13,12 +14,17 @@
  *   mdast node.
  */
 export function tableRow(state, node) {
+  const children = state.toSpecificContent(state.all(node), create)
+
   /** @type {TableRow} */
-  const result = {
-    type: 'tableRow',
-    // @ts-expect-error: assume valid children.
-    children: state.all(node)
-  }
+  const result = {type: 'tableRow', children}
   state.patch(node, result)
   return result
 }
+
+/**
+ * @returns {RowContent}
+ */
+function create() {
+  return {type: 'tableCell', children: []}
+}