Add support for <ol>, <ul>, and <li>

Author: wooorm

handlers/index.js

@@ -7,6 +7,8 @@ exports.comment = require('./comment');
 exports.head = exports.math = exports.script = exports.style = exports.svg =
   exports.template = exports.title = ignore;
 
+exports.ol = exports.ul = require('./list');
+exports.li = require('./list-item');
 exports.strong = exports.b = require('./strong');
 exports.em = exports.i = require('./emphasis');
 exports.del = exports.s = exports.strike = require('./delete');

handlers/list-item.js

@@ -0,0 +1,73 @@
+'use strict';
+
+module.exports = listItem;
+
+var is = require('hast-util-is-element');
+var all = require('../all');
+
+function listItem(h, node, parent) {
+  var children = node.children;
+  var tail = !parent || parent.children[parent.children.length - 1] === node;
+  var head = children[0];
+  var checked = null;
+  var loose = false;
+  var checkbox;
+  var grandchildren;
+  var content;
+
+  /* Check if this node starts with a checkbox. */
+  if (head && is(head, 'p')) {
+    grandchildren = head.children;
+    checkbox = grandchildren[0];
+
+    if (checkbox && is(checkbox, 'input') && checkbox.properties.type === 'checkbox') {
+      checked = Boolean(checkbox.properties.checked);
+    } else {
+      checkbox = null;
+    }
+  }
+
+  content = all(h, node);
+
+  /* Remove initial spacing if we previously found a checkbox. */
+  if (checked !== null) {
+    grandchildren = content[0] && content[0].children;
+    head = grandchildren && grandchildren[0];
+
+    if (head && head.type === 'text' && head.value.charAt(0) === ' ') {
+      /* Remove text with one space, or remove that one initial space */
+      if (head.value.length === 1) {
+        content[0].children = grandchildren.slice(1);
+      } else {
+        head.value = head.value.slice(1);
+      }
+    }
+  }
+
+  if (content.length > 1) {
+    /* More than one node is always loose. */
+    loose = true;
+  } else if (content.length === 1) {
+    head = content[0];
+
+    if (head.type === 'text') {
+      /* Wrap `text` in `paragraph` (always tight). */
+      content = [{type: 'paragraph', children: content}];
+      loose = false;
+    } else if (head.type === 'paragraph') {
+      /* One `paragraph`, always tight. Ensure it isn’t empty. */
+      loose = false;
+
+      if (head.children.length === 0) {
+        content = [];
+      }
+    }
+  }
+
+  /* Last list-item is never loose. */
+  if (tail) {
+    loose = false;
+  }
+
+  return h(node, 'listItem', {loose: loose, checked: checked}, content);
+}

handlers/list.js

@@ -0,0 +1,36 @@
+'use strict';
+
+module.exports = list;
+
+var has = require('hast-util-has-property');
+var all = require('../all');
+
+function list(h, node) {
+  var ordered = node.tagName === 'ol';
+  var start = null;
+  var loose = false;
+  var content;
+  var length;
+  var index;
+
+  if (ordered) {
+    start = has(node, 'start') ? node.properties.start : 1;
+  }
+
+  content = all(h, node);
+  length = content.length;
+  index = -1;
+
+  while (++index < length) {
+    if (content[index].loose === true) {
+      loose = true;
+      break;
+    }
+  }
+
+  return h(node, 'list', {
+    ordered: ordered,
+    start: start,
+    loose: loose
+  }, content);
+}

tests/fixtures/ol/index.html

@@ -0,0 +1,53 @@
+<ol start="2">
+  <li>Alpha</li>
+  <li><p>Bravo</p></li>
+  <li><pre><code class="language-js">charlie();</code></pre></li>
+</ol>
+
+<p>Foo.</p>
+
+<ol>
+  <li>Alpha</li>
+  <li>Bravo</li>
+  <li>Charlie</li>
+</ol>
+
+<p>Bar.</p>
+
+<ol start="3">
+  <li><p>Alpha</p></li>
+  <li><p>Bravo</p></li>
+  <li><p>Charlie</p></li>
+</ol>
+
+<p>Baz.</p>
+
+<ol>
+  <li></li>
+  <li><div><p>Something else</p></div></li>
+</ol>
+
+<p>Qux.</p>
+
+<ol>
+  <li><div><p>Something else</p></div></li>
+  <li><script>foo();</script></li>
+</ol>
+
+<p>Quux.</p>
+
+<ol>
+  <li><div><p>Something else</p></div></li>
+  <li><p><input type="text"></p></li>
+</ol>
+
+<p>Quuux.</p>
+
+<ol>
+  <li><p><input type="checkbox" disabled checked> Bravo</p></li>
+  <li><p><input type="checkbox" disabled> Charlie</p></li>
+  <li class="task-list-item"><p><input type="checkbox" checked> Delta</p></li>
+  <li><p><input type="checkbox">Echo</p></li>
+  <li><p><input type="checkbox"><strong>Foxtrot</strong></p></li>
+  <li><p><input type="checkbox"> <strong>Golf</strong></p></li>
+</ol>

tests/fixtures/ol/index.json

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

tests/fixtures/ol/index.md

@@ -0,0 +1,41 @@
+2.  Alpha
+3.  Bravo
+4.  ```js
+    charlie();
+    ```
+
+Foo.
+
+1.  Alpha
+2.  Bravo
+3.  Charlie
+
+Bar.
+
+3.  Alpha
+4.  Bravo
+5.  Charlie
+
+Baz.
+
+1.··
+2.  Something else
+
+Qux.
+
+1.  Something else
+2.··
+
+Quux.
+
+1.  Something else
+2.··
+
+Quuux.
+
+1.  [x] Bravo
+2.  [ ] Charlie
+3.  [x] Delta
+4.  [ ] Echo
+5.  [ ] **Foxtrot**
+6.  [ ] **Golf**

tests/fixtures/ul/index.html

@@ -0,0 +1,53 @@
+<ul>
+  <li>Alpha</li>
+  <li><p>Bravo</p></li>
+  <li><pre><code class="language-js">charlie();</code></pre></li>
+</ul>
+
+<p>Foo.</p>
+
+<ul>
+  <li>Alpha</li>
+  <li>Bravo</li>
+  <li>Charlie</li>
+</ul>
+
+<p>Bar.</p>
+
+<ul>
+  <li><p>Alpha</p></li>
+  <li><p>Bravo</p></li>
+  <li><p>Charlie</p></li>
+</ul>
+
+<p>Baz.</p>
+
+<ul>
+  <li></li>
+  <li><div><p>Something else</p></div></li>
+</ul>
+
+<p>Qux.</p>
+
+<ul>
+  <li><div><p>Something else</p></div></li>
+  <li><script>foo();</script></li>
+</ul>
+
+<p>Quux.</p>
+
+<ul>
+  <li><div><p>Something else</p></div></li>
+  <li><p><input type="text"></p></li>
+</ul>
+
+<p>Quuux.</p>
+
+<ul>
+  <li><p><input type="checkbox" disabled checked> Bravo</p></li>
+  <li><p><input type="checkbox" disabled> Charlie</p></li>
+  <li class="task-list-item"><p><input type="checkbox" checked> Delta</p></li>
+  <li><p><input type="checkbox">Echo</p></li>
+  <li><p><input type="checkbox"><strong>Foxtrot</strong></p></li>
+  <li><p><input type="checkbox"> <strong>Golf</strong></p></li>
+</ul>

tests/fixtures/ul/index.json

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

tests/fixtures/ul/index.md

@@ -0,0 +1,41 @@
+-   Alpha
+-   Bravo
+-   ```js
+    charlie();
+    ```
+
+Foo.
+
+-   Alpha
+-   Bravo
+-   Charlie
+
+Bar.
+
+-   Alpha
+-   Bravo
+-   Charlie
+
+Baz.
+
+-···
+-   Something else
+
+Qux.
+
+-   Something else
+-···
+
+Quux.
+
+-   Something else
+-···
+
+Quuux.
+
+-   [x] Bravo
+-   [ ] Charlie
+-   [x] Delta
+-   [ ] Echo
+-   [ ] **Foxtrot**
+-   [ ] **Golf**