expose map and index in result

Author: BarryThePenguin

.travis.yml

@@ -20,8 +20,8 @@ deploy:
     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
+      - mdast-util-toc.js
+      - mdast-util-toc.min.js
     skip_cleanup: true
     on:
       tags: true

README.md

@@ -34,8 +34,10 @@ var input = remark().parse([
     ''
 ].join('\n'));
 
-toc(input);
-// [ { type: 'list', ordered: false, children: [ { ... } ] } ]
+toc(input));
+
+// { map: [ { type: 'list', ordered: false, children: [{...}] } ],
+//   index: -1 }
 ```
 
 ## API

example.js

@@ -0,0 +1,18 @@
+// Dependencies:
+var remark = require('remark');
+var toc = require('./index.js');
+
+// Transform:
+var input = remark().parse([
+    '# Alpha',
+    '',
+    '## Bravo',
+    '',
+    '### Charlie',
+    '',
+    '## Delta',
+    ''
+].join('\n'));
+
+// Yields:
+console.log('markdown', toc(input));

lib/index.js

@@ -10,6 +10,8 @@
 module.exports = attacher;
 
 /* Dependencies */
+var remark = require('remark');
+var slug = require('remark-slug');
 var toExpression = require('./to-expression');
 var search = require('./search');
 var contents = require('./contents');
@@ -27,11 +29,16 @@ function attacher(node, options) {
     var depth = settings.maxDepth || 6;
     var tight = settings.tight;
 
-    var result = search(node, heading, depth);
+    var processor = remark().use(slug);
+    var tree = processor.run(node);
+    var result = search(tree, heading, depth);
 
     if (result.index === null || !result.map.length) {
-        return [];
+        return result;
     }
 
-    return [contents(result.map, tight)];
+    return {
+        map: [contents(result.map, tight)],
+        index: result.index
+    };
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdast-util-toc",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Generate a Table of Contents (TOC) from a given Markdown file",
   "main": "index.js",
   "files": [

test/index.js

@@ -3,7 +3,6 @@ var test = require('tape');
 var fs = require('fs');
 var path = require('path');
 var remark = require('remark');
-var slug = require('remark-slug');
 var toc = require('..');
 
 var read = fs.readFileSync;
@@ -37,10 +36,9 @@ test('Fixtures', function (t) {
         var result;
 
         config = exists(config) ? JSON.parse(read(config, 'utf-8')) : {};
-        slug()(input);
         result = compiler.compile({
             type: 'root',
-            children: toc(input, config)
+            children: toc(input, config).map
         });
 
         t.is(result, output, 'should work on `' + fixture + '`');