initial commit

Author: BarryThePenguin

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{json,svg,remarkrc,eslintrc}]
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+*.log
+coverage/
+node_modules/
+mdast-util-toc.js
+mdast-util-toc.min.js

.remarkignore

@@ -0,0 +1 @@
+test/

.remarkrc

@@ -0,0 +1,14 @@
+{
+  "output": true,
+  "plugins": [
+    "comment-config",
+    "lint",
+    "github",
+    "usage",
+    "slug",
+    "validate-links"
+  ],
+  "settings": {
+    "bullet": "*"
+  }
+}

.travis.yml

@@ -0,0 +1,28 @@
+language: node_js
+node_js:
+- '0.11'
+- '0.12'
+- '4.0'
+- '5.0'
+- '6.0'
+sudo: false
+after_success:
+- bash <(curl -s https://codecov.io/bash)
+deploy:
+  matrix:
+  - provider: npm
+    email: [email protected]
+    api_key:
+      secure: IjSqlNrFIB507wJM1IN54lmym0cvjd6V12W3U6pqFDy4Kfz9Rm781AD0gTL9T5VMZp8cbSteclXEGS2SuGbY7+O20mstPQJoTTxgHCIo/RePZElZNU8WQmE/vt0Phru38Qi5c0sKnvxDukiS5bmkK1Bivlu0KME01ObCM1TQ33iHhiNkjhCDm9PUcdW0EMcEwfuVfwHBBL1e8ZnHgadeS9wIsiqGueJkdJ3iChkqt3DrFN0zjI1YHju2MqoUV2XM7bu2VLmvUoGsRq18JRciLHw7eoJVR2uXA96QMYJR6qMB9DLyilbTETLveWFV5p/lL+i0ELVs02EnRNBJKWzKmYH/QIyXOJuVAHeN+m+4ucyuXMfJ5j78krHeVvpr5dXT3UBcAQgwLIG+aDv32gdxsUF4jAP45ZAcVv9cNaC+DmRuTN69e4yr22BYd3OtquYmapnW2YZ4q4OZ3f8BE1y8aK7K5mC+u0nIgc8z/DvitwLkOr8uYbZQtxL8rdNRXfKqIvRw49hsEzSxwspgYqdiACa58bW8lDymYednCE0/QwuI0wzVnCSwhCYJARe2ebyewZZ3TLGCOyWLylcl06L+6WvW3tn+yGu3Fi0pwprWRQZe+D745WuHD52KRx3rs3bxQ7gBT2LLIjcV74WWRcgRujWGg8oBbjfG3Et9Z//sjns=
+    on:
+      tags: true
+      node: '6.0'
+  - provider: releases
+    api_key:
+      secure: bx7oTgpt1rSzisE0H60XTqVnwjBxJRBG60yWeoayCPgvSXXQGFw0oNv6nXiklF7CAvIg7aQWLUKMPvDn1W6+ICYPPfaWu+SgF+IkPoXfd+hT616QtEgSekTa1/5YEyc21D7J98EWG2CTmGUYDfjWDGBMoysPZuFGcyEAVLES8143uUdc5ybB9qoBhGi9dTULsCUd0wmuGnchGgqDfkqtQPPnt5wb09w+1mNcZ76nQ1bi2UWuIzeHt+fms3TNqfsNodcJX358V7EHo/V/vN3Y+br7XKrVH+TVgs01By+Ugo4mWeE3BPQqjM/vO4JtwcDSnDht8EJ5MzrHkrDtGnRuflD2rNu4IOMDOU9IjraKChgqFg+8ZRXXJWbjB13x4oUZYVRR23fs1gCley0wq2t5up6myP77xleFwPFfCECt5+tG0YH5kl6zKaPoDUZSxqLmbDAYw2vZDvEMBEZmWG0p7FfuZQY3lypBUyKYpR6ojB+b/b5VXF7WUExXYjSG+QokVzQ2SW6W6Pp6p/FvqwEuzXGVzMMq8Z2pvmqw8LcOVypu+1M9ktczrMOrZ1TmGhqUVfnfiHWQem8E8KX6U6PD84mZud33zFBigl21Eznjc7eLrf6sjj4HVNrR9vCsVhvTTV+9KqhVUnwZbzRl7BeDMg+udo4hmdYQSlSr31ube18=
+    file:
+    - remark-toc.js
+    - remark-toc.min.js
+    on:
+      tags: true
+      node: '6.0'

README.md

@@ -0,0 +1 @@
+

index.js

@@ -0,0 +1,12 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+'use strict';
+
+/* Expose. */
+module.exports = require('./lib/index.js');

lib/contents.js

@@ -0,0 +1,66 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+/* Expose. */
+module.exports = contents;
+
+/* Dependencies */
+var list = require('./list');
+var insert = require('./insert');
+
+/**
+ * Transform a list of heading objects to a markdown list.
+ *
+ * @param {Array.<Object>} map - Heading-map to insert.
+ * @param {boolean?} [tight] - Prefer tight list-items.
+ * @return {Object} - List node.
+ */
+function contents(map, tight) {
+    var minDepth = Infinity;
+    var index = -1;
+    var length = map.length;
+    var table;
+
+    /*
+     * Find minimum depth.
+     */
+
+    while (++index < length) {
+        if (map[index].depth < minDepth) {
+            minDepth = map[index].depth;
+        }
+    }
+
+    /*
+     * Normalize depth.
+     */
+
+    index = -1;
+
+    while (++index < length) {
+        map[index].depth -= minDepth - 1;
+    }
+
+    /*
+     * Construct the main list.
+     */
+
+    table = list();
+
+    /*
+     * Add TOC to list.
+     */
+
+    index = -1;
+
+    while (++index < length) {
+        insert(map[index], table, tight);
+    }
+
+    return table;
+}

lib/index.js

@@ -0,0 +1,37 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+/* Expose. */
+module.exports = attacher;
+
+/* Dependencies */
+var toExpression = require('./to-expression');
+var search = require('./search');
+var contents = require('./contents');
+
+/**
+ * Attacher.
+ *
+ * @param {Mdast} node - MDAST.
+ * @param {Object} options - Configuration.
+ * @return {Array} - TOC Markdown.
+ */
+function attacher(node, options) {
+    var settings = options || {};
+    var heading = settings.heading ? toExpression(settings.heading) : null;
+    var depth = settings.maxDepth || 6;
+    var tight = settings.tight;
+
+    var result = search(node, heading, depth);
+
+    if (result.index === null || !result.map.length) {
+        return [];
+    }
+
+    return [contents(result.map, tight)];
+}

lib/insert.js

@@ -0,0 +1,108 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+ /* Expose. */
+ module.exports = insert;
+
+ /* Dependencies */
+ var listItem = require('./list-item');
+ var list = require('./list');
+
+ /* Constants */
+ var LIST = 'list';
+ var LIST_ITEM = 'listItem';
+ var PARAGRAPH = 'paragraph';
+ var LINK = 'link';
+ var TEXT = 'text';
+
+ /**
+  * Insert a `node` into a `parent`.
+  *
+  * @param {Object} node - `node` to insert.
+  * @param {Object} parent - Parent of `node`.
+  * @param {boolean?} [tight] - Prefer tight list-items.
+  * @return {undefined}
+  */
+ function insert(node, parent, tight) {
+     var children = parent.children;
+     var length = children.length;
+     var last = children[length - 1];
+     var isLoose = false;
+     var index;
+     var item;
+
+     if (node.depth === 1) {
+         item = listItem();
+
+         item.children.push({
+             type: PARAGRAPH,
+             children: [
+                 {
+                     type: LINK,
+                     title: null,
+                     url: '#' + node.id,
+                     children: [
+                         {
+                             type: TEXT,
+                             value: node.value
+                         }
+                     ]
+                 }
+             ]
+         });
+
+         children.push(item);
+     } else if (last && last.type === LIST_ITEM) {
+         insert(node, last, tight);
+     } else if (last && last.type === LIST) {
+         node.depth--;
+
+         insert(node, last);
+     } else if (parent.type === LIST) {
+         item = listItem();
+
+         insert(node, item);
+
+         children.push(item);
+     } else {
+         item = list();
+         node.depth--;
+
+         insert(node, item);
+
+         children.push(item);
+     }
+
+     /*
+      * Properly style list-items with new lines.
+      */
+
+     if (parent.type === LIST_ITEM) {
+         parent.loose = tight ? false : children.length > 1;
+     } else {
+         if (tight) {
+             isLoose = false;
+         } else {
+             index = -1;
+
+             while (++index < length) {
+                 if (children[index].loose) {
+                     isLoose = true;
+
+                     break;
+                 }
+             }
+         }
+
+         index = -1;
+
+         while (++index < length) {
+             children[index].loose = isLoose;
+         }
+     }
+ }

lib/is-closing-heading.js

@@ -0,0 +1,24 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+/* Expose. */
+module.exports = isClosingHeading;
+
+/* Constants. */
+var HEADING = 'heading';
+
+/**
+ * Check if `node` is the next heading.
+ *
+ * @param {Node} node - Node to check.
+ * @param {number} depth - Depth of opening heading.
+ * @return {boolean} - Whether znode is a closing heading.
+ */
+function isClosingHeading(node, depth) {
+    return depth && node && node.type === HEADING && node.depth <= depth;
+}

lib/is-opening-heading.js

@@ -0,0 +1,29 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+/* Expose. */
+module.exports = isOpeningHeading;
+
+/* Dependencies */
+var toString = require('mdast-util-to-string');
+
+/* Constants. */
+var HEADING = 'heading';
+
+/**
+ * Check if `node` is the main heading.
+ *
+ * @param {Node} node - Node to check.
+ * @param {number} depth - Depth to check.
+ * @param {RegExp} expression - Expression to check.
+ * @return {boolean} - Whether `node` is a main heading.
+ */
+function isOpeningHeading(node, depth, expression) {
+    return depth === null && node && node.type === HEADING &&
+        expression.test(toString(node));
+}

lib/list-item.js

@@ -0,0 +1,26 @@
+/**
+ * @author Titus Wormer
+ * @copyright 2015 Titus Wormer
+ * @license MIT
+ * @module mdast:toc
+ * @fileoverview Generate a Table of Contents (TOC) from a given Markdown file.
+ */
+
+ /* Expose. */
+ module.exports = listItem;
+
+ /* Constants */
+ var LIST_ITEM = 'listItem';
+
+ /**
+  * Create a list item.
+  *
+  * @return {Object} - List-item node.
+  */
+ function listItem() {
+     return {
+         type: LIST_ITEM,
+         loose: false,
+         children: []
+     };
+ }