Fix style of generated TOCs

This update adds extra new lines when a TOC entry has both a title and contents, making for cleaner looking tables.
remarkjs · May 25, 2015 · d0eaf12 · d0eaf12
1 parent e2a1a00
commit d0eaf12
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 7 deletions.
diff --git a/Readme.md b/Readme.md
@@ -41,8 +41,11 @@ UMD (globals/AMD/CommonJS) ([uncompressed](mdast-toc.js) and [compressed](mdast-
 ## Table of Contents
 
 *   [Usage](#usage)
+
 *   [API](#api)
+
     *   [mdast.use(toc, options)](#mdastusetoc-options)
+
 *   [License](#license)
 
 ## Usage
@@ -72,8 +75,11 @@ Yields:
 
 ```markdown
 -   [Usage](#usage)
+
 -   [API](#api)
+
     -   [mdast.use(toc, options)](#mdastusetoc-options)
+
 -   [License](#license)
 ```
 

diff --git a/index.js b/index.js
@@ -214,7 +214,10 @@ function listItem() {
  */
 function insert(node, parent, library) {
     var children = parent.children;
-    var last = children[children.length - 1];
+    var index = -1;
+    var length = children.length;
+    var last = children[length - 1];
+    var isLoose = false;
     var item;
 
     if (node.depth === 1) {
@@ -247,8 +250,6 @@ function insert(node, parent, library) {
     } else if (parent.type === LIST) {
         item = listItem();
 
-        item.loose = true;
-
         insert(node, item, library);
 
         children.push(item);
@@ -260,6 +261,28 @@ function insert(node, parent, library) {
 
         children.push(item);
     }
+
+    /*
+     * Properly style list-items with new lines.
+     */
+
+    if (parent.type === LIST_ITEM) {
+        parent.loose = children.length > 1;
+    } else {
+        while (++index < length) {
+            if (children[index].loose) {
+                isLoose = true;
+
+                break;
+            }
+        }
+
+        index = -1;
+
+        while (++index < length) {
+            children[index].loose = isLoose;
+        }
+    }
 }
 
 /**

diff --git a/mdast-toc.js b/mdast-toc.js
@@ -398,7 +398,10 @@ function listItem() {
  */
 function insert(node, parent, library) {
     var children = parent.children;
-    var last = children[children.length - 1];
+    var index = -1;
+    var length = children.length;
+    var last = children[length - 1];
+    var isLoose = false;
     var item;
 
     if (node.depth === 1) {
@@ -431,8 +434,6 @@ function insert(node, parent, library) {
     } else if (parent.type === LIST) {
         item = listItem();
 
-        item.loose = true;
-
         insert(node, item, library);
 
         children.push(item);
@@ -444,6 +445,28 @@ function insert(node, parent, library) {
 
         children.push(item);
     }
+
+    /*
+     * Properly style list-items with new lines.
+     */
+
+    if (parent.type === LIST_ITEM) {
+        parent.loose = children.length > 1;
+    } else {
+        while (++index < length) {
+            if (children[index].loose) {
+                isLoose = true;
+
+                break;
+            }
+        }
+
+        index = -1;
+
+        while (++index < length) {
+            children[index].loose = isLoose;
+        }
+    }
 }
 
 /**

diff --git a/mdast-toc.min.js b/mdast-toc.min.js
diff --git a/test/fixtures/custom-heading/Output.md b/test/fixtures/custom-heading/Output.md
@@ -3,8 +3,10 @@
 ## Fooooo
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/image-in-link-in-heading/Output.md b/test/fixtures/image-in-link-in-heading/Output.md
@@ -3,8 +3,10 @@
 ## [![](./some-table.png "Table of Contents")](some-link.com)
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/normal-dashes/Output.md b/test/fixtures/normal-dashes/Output.md
@@ -3,8 +3,10 @@
 ## Table-of-contents
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/normal-nesting-inverted/Output.md b/test/fixtures/normal-nesting-inverted/Output.md
@@ -5,7 +5,9 @@
 -   -   [Something if](#something-if)
 
 -   [Something else](#something-else)
+
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 ## Something if

diff --git a/test/fixtures/normal-singular/Output.md b/test/fixtures/normal-singular/Output.md
@@ -3,8 +3,10 @@
 ## Table of Content
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/normal-toc/Output.md b/test/fixtures/normal-toc/Output.md
@@ -3,8 +3,10 @@
 ## TOC
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/normal/Output.md b/test/fixtures/normal/Output.md
@@ -3,8 +3,10 @@
 ## Table of Contents
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [Something iffi](#something-iffi)
 
 # Something if

diff --git a/test/fixtures/slug-for-images-and-links/Output.md b/test/fixtures/slug-for-images-and-links/Output.md
@@ -3,8 +3,10 @@
 ## Table of Contents
 
 -   [Something if](#something-if)
+
     -   [Something else](#something-else)
     -   [Something elsefi](#something-elsefi)
+
 -   [another title](#another-title)
 
 # [Something if](http://a-link.com)