Add support for <dl>, <dt>, <dd>

Closes GH-32.

Author: wooorm

lib/handlers/data-list.js

@@ -0,0 +1,96 @@
+'use strict'
+
+module.exports = dataList
+
+var is = require('hast-util-is-element')
+var wrapListItems = require('../util/wrap-list-items')
+var loose = require('../util/list-loose')
+
+function dataList(h, node) {
+  var children = node.children
+  var length = children.length
+  var index = -1
+  var clean = []
+  var groups = []
+  var content
+  var breakpoint
+  var title
+  var child
+  var group = {titles: [], definitions: []}
+
+  // Unwrap `<div>`s
+  while (++index < length) {
+    child = children[index]
+    clean = clean.concat(is(child, 'div') ? child.children : child)
+  }
+
+  length = clean.length
+  index = -1
+
+  // Group titles and definitions.
+  while (++index < length) {
+    child = clean[index]
+    title = is(child, 'dt')
+
+    if (title && breakpoint) {
+      groups.push(group)
+      group = {titles: [], definitions: []}
+    }
+
+    group[title ? 'titles' : 'definitions'].push(child)
+    breakpoint = is(child, 'dd')
+  }
+
+  groups.push(group)
+
+  // Group titles and definitions.
+  length = groups.length
+  index = -1
+  content = []
+
+  while (++index < length) {
+    group = groups[index]
+    group = handle(h, group.titles).concat(handle(h, group.definitions))
+
+    if (group.length !== 0) {
+      content.push({
+        type: 'listItem',
+        loose: group.length > 1,
+        checked: null,
+        children: group
+      })
+    }
+  }
+
+  // Create a list if there are items.
+  if (content.length !== 0) {
+    return h(
+      node,
+      'list',
+      {ordered: false, start: null, loose: loose(content)},
+      content
+    )
+  }
+}
+
+function handle(h, category) {
+  var nodes = wrapListItems(h, {children: category})
+
+  if (nodes.length === 0) {
+    return []
+  }
+
+  if (nodes.length === 1) {
+    return nodes[0].children
+  }
+
+  return [
+    {
+      type: 'list',
+      ordered: false,
+      start: null,
+      loose: loose(nodes),
+      children: nodes
+    }
+  ]
+}

lib/handlers/index.js

@@ -81,10 +81,11 @@ exports.section = wrapped
 
 exports.base = require('./base')
 exports.ol = exports.ul = exports.dir = require('./list')
+exports.dl = require('./data-list')
 exports.table = require('./table')
 exports.tr = require('./table-row')
 exports.th = exports.td = require('./table-cell')
-exports.li = require('./list-item')
+exports.dt = exports.dd = exports.li = require('./list-item')
 exports.strong = exports.b = require('./strong')
 exports.em = exports.i = exports.u = exports.mark = require('./emphasis')
 exports.del = exports.s = exports.strike = require('./delete')

test/fixtures/dl/index.html

@@ -0,0 +1,85 @@
+<dl>
+  <dt>Firefox</dt>
+  <dd>A web browser.</dd>
+</dl>
+
+<p>Alpha.</p>
+
+<dl>
+  <dt>Firefox</dt>
+  <dt>Mozilla Firefox</dt>
+  <dt>Fx</dt>
+  <dd>A web browser.</dd>
+</dl>
+
+<p>Bravo.</p>
+
+<dl>
+  <dt>Firefox</dt>
+  <dd>A web browser.</dd>
+  <dd>A Red Panda.</dd>
+</dl>
+
+<p>Charlie.</p>
+
+<dl>
+  <dt>Firefox</dt>
+  <dd>A web browser.</dd>
+  <dd><p>A Red Panda.</p></dd>
+  <dd><pre><code class="language-js">charlie();</code></pre></dd>
+</dl>
+
+<p>Delta.</p>
+
+<dl>
+  <div>
+    <dt>Firefox</dt>
+    <dd>A web browser.</dd>
+    <dd>A Red Panda.</dd>
+  </div>
+  <div>
+    <dt>Chrome</dt>
+    <dd>A web browser.</dd>
+    <dd>A chemical element.</dd>
+  </div>
+</dl>
+
+<p>Echo.</p>
+
+<dl></dl>
+
+<p>Foxtrot.</p>
+
+<dl>
+  <dt>Chrome</dt>
+  <dd><div><p>A web browser.</p></div></dd>
+  <dt></dt>
+  <dd></dd>
+</dl>
+
+<p>Golf.</p>
+
+<dl>
+  <dt>Chrome</dt>
+  <script>foo();</script>
+  <dd>A web browser.</dd>
+</dl>
+
+<p>Hotel.</p>
+
+<dl>
+  <dt><div><p>Firefox</p></div></dt>
+  <dd><p><input type="text"></p></dd>
+</dl>
+
+<p>India.</p>
+
+<dl>
+  <dt>Firefox.</dt>
+</dl>
+
+<p>Juliett.</p>
+
+<dl>
+  <dd>A web browser.</dd>
+</dl>

test/fixtures/dl/index.json

@@ -0,0 +1,3 @@
+{
+  "fragment": true
+}

test/fixtures/dl/index.md

@@ -0,0 +1,66 @@
+-   Firefox
+
+    A web browser.
+
+Alpha.
+
+-   -   Firefox
+    -   Mozilla Firefox
+    -   Fx
+
+    A web browser.
+
+Bravo.
+
+-   Firefox
+
+    -   A web browser.
+    -   A Red Panda.
+
+Charlie.
+
+-   Firefox
+
+    -   A web browser.
+    -   A Red Panda.
+    -   ```js
+        charlie();
+        ```
+
+Delta.
+
+-   Firefox
+
+    -   A web browser.
+    -   A Red Panda.
+
+-   Chrome
+
+    -   A web browser.
+    -   A chemical element.
+
+Echo.
+
+Foxtrot.
+
+-   Chrome
+
+    A web browser.
+
+Golf.
+
+-   Chrome
+
+    A web browser.
+
+Hotel.
+
+-   Firefox
+
+India.
+
+-   Firefox.
+
+Juliett.
+
+-   A web browser.